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,
    "ipAddress": "string",
    "gatewayPoolId": 0,
    "dnsName": "string",
    "name": "string",
    "description": "string",
    "isLoadBalanced": false,
    "privateIpAddress": "string",
    "roles": [
        {
            "gatewayRole": "string",
            "required": false
        }
    ],
    "site": "site Object"
}
integer
networkId
Required

networkId

string
ipAddress
Required

ipAddress

integer
gatewayPoolId
Optional

gatewayPoolId

string
dnsName
Optional

dnsName

string
name
Optional

name

string
description
Optional

description

boolean
isLoadBalanced
Optional

isLoadBalanced

string
privateIpAddress
Optional

privateIpAddress

gateway_roles_object
roles
Optional

roles

site
site
Optional

site

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 Update Gateway Attributes