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 Authentication API

Nearly all of the endpoints in the API require authentication. Authentication is performed by providing an authentication token (interchangeably referred to as an API key) in the `X-Auth-Token` HTTP request header.User API keys can be obtained by creating them in the Equinix Metal Portal or by using the [Create a User API Key](#operation/createAPIKey) endpoint.Project API keys can also be obtained by creating them in the Equinix Metal Portal or by using the [Create a Project API Key](#operation/createProjectAPIKey) endpoint. Project API keys are scoped to a single project and can only be used to access resources within that project.For example, to use an authenticated API token, you would make a request like the following:```bashcurl -H 'X-Auth-Token: my_authentication_token' \ https://api.equinix.com/metal/v1/user/api-keys```Applications can take advantage of the Equinix Metal API and API keys to perform any of the actions that can be performed in the Equinix Metal Portal. For example, you can use the API to create and manage devices, projects, and other resources.API keys can be deleted without affecting any of the resources created with them. Access to applications using the API can be revoked by deleting the API key used to authenticate the application.

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

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

This API exposes 6 operations across 4 paths, and defines 13 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.

6 operations 4 paths 13 schemas 2 DELETE2 GET2 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 6

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

Authentication 6

Nearly all of the endpoints in the API require authentication. Authentication is performed by providing an authentication token (interchangeably referred to as an API key) in the…

DELETE
/api-keys/{id}
Delete the API key
deleteAPIKey 1 param → 204401404
GET
/projects/{id}/api-keys
Retrieve all API keys for the project.
findProjectAPIKeys 2 params → 200401404
POST
/projects/{id}/api-keys
Create an API key for a project.
createProjectAPIKey 2 params body → 201401404422
GET
/user/api-keys
Retrieve all user API keys
findAPIKeys 2 params → 200401404
POST
/user/api-keys
Create an API key
createAPIKey 1 param body → 201401404422
DELETE
/user/api-keys/{id}
Delete the API key
deleteUserAPIKey 1 param → 204401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are User (22 properties), Project (19 properties), Organization (17 properties), AuthToken (8 properties). Each schema is shown below with its type and property counts.

Href
object
1 property 1 required
User
object
22 properties
AuthTokenInput
object
2 properties
Error
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
2 properties
Organization
object
17 properties
AuthToken_user
AuthTokenList
object
1 property
Project_type
string
The type of the project. Projects of type vmce are part of an in development feature and not available to all customers.
Project
object
19 properties
Address
object
7 properties 3 required
Coordinates
object
2 properties
AuthToken
object
8 properties
AuthToken_project

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-authentication-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents 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
Equinix Devices API