Gateway Gateway Provision

Gateway Gateway Provision

Provisions a gateway into the specified operator network.

Privileges required:

CREATE GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/gateway/gatewayProvision
COPY
Request Body

Show optional properties

{
    "networkId": 0,
    "ipAddress": "string"
}
{
    "networkId": 0,
    "gatewayPoolId": 0,
    "ipAddress": "string",
    "ipV6Address": "string",
    "dnsName": "string",
    "name": "string",
    "description": "string",
    "isLoadBalanced": false,
    "privateIpAddress": "string",
    "gatewayState": "string",
    "activationKey": "string",
    "activationState": "string",
    "endpointPkiMode": "string",
    "serviceState": "string",
    "bastionState": "string",
    "roles": [
        {
            "gatewayRole": "string",
            "required": false
        }
    ],
    "site": "site Object",
    "enterpriseProxyId": 0,
    "logicalId": "string",
    "deviceId": "string"
}
integer
networkId
Required

networkId

integer
gatewayPoolId
Optional

gatewayPoolId

string
ipAddress
Required

ipAddress

string
ipV6Address
Optional

ipV6Address

string
dnsName
Optional

dnsName

string
name
Optional

name

string
description
Optional

description

boolean
isLoadBalanced
Optional

isLoadBalanced

string
privateIpAddress
Optional

privateIpAddress

string
gatewayState
Optional

gatewayState

string
activationKey
Optional

activationKey

string
activationState
Optional

activationState

string
endpointPkiMode
Optional

endpointPkiMode

Possible values are : CERTIFICATE_DISABLED, CERTIFICATE_OPTIONAL, CERTIFICATE_REQUIRED,
string
serviceState
Optional

serviceState

Possible values are : IN_SERVICE, OUT_OF_SERVICE, PENDING_SERVICE, QUIESCED,
string
bastionState
Optional

bastionState

Possible values are : UNCONFIGURED, STAGE_REQUESTED, UNSTAGE_REQUESTED, STAGED, UNSTAGED,
gateway_roles_object
roles
Optional

roles

site
site
Optional

site

integer
enterpriseProxyId
Optional

enterpriseProxyId

string
logicalId
Optional

logicalId

string
deviceId
Optional

deviceId

Responses
200

Request was successfully processed

Returns gateway_gateway_provision_result of type(s) application/json 
"gateway_gateway_provision_result Object"
string
activationKey
Required

activationKey

integer
id
Required

id

string
logicalId
Required

logicalId


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"networkId:"integer","ipAddress:"string"}' https://{api_host}/portal/rest/gateway/gatewayProvision
On This Page
Gateway Operations
POST
Gateway Delete Gateway
POST
Gateway Gateway Provision
POST
Gateway Get Gateway Edge Assignments
POST
Gateway Set Bastion State
POST
Gateway Set Gateway Enterprise Proxy
POST
Gateway Update Gateway Attributes
POST
Gateway Property Delete Replacement Gateway Property
POST
Gateway Property Get Gateway Properties
POST
Network Set Replacement Gateway
POST
Migration Verify Nsd Tunnels
POST
Network Get Eligible Replacement Gateways
POST
Gateway Get Gateway Csr
POST
Gateway Get Gateway Pending Csrs
POST
Gateway Insert Gateway Certificate