Get All Service Tokens - Parameters Mapping
This API returns a data set with service tokens.
v3 request
curl -X
GET 'https://api.equinix.com/ecx/v3/serviceTokens'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
v4 request
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
| v3 API request | v4 API request | Description |
| GET /ecx/v3/serviceTokens | GET /fabric/v4/serviceTokens | Request: - Response: v3 and v4 service token objects have different structure and parameters' names. The v4 service token object introduces a nested structure while the v3 service token configuration is based on key-value pairs defined in the metadata array. |
Response
v3 request
{
"isFirstPage": true,
"totalCount": 467,
"isLastPage": false,
"pageSize": 20,
"content": [
{
"id": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1-AM-1",
"status": "INACTIVE",
"resource": {
"type": "CX_PORT",
"uuid": "a867f685-421b-21b7-6de0-320a5c00abdd",
"metadata": [
{
"key": "speedLimit",
"value": 100
},
{
"key": "encapsulation",
"value": "Qinq"
},
{
"key": "priority",
"value": "Primary"
},
{
"key": "metroCode",
"value": "AM"
},
{
"key": "cvpId",
"value": 48088
},
{
"key": "name",
"value": "verizon-CX-AM3-NL-QinQ-STD-100G-PRI-JN-124"
},
{
"key": "innerTag",
"value": 102
},
{
"key": "outerTag",
"value": 101
},
{
"key": "subInterface",
"value": 101
},
{
"key": "bandwidth",
"value": 100000000000
},
{
"key": "allowRemoteConnections",
"value": true
}
]
},
"notify": {
"emails": [
"end-customer@xxx.com"
]
},
"preferences": {
"expiry": 10
},
"custOrgId": 85332
}
]
}
v4 request
{
"pagination": {
"offset": 0,
"limit": 10,
"total": 3600,
"next": "http://api.equinix.com/fabric/v4/serviceTokens?offset=10&limit=10"
},
"data": [
{
"href": "http://api.equinix.com/fabric/v4/serviceTokens/8a7c8b84-4030-4047-a5c6-f2a2e45e6f1c",
"type": "VC_TOKEN",
"uuid": "8a7c8b84-4030-4047-a5c6-f2a2e45e6f1c",
"state": "ACTIVE",
"expiry": 29,
"expirationDateTime": "2022-04-13T00:00:00Z",
"connection": {
"type": "EVPL_VC",
"allowRemoteConnection": true,
"bandwidthLimit": 10000,
"aSide": {
"accessPointSelectors": [
{
"type": "COLO",
"port": {
"uuid": "c791f8cb-5a42-a420-8ce0-306a5c00a4ee"
},
"linkProtocol": {
"type": "QINQ",
"vlanCTag": 222,
"vlanSTag": 223
}
}
]
}
},
"notifications": [
{
"type": "NOTIFICATION",
"emails": [
"fusiontestBuyer@equinix.com",
"fusiontestbuyer@equinix.com"
]
}
],
"account": {
"orgId": "91997"
},
"changeLog": {
"createdBy": "901587",
"createdDateTime": "2022-03-14T21:20:49.597Z",
"updatedDateTime": "2022-03-14T21:23:48.941Z"
}
}
]
}
| v3 parameter | v4 parameter | Example | Description |
| isLastPage | - | true | Indicates the first page of results set. |
| isFirstPage | - | false | Indicates the last page of results set. |
| pageNumber | - | 222 | Results set page number. |
| - | pagination | - | New container object for pagination parameters. |
| - | pagination.offset | 200 | New parameter specifying the results page offset. |
| pageSize | pagination.limit | 100 | Number of items returned on a single page. |
| totalCount | pagination.total | 1000 | Total number of objects in the data set. |
| - | pagination.next | http://api.equinix.com/fabric/v4/serviceTokens?offset=10&limit=10 | New parameter specyfing the next results page url. |
| - | pagination.previous | http://api.equinix.com/fabric/v4/serviceTokens?offset=10&limit=10 | New parameter specyfing the previous results page url. |
| content | data | - | An array of service token objects. |
| - | href | http://api.equinix.com/fabric/v4/metros/AM | New parameter specifying the absolute URL that returns details of the given asset. |
| - | type | VC_TOKEN | New parameter specifying token type. |
| id | uuid | 8a7c8b84-4030-4047-a5c6-f2a2e45e6f1c | Equinix-assigned service token identifier. |
| status | state | ACTIVE | Lifecycle stage of the service token. ACTIVE - A service token has been used to establish a connection. INACTIVE - A valid service token that hasn't been used yet. EXPIRED - A service token has reached its expiration date. DELETED - The connection established through a given service token has been deleted or the service token itself has been deleted. |
| preferences.expiry | expiry | 29 | The number of days when the service token remains valid. |
| resource.type | - | CX_PORT | Fabric port type associated with the service token. |
| - | expirationDateTime | 2022-04-13T00:00:00Z | Expiration date and time of the service token in the IETF ISO 8601 extended date/time format. |
| - | connection | - | Container object for connection configuration. |
| - | connection.type | EVPL_VC | New parameter, connection type. EVPL_VC - Ethernet virtual private line‒virtual connection |
| resource.metadata[10].key = allowRemoteConnections | connection.allowRemoteConnection | true | Authorization to establish connections from a different metro. |
| resource.metadata[0].key = speedLimit | connection.bandwidthLimit | 1000 | Connection bandwidth limit. |
| - | connection.supportedBandwidths | [50,100] | Supported connection bandwidths. |
| - | connection.aSide/zSide | - | Container object for A-side/Z-side configuration. |
| - | connection.aSide/zSide.accessPointSelectors | - | Available access points definitions. |
| - | connection.aSide/zSide.accessPointSelectors[0].type | COLO | Access point type. |
| - | connection.aSide/zSide.accessPointSelectors[0].port | - | Port associated with the given access point. |
| resource.uuid | connection.aSide/zSide.accessPointSelectors[0].port.uuid | a867f685-421b-21b7-6de0-320a5c00abdd | Equinix-assigned port identifier. |
| connection.aSide/zSide.accessPointSelectors[0].linkProtocol | - | New container object for link protocol configuration. | |
| resource.metadata[1].key = encapsulation | connection.aSide/zSide.accessPointSelectors[0].linkProtocol.type | QINQ DOT1Q | Link protocol encapsulation standard. |
| resource.metadata[6].key = innerTag | connection.aSide/zSide.accessPointSelectors[0].linkProtocol.vlanCTag | 102 | QINQ protocol, inner (customer) VLAN frame tag used to identify packets as they traverse trunk lines. |
| resource.metadata[7].key = outerTag | connection.aSide/zSide.accessPointSelectors[0].linkProtocol.vlanSTag | 101 | QINQ protocol, outer (service) VLAN frame tag used to identify packets as they traverse trunk lines. |
| - | notifications | - | New container object for email notifications configuration. |
| - | notifications[0].type | NOTIFICATION | New parameter enabling differentiation of notifications. |
| - | notifications[0].emails | ["falconstestBuyer@equinix.com"] | List of up to 12 recipients. |
| - | account | - | New container object for billing account information. |
| custOrgId | account.orgId | 91996 | Equinix-assigned organization identifier. |
| - | changeLog | - | New container object for changelog information. |
| createdBy | changeLog.createdBy | testBuyerStandardUserAllPerm | Identity of the asset creator. |
| createdDate | changeLog.createdDateTime | 2022-02-09T05:12:33.078Z | Connection creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 |
| lastUpdatedDate | changeLog.updatedDateTime | 2022-02-09T05:12:33.078Z | Connection update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 |
| resource.metadata[2].key = priority | - | Primary | Relative priority in a redundancy group. |
| resource.metadata[3].key = metroCode | - | AM | Metropolitan area identifier. |
| resource.metadata[4].key = cvpId | - | 48088 | Virtual port identifier. |
| resource.metadata[5].key = name | - | CX-AM3-NL-QinQ-STD | Service token name. |
| resource.metadata[8].key = subInterface | - | 101 | Subeinterface identifier. |
| resource.metadata[9].key = bandwidth | - | 100000000000 | Port bandwidth. |