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.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Equinix 12
Other APIs Equinix publishes across the network.