Service Tokens

Create Service Token

POST /fabric/v4/serviceTokens
Method POST
URL or Endpoint /fabric/v4/serviceTokens
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, expirationDateTime, connection, notifications, project

This API request creates a service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample curl request - create A-side service token

Create A-side service tokens and share them with your customers to allow them to use your A-side port to establish connections to any destination available on the Equinix Fabric.

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "VC_TOKEN",
    "connection": {
        "type": "EVPL_VC",
        "bandwidthLimit": 1000,
        "allowRemoteConnection": true,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "hideAssetInfo": false,
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1234,
                        "vlanCTag": 2345
                    }
                }
            ]
        }
    },
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com"
            ]
        }
    ],
    "project": {
        "projectId": "377533000114703"
    }
}'

Sample curl request - create Z-side service token

Create a Z-side service token and share them with other Equinix Fabric customers to allow them to connect to your services or ports.

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "VC_TOKEN",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "allowCustombandwidth": false,
        "supportedBandwidths": [
            50,
            200,
            500,
            1000
        ],
        "zSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "hideAssetInfo": false,
                    "port": {
                        "uuid": "b840a1db-5413-413f-97e0-328a5c00a874"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 1399,
                        "vlanSTag": 1388
                    }
                }
            ]
        }
    },
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com"
            ]
        }
    ],
    "project": {
        "projectId": "377533000114703"
    }
}'

Body parameters

Parameter
Description
type string
REQUIRED
 Type of service token.
Applicable values:
  • VC_TOKEN - Virtual connection token
connection object
REQUIRED
 Connection specification.
type string
REQUIRED
 Connection type.
Applicable values:
  • EVPL_VC - Ethernet virtual private line connection.
bandwidthLimit integer
CONDITIONAL
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
CONDITIONAL
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
allowRemoteConnection boolean
REQUIRED
 Authorization to establish connection from a different metro.
Example: true
aSide object
CONDITIONAL
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
REQUIRED
 List of available connection endpoints.
type string
REQUIRED
 Connection endpoint type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
OPTIONAL
 Hide endpoint details.
Default: false
port object
CONDITIONAL
 Required for Colo endpoints.
uuid string
REQUIRED
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
REQUIRED
 Link protocol configuration.
type string
CONDITIONAL
 Link protocol type.
Applicable values:
  • DOT1Q
  • QINQ
  • VXLAN
vlanTag integer
CONDITIONAL
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Applicable values: 2-4094
vlanSTag integer
CONDITIONAL
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Applicable values: 2-4094
vlanCTag integer
CONDITIONAL
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Applicable values: 2-4094
vni integer
CONDITIONAL
Virtual network identifier. Applicable to VXLAN link protocol.
Applicable values: 4097-16777215
zSide object
CONDITIONAL
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
REQUIRED
 List of available connection endpoints.
type string
REQUIRED
 Connection endpoint type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
  • VD
  • NETWORK
hideAssetInfo boolean
OPTIONAL
 Hide endpoint details.
Default: false
port object
CONDITIONAL
 Endpoint port parameters. Required for Colo endpoints.
uuid string
REQUIRED
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
REQUIRED
 Link protocol configuration.
type string
REQUIRED
 Link protocol type.
Applicable values:
  • DOT1Q
  • QINQ
  • VXLAN
vlanTag integer
CONDITIONAL
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Applicable values: 2-4094
vlanSTag integer
CONDITIONAL
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Applicable values: 2-4094
vlanCTag integer
CONDITIONAL
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Applicable values: 2-4094
vni integer
CONDITIONAL
Virtual network identifier. Applicable to VXLAN link protocol.
Applicable values: 4097-16777215
virtualDevice object
CONDITIONAL
 Virtual Device details. Required for VD endpoints.
type string
REQUIRED
 Type of Virtual Device.
Example: EDGE
uuid string
REQUIRED
 Equinix-assigned Virtual Device identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
interface object
CONDITIONAL

Interface details. Required for Virtual Device service tokens.
type string
REQUIRED
 Type of Interface.
Example:NETWORK
id integer
OPTIONAL
 Id of Interface
Example:7
network object
CONDITIONAL
 Network details. Required for NETWORK endpoints.
type string
REQUIRED
 Type of Network.
Example: EVPLAN
uuid string
REQUIRED
 Equinix-assigned EVPLAN identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
expirationDateTime string
REQUIRED
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Applicable values: The maximum service token validity is 90 days.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
REQUIRED
 Service token notification settings.
type string
REQUIRED
 Notification messages category.
Applicable values:
  • NOTIFICATION
emails array[string]
REQUIRED
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
project object
OPTIONAL
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
OPTIONAL
 Customer project identifier.
Example: 377533000114703

Sample response - create A-side service token

Copy 
{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    },
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type string
 Type of service token.
Example:
  • VC_TOKEN - Virtual connection token
uuid string
 Equinix-assigned service token identifier.
Example: 213ee923-4099-45de-8e97-8e6021ed2761
state string
 Lifecycle stage of a service token.
Example: INACTIVE
connection object
 Connection specification.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection boolean
 Authorization to establish connection from a different metro.
Example: true
bandwidthLimit integer
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
aSide object
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: DOT1Q
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 2345
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
zSide object
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • NETWORK
  • VD
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Endpoint port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: QINQ
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 123
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
network object
 Network endpoint details.
href string
 An absolute URL that returns the specified asset.
Example: http://api.equinix.com/fabric/v4/networks/7507db0b-b1ad-4db6-87ac-25bac52450b9
uuid string
 Equinix-assigned network identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Network type.
Example: EVPLAN
name string
 Network name.
Example: EVPLAN-TEST-NETWORK
scope string

Scope of the network.
Example:

  • GLOBAL
  • REGIONAL
  • LOCAL
virtualDevice object
 Virtual Device endpoint details.
uuid string
 Unique Id of the Virtual Device.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Virtual Device type.
Example: EDGE
name string
 Virtual Device name.
Example: EDGE-DEVICE-TEST
interface object
 Interface details of the Virtual Device.
uuid string
 Unique Id of the interface.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Interface type.
Example: NETWORK
id string
 Id of the interface.
Example: 10
expirationDateTime string
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
 Service token notification settings.
type string
 Notification messages category.
Example:
  • NOTIFICATION
emails array[string]
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
orgId string
 Customer organization identifier.
Example: 94513
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 377533000114703

Get All Service Tokens

GET /fabric/v4/serviceTokens
Method GET
URL or Endpoint /fabric/v4/serviceTokens
Headers Authorization
Path Parameters Not applicable
Query Parameters offset, limit
Body Parameters Not applicable

This API request retrieves all service tokens associated with the user account. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens..

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/serviceTokens?offset=2&limit=2'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Query parameters

Parameter
Description
offset integer
OPTIONAL
 Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
 Maximum number of items returned per page.
Minimum: 1
Default: 10

Sample response

Copy 
{
    "pagination": {
        "offset": 2,
        "limit": 2,
        "total": 511,
        "next": "/serviceTokens?offset=4&limit=2",
        "previous": "/serviceTokens?offset=0&limit=2"
    },
    "data": [
        {
            "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
            "type": "VC_TOKEN",
            "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
            "state": "INACTIVE",
            "expirationDateTime": "2021-08-14T18:39:13.866Z",
            "connection": {
                "type": "EVPL_VC",
                "allowRemoteConnection": false,
                "supportedBandwidths": [
                    100,
                    10,
                    108
                ],
                "allowCustomBandwidth": false,
                "zSide": {
                    "accessPointSelectors": [
                        {
                            "type": "COLO",
                            "port": {
                                "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
                            },
                            "linkProtocol": {
                                "type": "QINQ",
                                "vlanCTag": 1399,
                                "vlanSTag": 1388
                            }
                        }
                    ]
                }
            },
            "notifications": [
                {
                    "type": "NOTIFICATION",
                    "emails": [
                        "provider@example.com",
                        "Falconsvendor1@equinix.com",
                        "customer@example.com"
                    ]
                }
            ],
            "account": {
                "orgId": "111437"
            },
            "changeLog": {
                "createdBy": "849817",
                "createdDateTime": "2021-07-15T18:39:13.866Z"
            },
            "project": {
                "projectId": "377533000114703"
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
            "type": "VC_TOKEN",
            "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
            "state": "ACTIVE",
            "expirationDateTime": "2021-07-13T19:34:53.954Z",
            "connection": {
                "type": "EVPL_VC",
                "allowRemoteConnection": true,
                "bandwidthLimit": 500,
                "aSide": {
                    "accessPointSelectors": [
                        {
                            "type": "COLO",
                            "port": {
                                "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
    "data": [
    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "type": "VC_TOKEN",
    "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "state": "INACTIVE",
    "expirationDateTime": "2021-08-14T18:39:13.866Z",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": false,
        "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
        "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
        "supportedBandwidths": [
        100,
        10,
        108
        ],
        "allowCustomBandwidth": false,
        "zSide": {
        "accessPointSelectors": [
        {
            "type": "COLO",
            "port": {
            "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
            },
            "linkProtocol": {
            "type": "QINQ",
            "vlanCTag": 1399,
            "vlanSTag": 1388
            }
            }
        ]
        }
    },
    "notifications": [
        {
        "type": "NOTIFICATION",
        "emails": [
            "provider@example.com",
            "Falconsvendor1@equinix.com",
            "customer@example.com"
            ]
        }
        ],
    "account": {
        "orgId": "111437"
        },
    "changeLog": {
        "createdBy": "849817",
        "createdDateTime": "2021-07-15T18:39:13.866Z"
        }
        },

    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
    "type": "VC_TOKEN",
    "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
    "state": "ACTIVE",
    "expirationDateTime": "2021-07-13T19:34:53.954Z",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "uuid": "63dc2010-5006-46b6-9e91-995c47415d5d",
        "href": "http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d5c",
        "bandwidthLimit": 500,
            "aSide": {
                "accessPointSelectors": [
                    {
                    "type": "COLO",
                    "port": {
                        "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 1279
                            }
                        }
                    ]
                }
            },
            "notifications": [
                {
                    "type": "NOTIFICATION",
                    "emails": [
                        "provider@example.com",
                        "customer@example.com"
                    ]
                }
            ],
            "account": {
                "orgId": "111437"
            },
            "changeLog": {
                "createdBy": "849817",
                "createdDateTime": "2021-07-12T19:34:53.954Z",
                "updatedDateTime": "2021-07-12T19:35:57.997Z"
            },
            "project": {
                "projectId": "377533000114703"
            }
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Data set pagination settings.
offset integer
 Index of the first item returned in the response.
Example: 20
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 1
data array[object]
 Array containing returned data set.
href string
 An absolute URL that returns the specified asset.
Example:http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type string
 Type of service token.
Example:
  • VC_TOKEN - Virtual connection token
uuid string
 Equinix-assigned service token identifier.
Example: 213ee923-4099-45de-8e97-8e6021ed2761
state string
 Lifecycle stage of a service token.
Example: INACTIVE
connection object
 Connection specification.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection boolean
 Authorization to establish connection from a different metro.
Example: true
bandwidthLimit integer
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
aSide object
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: DOT1Q
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 2345
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
zSide object
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD
  • NETWORK
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Endpoint port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: QINQ
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 123
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
network object
 Network endpoint details.
href string
 An absolute URL that returns the specified asset.
Example: http://api.equinix.com/fabric/v4/networks/7507db0b-b1ad-4db6-87ac-25bac52450b9
uuid string
 Equinix-assigned network identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Network type.
Example: EVPLAN
scope string

Scope of the network.
Example:

  • GLOBAL
  • REGIONAL
  • LOCAL
virtualDevice object
 Virtual Device endpoint details.
uuid string
 Unique Id of the Virtual Device.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Virtual Device type.
Example: EDGE
name string
 Virtual Device name.
Example: EDGE-DEVICE-TEST
interface object
 Interface details of the Virtual Device.
typestring
 Interface type.
Example: NETWORK
id string
 Id of the interface.
Example: 10
expirationDateTime string
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
 Service token notification settings.
type string
 Notification messages category.
Example:
  • NOTIFICATION
emails array[string]
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
orgId string
 Customer organization identifier.
Example: 94513
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 377533000114703

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.


Get Specified Service Token

GET /fabric/v4/serviceTokens/{uuid}
Method GET
URL or Endpoint /fabric/v4/serviceTokens/{uuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request retrieves a specified service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens..

To obtain an authorization token, see the Getting Access Token section in Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceTokens/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Service token identifier.
Example: c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04

Sample response - A-side service token

Copy 
{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/13c0f286-1190-480c-8a45-b3df00cad9cf",
    "type": "VC_TOKEN",
    "uuid": "13c0f286-1190-480c-8a45-b3df00cad9cf",
    "state": "INACTIVE",
    "expirationDateTime": "2021-08-14T20:40:15.330Z",
    "connection": {
    "type": "EVPL_VC",
    "allowRemoteConnection": false,
    "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
    "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
    "bandwidthLimit": 50,
    "aSide": {
        "accessPointSelectors": [
        {
            "type": "COLO",
            "port": {
            "uuid": "bdd4f4f6-e6f9-6f98-1fe0-36da5c00a3be"
            },
            "linkProtocol": {
            "type": "DOT1Q",
            "vlanTag": 1279
            }
            }
        ]
        }
    },
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type string
 Type of service token.
Example:
  • VC_TOKEN - Virtual connection token
uuid string
 Equinix-assigned service token identifier.
Example: 213ee923-4099-45de-8e97-8e6021ed2761
state string
 Lifecycle stage of a service token.
Example: INACTIVE
connection object
 Connection specification.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection boolean
 Authorization to establish connection from a different metro.
Example: true
bandwidthLimit integer
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
aSide object
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: DOT1Q
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 2345
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
zSide object
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • NETWORK
  • VD
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Endpoint port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: QINQ
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 123
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
network object
 Network endpoint details.
href string
 An absolute URL that returns the specified asset.
Example: http://api.equinix.com/fabric/v4/networks/7507db0b-b1ad-4db6-87ac-25bac52450b9
uuid string
 Equinix-assigned network identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Network type.
Example: EVPLAN
scope string

Scope of the network.
Example:

  • GLOBAL
  • REGIONAL
  • LOCAL
virtualDevice object
 Virtual Device endpoint details.
uuid string
 Unique Id of the Virtual Device.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
typestring
 Virtual Device type.
Example: EDGE
name string
 Virtual Device name.
Example: EDGE-DEVICE-TEST
interface object
 Interface details of the Virtual Device.
typestring
 Interface type.
Example: NETWORK
id string
 Id of the interface.
Example: 10
expirationDateTime string
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
 Service token notification settings.
type string
 Notification messages category.
Example:
  • NOTIFICATION
emails array[string]
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
orgId string
 Customer organization identifier.
Example: 94513
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 377533000114703

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.


Update Service Token

PATCH /fabric/v4/serviceTokens/{uuid}
Method PATCH
URL or Endpoint /fabric/v4/serviceTokens/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters op, path, value

This API request modifies a service token.


Sample curl request - update expiration date

Copy 
curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/expirationDateTime",
        "value": "2023-01-20T18:50:34.696Z"
    }
]'

Sample curl request - update Z-side service token supported connection bandwidths

Copy 
curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/connection/supportedBandwidths",
        "value": [
            50,
            1000
        ]
    }
]'

Sample curl request - update A-side service token maximum bandwidth

Copy 
curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/connection/bandwidthLimit",
        "value": 10
    }
]'

Sample curl request - update notification recipients

Copy 
curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/notifications/emails",
        "value": [
            "test1@equinix.com",
            "test2@equinix.com"
        ]
    }
]'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned service token identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter
Description
op string
REQUIRED
 Update reqest type.
Applicable values:
  • replace
  • add
  • remove
path string
REQUIRED
 Parameter path.
Applicable values:
  • /expirationDateTime
  • /notifications/emails
    • /connection/supportedBandwidths
  • /connection/bandwidthLimit
value string
REQUIRED
 New parameter value.
/connection/expirationDateTime
value string
REQUIRED
 Service token expiration date.
Example: 2023-01-20T18:50:34.696Z
/connection/supportedBandwidths
value array[integer]
REQUIRED
 Z-side service token allowed connection bandwidth.
Example: [200, 500, 1000]
/connection/bandwidthLimit
value integer
REQUIRED
 A-side service token bandwidth limit.
Example: 1000
/notifications/emails
value array[string]
REQUIRED
 Email addresses of up to 12 service token recipients.
Example: ["mike@mspp.com","dwight@dm.com"]

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response - A-side service token

Copy 
{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z",
        "updatedBy": "904885",
        "updatedDateTime": "2022-11-25T10:59:39.560Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type string
 Type of service token.
Example:
  • VC_TOKEN - Virtual connection token
uuid string
 Equinix-assigned service token identifier.
Example: 213ee923-4099-45de-8e97-8e6021ed2761
state string
 Lifecycle stage of a service token.
Example: INACTIVE
connection object
 Connection specification.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection boolean
 Authorization to establish connection from a different metro.
Example: true
bandwidthLimit integer
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
aSide object
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: DOT1Q
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 2345
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
zSide object
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Endpoint port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: QINQ
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 123
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
expirationDateTime string
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
 Service token notification settings.
type string
 Notification messages category.
Example:
  • NOTIFICATION
emails array[string]
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
orgId string
 Customer organization identifier.
Example: 94513
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Identity of the person who updated the asset.
Example: AverageJoe
updatedDateTime string
 Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 377533000114703

Delete Service Token

DELETE /fabric/v4/serviceTokens/{uuid}
Method DELETE
URL or Endpoint /fabric/v4/serviceTokens/{uuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request deletes a specified service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Path parameters

Parameter
Description
uuid string
REQUIRED
 Service token identifier.
Example: c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04

Sample curl request

Copy 
curl -X
DELETE 'https://api.equinix.com/fabric/v4/serviceTokens/50f5dd9e-5aa0-4dca-9b80-2bbf91aca27'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Sample response

Copy 
{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "DELETED",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    },
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z",
        "updatedBy": "904885",
        "updatedDateTime": "2022-11-25T10:59:39.560Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type string
 Type of service token.
Example:
  • VC_TOKEN - Virtual connection token
uuid string
 Equinix-assigned service token identifier.
Example: 213ee923-4099-45de-8e97-8e6021ed2761
state string
 Lifecycle stage of a service token.
Example: DELETED
connection object
 Connection specification.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection boolean
 Authorization to establish connection from a different metro.
Example: true
bandwidthLimit integer
 Connection bandwidth limit in Mbps.
Applicable to A-side service tokens.
Example: 1000
supportedBandwidths array[integer]
 Supported connection bandwidths in Mbps.
Applicable to Z-side service tokens.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
aSide object
 A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: DOT1Q
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 2345
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
zSide object
 Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors array[object]
 List of available connection endpoints.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
hideAssetInfo boolean
 Hide endpoint details.
Example: false
port object
 Endpoint port parameters.
uuid string
 Equinix-assigned port identifier.
Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol object
 Link protocol configuration.
type string
 Link protocol type.
Example: QINQ
vlanTag integer
 DOT1Q protocol VLAN tag.
Applicable to DOT1Q link protocol.
Example: 123
vlanSTag integer
 QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 123
vlanCTag integer
 QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.
Applicable to QINQ link protocol.
Example: 456
vni integer
 Virtual network identifier.
Applicable to VXLAN link protocol.
Example: 5002
expirationDateTime string
 Service token expiration date timestamp in the IETF ISO 8601 extended date/time format.
Example: 2023-01-20T00:22:11.831Z
notifications array[object]
 Service token notification settings.
type string
 Notification messages category.
Example:
  • NOTIFICATION
emails array[string]
 Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
orgId string
 Customer organization identifier.
Example: 94513
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Identity of the person who updated the asset.
Example: AverageJoe
updatedDateTime string
 Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 377533000114703

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.

Search for Service Tokens

POST /fabric/v4/serviceTokens/search
Method POST
URL or Endpoint /fabric/v4/serviceTokens/search
Headers Authorization
Path Parameters Not applicable
Query Parameters offset, limit
Body Parameters Not applicable

Finds all service tokens for a search criteria.

Service tokens authorize you to access protected resources and services. They remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. You can distribute the tokens to trusted partners and vendors, allowing them to work directly with Equinix network assets.

&

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample curl request

Copy 
curl --location --request POST 'https://api.equinix.com/serviceTokens/search?offset=10&limit=10' \
--header 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'\
-d '{
    "filter": {
    "and": [
        {
        "property": "/uuid",
        "operator": "=",
        "values": [
            "407f8239-254c-4fe2-a378-458f197e17c4"
        ]
        }
    ]
    }
}
'

Query parameters

Parameter Name Mandatory Type Example Applicable Values Description
offset no integer ?offset=<integer> ?offset=2 Index of the first item returned in the response. The value must be >=0. The default is 0.
limit no integer ?limit=<integer> ?limit=2 Maximum number of search results returned per page. Number must be between 1 and 100. The default is 10.

Body parameters

Parameter Name Mandatory Data Type Example Values Description
property yes string /uuid The property you want to filter by:
projectId, uuid, state
operator yes string = Operator of the filtering criterion.
values yes string 407f8239-254c-4fe2-a378-458f197e17c4 Value of the property.

Sample response

Copy 
{
    "pagination": {
        "offset": 2,
        "limit": 2,
        "total": 511,
        "next": "/serviceTokens/search?offset=4&limit=2",
        "previous": "/serviceTokens/search?offset=0&limit=2"
        },
    "data": [
        {
        "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
        "type": "VC_TOKEN",
        "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
        "state": "INACTIVE",
        "expirationDateTime": "2021-08-14T18:39:13.866Z",
        "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": false,
        "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
        "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
        "supportedBandwidths": [
            100,
            10,
            108
            ],
        "allowCustomBandwidth": false,
        "zSide": {
            "accessPointSelectors": [
            {
            "type": "COLO",
            "port": {
                "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
                },
            "linkProtocol": {
                "type": "QINQ",
                "vlanCTag": 1399,
                "vlanSTag": 1388
                }
            }
            ]
        }
        },
        "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
            "provider@example.com",
            "Falconsvendor1@equinix.com",
            "customer@example.com"
            ]
            }
        ],
        "account": {
        "orgId": "111437"
        },
        "changeLog": {
            "createdBy": "849817",
            "createdDateTime": "2021-07-15T18:39:13.866Z"
            }
        },

        {
        "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
        "type": "VC_TOKEN",
        "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
        "state": "ACTIVE",
        "expirationDateTime": "2021-07-13T19:34:53.954Z",
        "connection": {
            "type": "EVPL_VC",
            "allowRemoteConnection": true,
            "uuid": "63dc2010-5006-46b6-9e91-995c47415d5d",
            "href": "http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d5c",
            "bandwidthLimit": 500,
                "aSide": {
                    "accessPointSelectors": [
                        {
                        "type": "COLO",
                        "port": {
                            "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
                                },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 1279
                                }
                            }
                        ]
                        }
                    },
        "notifications": [
            {
            "type": "NOTIFICATION",
            "emails": [
                "provider@example.com",
                "customer@example.com"
                ]
            }
            ],
        "account": {
        "orgId": "111437"
        },
        "changeLog": {
        "createdBy": "849817",
        "createdDateTime": "2021-07-12T19:34:53.954Z",
        "updatedDateTime": "2021-07-12T19:35:57.997Z"
        }
        }
    ]
}

Response Body Description

pagination

Parameter Name Data Type Example Values Description
offset integer ?offset=2 Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit integer ?limit=2 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 10.
total integer 511 Total number of elements returned.
next string /serviceTokens?offset=4&limit=2 URL relative to the next item in the response.
previous string /serviceTokens?offset=0&limit=2 URL relative to the previous item in the response.

data

Parameter Name Data Type Example Values Description
href string http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04 An absolute URL that is the subject of the link's context.
type string VC_TOKEN Type of service token:

VC, virtual connection
uuid string c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04 Equinix-assigned service token uuid, a 128-bit namespace identifier.
state string INACTIVE 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.
expirationDateTime string 2021-08-14T18:39:13.866Z Expiration date and time of the service token. Use IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

or

YYYY-MM-DDTHH:MM:SSZ
connection object — Specifications for establishing a data connection.
notifications array — Preferences for notification of changes in service token configuration or status.
account object — Your account data.
changeLog object — A permanent record of service token creation, modification, or deletion.

data.connection

Parameter Name Data Type Example Values Description
type string EVPL_VC Type of connection:

EVPL_VC, ethernet virtual private line‒virtual connection
allowRemoteConnection boolean false Authorization to connect remotely.
uuid string 53dc2010-5006-46b6-9e91-995c47415d5b Unique Id of the connection.
href string http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b URL of the connection.
supportedBandwidths array[integers] 100, 10, 108 List of permitted bandwidths.
allowCustomBandwidth boolean false Permission to use a bandwidth not otherwise allowed or supported.
zSide object — A zSide (subscriber) connection configuration.

connection.zSide

Parameter Name Data Type Example Values Description
accessPointSelectors array — List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.

zSide.accessPointSelectors

Parameter Name Data Type Example Values Description
type string COLO Type of access point:

COLO, colocation
port object — Configuration details for the port used at the access point.
linkProtocol object — Link protocol configuration.

zSide.accessPointSelectors.port

Parameter Name Data Type Example Values Description
uuid string b840a1db-5758-758f-97e0-328a5c00a874 The uuid of the port used at the access point.

zSide.accessPointSelectors.linkProtocol

Parameter Name Data Type Example Values Description
type string QINQ Type of link protocol. Possible values:

QINQ
DOT1Q
VXLAN
vlanTag integer 1279 VLAN frame tag used to identify packets as they traverse trunk lines. DOT1Q protocol requires only a vlanTag.
vlanCTag integer 1399 Virtual local area network (VLAN) inner "C" (customer) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vlanSTag integer 1388 Outer VLAN "S" (service) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vni integer 5002 Virtual network identifier. Applicable to VXLAN link protocol.

notifications

Parameter Name Data Type Example Values Description
type string NOTIFICATION Type of service token notifications you'd like to receive. Choosing NOTIFICATION means you'll receive service token details by email.
emails array[string] customer@example.com
provider@example.com 		Email addresses of notification recipients.

account

Parameter Name Data Type Example Values Description
orgId string 111437 Equinix-assigned organization ID.

changeLog

Parameter Name Data Type Example Values Description
createdBy string 849817 ID of the asset creator.
createdDateTime string 2021-07-15T19:30:29.526Z Date created. Use IETF ISO 8601extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

or

YYYY-MM-DDTHH:MM:SSZ
Parameter Name Data Type Example Values Description
href string http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa An absolute URL that is the subject of the link's context.
type string VC_TOKEN Type of service token:

VC, virtual connection
uuid string b1409597-7a84-4c23-a298-6803c089ecfa Equinix-assigned service token uuid, a 128-bit namespace identifier.
state string 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.
expirationDateTime string 2021-07-13T19:34:53.954Z Expiration date and time of the service token. Use IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

or

YYYY-MM-DDTHH:MM:SSZ
connection object — Specifications for establishing a data connection.
notifications array — Preferences for notification of changes in service token configuration or status.
account object — Your account data.
changeLog object — A permanent record of service token creation, modification, or deletion.

connection

Parameter Name Data Type Example Values Description
type string EVPL_VC Type of connection:

EVPL_VC, ethernet virtual private line‒virtual connection
allowRemoteConnection boolean true Authorization to connect remotely.
uuid string 63dc2010-5006-46b6-9e91-995c47415d5c Unique Id of the connection.
href string http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d50 URL of the connection.
bandwidthLimit integer 500 Permission to use a bandwidth not otherwise allowed or supported.
aSide object — An aSide (provider) connection configuration.

connection.aSide

Parameter Name Data Type Example Values Description
accessPointSelectors array — Criteriafor selecting network access points with optimal efficiency, security, compatibility, and availability.

aSide.accessPointSelectors

Parameter Name Data Type Example Values Description
type string COLO Type of access point:

COLO, colocation
port object — Configuration details for the port used at the access point.
linkProtocol object — Link protocol configuration.

aSide.accessPointSelectors.port

Parameter Name Data Type Example Values Description
uuid string b840a1db-5758-758f-97e0-328a5c00a874 The uuid of the port used at the access point.

aSide.accessPointSelectors.linkProtocol

Parameter Name Data Type Example Values Description
type string DOT1Q Type of link protocol. Possible values:

QINQ
DOT1Q
VXLAN
vlanTag integer 1279 VLAN frame tag used to identify packets as they traverse trunk lines. DOT1Q protocol requires only a vlanTag.
vlanCTag integer 1399 Virtual local area network (VLAN) inner "C" (customer) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vlanSTag integer 1388 Outer VLAN "S" (service) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vni integer 5002 Virtual network identifier. Applicable to VXLAN link protocol.

notifications

Parameter Name Data Type Example Values Description
type string NOTIFICATION Type of service token notifications you'd like to receive. Choosing NOTIFICATION means you'll receive service token details by email.
emails array[string] customer@example.com
provider@example.com 		Email addresses of notification recipients.

account

Parameter Name Data Type Example Values Description
orgId string 111437 Equinix-assigned organization ID.

changeLog

Parameter Name Data Type Example Values Description
createdBy string 849817 ID of the asset creator.
createdDateTime string 2021-07-15T19:30:29.526Z Date created. Use IETF ISO 8601extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

or

YYYY-MM-DDTHH:MM:SSZ

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.