Changed1
[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform

Update Edge

Description

Update an Edge

Request

Request

URL

URL


patch
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


string
edgeLogicalId Required

The logicalId GUID for the target edge


Query Parameters

Query Parameters

string
include Optional

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

Request Body

PatchSchema of mimetype application/json Optional

Update Edge request schema

This request body class requires at least one of the following: ReplacePatchOperation, RemovePatchOperation, AddPatchOperation, MovePatchOperation
Response

Response

Response Body

Response Body

200 OK

Returns EdgeResource of type application/json

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",
	"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",
	"systemUpSince": "string"
}
string
_href Optional

string
activationKey Optional

string as date-time
activationKeyExpires Optional

string
activationState Optional

Possible values are: UNASSIGNEDPENDINGACTIVATEDREACTIVATION_PENDING


string as date-time
activationTime Optional

boolean
alertsEnabled Optional

string
bastionState Optional

Possible values are: UNCONFIGUREDSTAGE_REQUESTEDUNSTAGE_REQUESTEDSTAGEDUNSTAGEDPROMOTION_REQUESTEDPROMOTION_PENDINGPROMOTED


string
buildNumber Optional

string as date-time
created Optional

string
customInfo Optional

string
description Optional

string
deviceFamily Optional

string
deviceId Optional

string
dnsName Optional

string
edgeState Optional

Possible values are: NEVER_ACTIVATEDDEGRADEDOFFLINEDISABLEDEXPIREDCONNECTED


string as date-time
edgeStateTime Optional

string
endpointPkiMode Optional

Possible values are: CERTIFICATE_DISABLEDCERTIFICATE_OPTIONALCERTIFICATE_REQUIRED


enterprise Changed Optional

string
factoryBuildNumber Optional

string
factorySoftwareVersion Optional

string as date-time
haLastContact Optional

string
haPreviousState Optional

Possible values are: UNCONFIGUREDPENDING_INITPENDING_CONFIRMATIONPENDING_CONFIRMEDPENDING_DISSOCIATIONREADYFAILED


string
haSerialNumber Optional

string
haState Optional

Possible values are: UNCONFIGUREDPENDING_INITPENDING_CONFIRMATIONPENDING_CONFIRMEDPENDING_DISSOCIATIONREADYFAILED


boolean
isLive Optional

string as date-time
lastContact Optional

array of BaseApiResource
links Changed Optional

string
logicalId Optional

string
lteRegion Optional

string
modelNumber Optional

string
modemBuildNumber Optional

string
modemFirmwareVersion Optional

string as date-time
modified Optional

string
name Optional

boolean
operatorAlertsEnabled Optional

string
platformBuildNumber Optional

string
platformFirmwareVersion Optional

string
selfMacAddress Optional

string
serialNumber Optional

string
serviceState Optional

Possible values are: IN_SERVICEOUT_OF_SERVICEPENDING_SERVICE


string as date-time
serviceUpSince Optional

site Changed Optional

string as date-time
softwareUpdated Optional

string
softwareVersion Optional

string as date-time
systemUpSince Optional
Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


415

UnsupportedMediaTypeError


422

DataValidationError


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{}' https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}


[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform
What's changed in latest?
CHANGED (1)
Changed Data Structures

Feedback

Was this page helpful?