Network Edge APIs | Equinix Product Documentation

Update Virtual Device By Uuid

Request

Updates certain fields of a virtual device. You can only update the name, term length, status, and notification list of a virtual device.

Security

BearerAuth

Path

uuidstringrequired

Unique Id of a Virtual Device

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8

Bodyapplication/jsonrequired

coreinteger

Use this field to resize your device. When you call this API for device resizing, you cannot change other fields simultaneously.

Example:8

notificationsArray of strings

Example:

[
  "test1@example.com"
]

termLengthstring

Term length in months.

Example:"1, 12, 24, 36"

termLengthEffectiveImmediateboolean

By default, this field is true. Set it to false if you want to change the term length at the end of the current term. You cannot downgrade the term length before the end of your current term.

Example:false

virtualDeviceNamestring

Virtual device name. This should be a minimum of 3 and a maximum of 50 characters.

Example:"RCiscoSTROY"

clusterNamestring

Cluster name. This should be a minimum of 3 and a maximum of 50 characters.

Example:"myCluster0123"

statusstring

Status of the device. Use this field to update the license status of a device.

Enum:"PROVISIONED""PROVISIONING""DEPROVISIONED""DEPROVISIONING""FAILED"

Example:"PROVISIONED"

autoRenewalOptOutboolean

By default, the autoRenewalOptOut field is false. Set it to true if you do not want to automatically renew your terms. Your device will move to a monthly cycle at the expiration of the current terms.

Example:true

vendorConfigobject

vendor config properties

Payload

{
  "core": 8,
  "notifications": [
    "test1@example.com"
  ],
  "termLength": "1, 12, 24, 36",
  "termLengthEffectiveImmediate": false,
  "virtualDeviceName": "RCiscoSTROY",
  "clusterName": "myCluster0123",
  "status": "PROVISIONED",
  "autoRenewalOptOut": true,
  "vendorConfig": {
    "disablePassword": true
  }
}

Responses

The request was successfully processed.

Response

No content