Edge Edge Provision

Edge Edge Provision

Provisions an Edge before activation.

Privileges required:

CREATE EDGE

Request
URI
POST
https://{api_host}/portal/rest/edge/edgeProvision
COPY
Request Body

Show optional properties

{
    "configurationId": 0,
    "modelNumber": "string"
}
{
    "enterpriseId": 0,
    "configurationId": 0,
    "name": "string",
    "serialNumber": "string",
    "modelNumber": "string",
    "description": "string",
    "site": {
        "id": 0,
        "created": "string",
        "name": "string",
        "contactName": "string",
        "contactPhone": "string",
        "contactMobile": "string",
        "contactEmail": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "lat": "number",
        "lon": "number",
        "timezone": "string",
        "locale": "string",
        "shippingSameAsLocation": 0,
        "shippingContactName": "string",
        "shippingAddress": "string",
        "shippingAddress2": "string",
        "shippingCity": "string",
        "shippingState": "string",
        "shippingCountry": "string",
        "shippingPostalCode": "string",
        "modified": "string"
    },
    "haEnabled": false,
    "generateCertificate": false,
    "subjectCN": "string",
    "subjectO": "string",
    "subjectOU": "string",
    "challengePassword": "string",
    "privateKeyPassword": "string",
    "edgeLicenseId": 0,
    "customInfo": "string",
    "analyticsMode": "string"
}
integer
enterpriseId
Optional

enterpriseId

integer
configurationId
Required

configurationId

string
name
Optional

name

string
serialNumber
Optional

serialNumber

string
modelNumber
Required

modelNumber

Possible values are : edge500, edge5X0, edge510, edge510lte, edge6X0, edge840, edge1000, edge1000qat, edge3X00, edge3X10, virtual,
string
description
Optional

description

site
Optional

site

boolean
haEnabled
Optional

haEnabled

boolean
generateCertificate
Optional

generateCertificate

string
subjectCN
Optional

subjectCN

string
subjectO
Optional

subjectO

string
subjectOU
Optional

subjectOU

string
challengePassword
Optional

challengePassword

string
privateKeyPassword
Optional

privateKeyPassword

integer
edgeLicenseId
Optional

edgeLicenseId

string
customInfo
Optional

customInfo

string
analyticsMode
Optional

analyticsMode

Possible values are : SDWAN_ONLY, SDWAN_WAN_ANALYTICS, SDWAN_ANALYTICS, ANALYTICS_ONLY,
Responses
200

Request was successfully processed

Returns edge_edge_provision_result of type(s) application/json
"edge_edge_provision_result Object"
integer
id
Required

id

string
activationKey
Required

activationKey

object
generatedCertificate
Optional

generatedCertificate


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 '{"configurationId:"integer","modelNumber:"string"}' https://{api_host}/portal/rest/edge/edgeProvision