The Equinix API
Equinix™ provides a RESTful HTTP API which can be reached at https://api.equinix.com/. This document describes the API and how to use it.
The API allows you to programmatically interact with your Equinix resources, including projects, devices, connections, orders, colocation deployments, support tickets, and identity and access management.
Using the Equinix API
Using the API can be broken down into the authorization flow and the request flow.
Interacting with Equinix products over API requires:
- Equinix Customer Portal account or an OIDC Provider.
- Product-specific create, modify and delete permissions.
User Authorization Flow
-
Register and Authorize an application in the Customer Portal.
-
Request access and refresh token information by calling the
/oauth2/v1/tokenwith the Consumer key, Consumer secret, and your user credentials.
-
Your request returns the short-lived OAuth access token and its associated refresh token back to you.
For more information and more detailed instructions, see API Authentication.
OIDC Token Authorization Flow
-
Create an OIDC Provider in either the Customer Portal or the Equinix API.
-
Request access by calling the
/v1/tokenendpoint with your identity provider token and scope.
- Your request returns the short-lived access token.
For more information, see OIDC API Authentication.
The Request Flow
-
Using a valid OAuth access token to authorize a request, make a call to an API endpoint with the required authorization header.
-
API gateway validates the request and calls the relevant Equinix API.
-
The response is received by the API gateway.
-
The response is sent back to you.
Infrastructure as Code with Terraform
In addition to the REST API, Equinix also provides a Terraform Provider that allows you to manage Equinix resources using infrastructure as code. The Terraform provider wraps the Equinix API and provides a declarative way to define and manage your infrastructure.
The Equinix Terraform Provider supports:
- Equinix Metal - Bare metal servers, networking, and infrastructure
- Equinix Fabric - Virtual connections, Cloud Routers, Streams, and Precision Time
- Network Edge - Virtual network devices
For complete documentation, examples, and available resources, see the Terraform Provider Documentation.
API References
The Equinix API is organized into versioned functional groups. Each functional group contains a set of API endpoints that allow you to perform operations related to that group.
API references are provided in OpenAPI format which includes detailed information about each endpoint, including the request and response formats, required parameters, and example requests. Throughout the Equinix Product Documentation you will find links to the "API Reference" corresponding with the product or service discussed.
To view a library of all Equinix API References by functional groups, see the API Catalog. You can also find links to all of the Equinix API References using the following navigational tree. Every leading API path is linked to its corresponding API Reference in this view.