Skip to main content
Loading...

API docs by

Create Service Token

Request

Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services.

Security
BearerAuth
Query
dryRunboolean

option to verify that API calls will succeed

Default:false
Bodyapplication/jsonrequired
typestring(ServiceTokenType)

Type of Service Token

Enum:"VC_TOKEN""EPL_TOKEN"
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

Payload
{
  "type": "VC_TOKEN",
  "name": "Az_Aside_Dot1Q_Pri_SV",
  "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  "expirationDateTime": "2021-03-18T06:43:49.980Z",
  "connection": {
    "type": "EVPL_VC",
    "allowRemoteConnection": false,
    "bandwidthLimit": 50,
    "allowCustomBandwidth": false,
    "aSide": { … }
  },
  "notifications": [
    { … }
  ]
}

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
{
  "type": "VC_TOKEN",
  "name": "Aside_Dot1Q_Service_Token",
  "description": "Az_Aside_Dot1Q_DryRun_Description",
  "expirationDateTime": "2024-12-18T06:43:49.980Z",
  "connection": {
    "type": "EVPL_VC",
    "allowRemoteConnection": false,
    "bandwidthLimit": 50,
    "allowCustomBandwidth": false,
    "aSide": { … }
  },
  "notifications": [
    { … }
  ]
}
Was this page helpful?