Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Equinix Service Tokens API

Service Tokens

Equinix Service Tokens API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Tokens. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 32 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

7 operations 4 paths 32 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Service Tokens 7

Service Tokens

GET
/fabric/v4/serviceTokens/{serviceTokenId}
Get Token by uuid
getServiceTokenByUuid 1 param → 200400403500
DELETE
/fabric/v4/serviceTokens/{serviceTokenId}
Delete Token by uuid
deleteServiceTokenByUuid 1 param → 200400403500
PATCH
/fabric/v4/serviceTokens/{serviceTokenId}
Update Token By ID
updateServiceTokenByUuid 2 params body → 200400403500
GET
/fabric/v4/serviceTokens
Get All Tokens
getServiceTokens 2 params → 200403
POST
/fabric/v4/serviceTokens
Create Service Token
createServiceToken 1 param body → 200201400401403
POST
/fabric/v4/serviceTokens/{serviceTokenId}/actions
ServiceToken Actions
createServiceTokenAction 1 param body → 202400401403404
POST
/fabric/v4/serviceTokens/search
Search servicetokens
searchServiceTokens 2 params body → 200400403404500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ServiceToken (14 properties), SimplifiedAccount (12 properties), Changelog (12 properties), SimplifiedMetadataEntity (10 properties). Each schema is shown below with its type and property counts.

ServiceTokenActionRequest
object
Service Token action request
1 property 1 required
SimplifiedTokenNetwork
object
6 properties
VirtualDeviceInterface
object
Virtual Device Interface Information
3 properties
PriceError_additionalInfo
object
2 properties
SimplifiedNotification
object
4 properties 2 required
SimplifiedLocation
object
5 properties
ServiceTokens
object
Service tokens authorize a user to access protected resources and services available on the Equinix Fabric network. The owner of the resources can distribute s…
2 properties
ServiceTokenState
string
Service token state
ServiceTokenUUID
string
Service Token UUID
ServiceToken
object
Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove…
14 properties
Pagination
object
Pagination response information
5 properties 2 required
ServiceTokenSearchExpressions
array
ErrorList
array
List of Error Message
Changelog
object
Change log
12 properties
AccessPointSelector
object
List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.
7 properties
ServiceTokenChangeOperation
object
Service Token change operation data
3 properties 3 required
SimplifiedVirtualDevice
object
6 properties
ServiceTokenSearchExpression
object
5 properties
ServiceTokenSide
object
Connection link protocol,virtual device or network configuration
1 property
SimplifiedAccount
object
12 properties
ServiceTokenSearchRequest
object
Search requests containing criteria
2 properties
Project
object
1 property 1 required
ServiceTokenActions
string
Service Token action type
ServiceTokenSearchFieldName
string
Possible field names to use on filters
SimplifiedLinkProtocol
object
Connection link protocol Configuration
4 properties
ServiceTokenConnection
object
Service Token Connection Type Information
9 properties
LinkProtocolType
string
Type of Link Protocol
ServiceTokenType
string
Type of Service Token
Error
object
Error Response with details
6 properties 2 required
SimplifiedMetadataEntity
object
Configuration details for port used at the access point.
10 properties
PaginationRequest
object
Pagination request information
2 properties
ServiceTokenUpdateRequest
array
Service Token Update Request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-service-tokens-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API