Create Edge
DescriptionProvision a new Edge, or invoke an action on a set of existing Edges.
Request
URLURL
Path Parameters
Path Parameters
The logicalId GUID for the target enterprise
Query Parameters
Query Parameters
An action to be applied to the list of specified edges.
Possible values are: blinkLeds , reboot , hardReset , shutdown , restartService
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Request Body
Response
201 Created Response Body>Response Body
201 Created
Request successfully processed
{
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "UNASSIGNED",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "UNCONFIGURED",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "NEVER_ACTIVATED",
"edgeStateTime": "string",
"endpointPkiMode": "CERTIFICATE_DISABLED",
"enterprise": {
"_href": "string",
"accountNumber": "string",
"alertsEnabled": false,
"bastionState": "UNCONFIGURED",
"city": "string",
"contactEmail": "string",
"contactMobile": "string",
"contactName": "string",
"contactPhone": "string",
"country": "string",
"created": "string",
"description": "string",
"domain": "string",
"endpointPkiMode": "CERTIFICATE_DISABLED",
"gatewayPool": {
"_href": "string"
},
"lat": 0,
"locale": "string",
"logicalId": "string",
"lon": 0,
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"postalCode": "string",
"prefix": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"timezone": "string"
},
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"haLastContact": "string",
"haMode": "string",
"haPreviousState": "UNCONFIGURED",
"haSerialNumber": "string",
"haState": "UNCONFIGURED",
"isLive": false,
"lastContact": "string",
"links": [
{
"_href": "string"
}
],
"logicalId": "string",
"lteRegion": "string",
"modelNumber": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "IN_SERVICE",
"serviceUpSince": "string",
"site": {
"_href": "string",
"city": "string",
"contactEmail": "string",
"contactMobile": "string",
"contactName": "string",
"contactPhone": "string",
"country": "string",
"created": "string",
"lat": 0,
"locale": "string",
"lon": 0,
"modified": "string",
"name": "string",
"postalCode": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingContactName": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"shippingSameAsLocation": false,
"shippingState": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"timezone": "string"
},
"softwareUpdated": "string",
"softwareVersion": "string",
"standbyBuildNumber": "string",
"standbyDeviceId": "string",
"standbyFactoryBuildNumber": "string",
"standbyFactorySoftwareVersion": "string",
"standbyModelNumber": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbySystemUpSince": "string",
"systemUpSince": "string"
}
Possible values are: UNASSIGNED , PENDING , ACTIVATED , REACTIVATION_PENDING
Possible values are: UNCONFIGURED , STAGE_REQUESTED , UNSTAGE_REQUESTED , STAGED , UNSTAGED , PROMOTION_REQUESTED , PROMOTION_PENDING , PROMOTED
Possible values are: NEVER_ACTIVATED , DEGRADED , OFFLINE , DISABLED , EXPIRED , CONNECTED
Possible values are: CERTIFICATE_DISABLED , CERTIFICATE_OPTIONAL , CERTIFICATE_REQUIRED
Possible values are: UNCONFIGURED , PENDING_INIT , PENDING_CONFIRMATION , PENDING_CONFIRMED , PENDING_DISSOCIATION , READY , FAILED
Possible values are: UNCONFIGURED , PENDING_INIT , PENDING_CONFIRMATION , PENDING_CONFIRMED , PENDING_DISSOCIATION , READY , FAILED
This field is deprecated. Please use “edgeState” to get updated edge status calculated by the Orchestrator.
Possible values are: IN_SERVICE , OUT_OF_SERVICE , PENDING_SERVICE
202 Accepted Response Body>
Response Body
202 Accepted
Asynchronous action enqueued
{
"operationId": "string",
"status": "ACCEPTED"
}
Possible values are: ACCEPTED , DONE , ERROR
Errors
ValidationError
Unauthorized
Resource not found
UnsupportedMediaTypeError
DataValidationError
Rate Limit Exceeded
Internal server error
