Equinix Fabric API v4 | Equinix Product Documentation

Update Token By ID

Request

This API provides capability to update user's Service Token

Security

BearerAuth

Path

serviceTokenIdstring, (uuid)required

Service Token UUID

Query

dryRunboolean

option to verify that API calls will succeed

Default:false

Bodyapplication/json-patch+jsonrequired

Array [

opstringrequired

Handy shortcut for operation name

Enum:"replace""add""remove"

pathstringrequired

path inside document leading to updated parameter

Example:"/expirationDateTime"

valueanyrequired

new value for updated parameter

]

Payload

[
  {
    "op": "replace",
    "path": "/expirationDateTime",
    "value": "2023-01-20T18:50:34.696Z"
  }
]

Responses

Successful operation

Bodyapplication/json

typestring(ServiceTokenType)

Type of Service Token

Enum:"VC_TOKEN""EPL_TOKEN"

hrefstring, (uri)read-only

An absolute URL that is the subject of the link's context.

uuidstring, (uuid)

Equinix-assigned service token identifier

namestring

Customer-provided service token name

descriptionstring

Customer-provided service token description

expirationDateTimestring, (date-time)

Expiration date and time of the service token.

Example:"2020-11-06T07:00:00Z"

connectionobject(ServiceTokenConnection)

Service Token Connection Type Information

statestring(ServiceTokenState)

Service token state

Enum:"ACTIVE""INACTIVE""EXPIRED""DELETED"

notificationsArray of objects(SimplifiedNotification)

Service token related notifications

accountobject(SimplifiedAccount)

AM-CRH customers can provide Account number

Example:272010

changelogobject(Changelog)

Change log

projectobject(Project)

Project is optional for AM-CRH customers. If not provided, a default project will be assigned.

expiryintegerdeprecated

issuerSidestringdeprecated

information about token side

Response

{
  "href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  "type": "VC_TOKEN",
  "uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  "name": "Az_Aside_Dot1Q_Pri_SV",
  "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  "state": "INACTIVE",
  "expirationDateTime": "2021-03-18T06:43:49.980Z",
  "connection": {
    "type": "EVPL_VC",
    "allowRemoteConnection": false,
    "bandwidthLimit": 50,
    "allowCustomBandwidth": false,
    "aSide": { … }
  },
  "notifications": [
    { … }
  ],
  "account": {
    "orgId": 111437
  },
  "changelog": {
    "createdBy": "843577",
    "createdDateTime": "2021-03-18T06:43:49.980Z",
    "updatedBy": "843577",
    "updatedDateTime": "2021-03-18T06:44:14.206Z"
  },
  "project": {
    "projectId": "995072000433550"
  }
}