accesstokenv1
Equinix APIs use the OAuth 2.0 for authentication and authorization. Equinix supports the resource owner password and the client credentials flow. To begin, obtain OAuth 2.0 client credentials from the Equinix Developer Console under "My Apps". Then your client application requests an access token from the Equinix API Authorization endpoint, extracts the access_token from the response, and sends the Bearer token to the API that you want to access
assetsv1
Assets are all the products and equipment belonging to your organization that are installed in Equinix's IBXs. These assets can be viewed by users with the appropriate permissions. Assets can be searched by a filter criterion, or the details of an individual asset can be looked up by its asset ID.
attachmentsv1
Attachment Management API for Equinix Customer Portal
basv2
API Documentation for BAS
billingv1
Based on a user's permission, a User can view financial records and payment history and download invoice documents for their permitted billing accounts. The invoice and payment document can be filtered by product type, account, or date range. Only the account billing and invoice details will be from the past 12 months will be returned.
billingv2
The Billing API allows users to view summarized and detailed versions of invoices and credit memos. Users can filter the responses based on date range, account numbers, and transaction IDs. The user's permission is applied to retrieve the invoice summary, and invoice details will be from the past 12 months.
crossconnectsv2
A Cross Connect is a physical cable connection that uses a coaxial, fiber or sometimes copper cable to connect customers equipment directly to other customers equipment inside Equinix data centers. Since cross connects transmit data point-to-point between computing systems inside our facility, they are not susceptible to the latency or congestion problems of the public Internet and can be relied upon to operate at consistently high speeds.
diloav1
Digital LOA API
environmentalv1
Empower yourself with Smart View Environment APIs. Use these APIs to fetch current and trending environmental data (humidity and temperature). Given an account number, IBX code, get current and trending environment data for a level value. The environment info (temperature and humidity) is returned for input IBX, zone, cage and sensor.
environmentalv2
Empower yourself with Environmental APIs. The API makes it possible to fetch current environmental data including humidity and temperature for a single sensor (identified by IBX code and sensor ID) or for all the sensors within an IBX (identified by IBX code) in a paginated way. When fetching all sensor readings you can apply additional sort criteria.
fabricv4
Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to: </br> 1. Cloud Service Providers - Clouds, network and other service providers. </br> 2. Enterprises - Other Equinix customers, vendors and partners. </br> 3. Myself - Another customer instance deployed at Equinix. </br> </br> <b>Integrations (SDKs, Tools) links:</b> </br> <a href="https://deploy.equinix.com/labs/fabric-java\">Fabric Java SDK</a> </br> <a href="https://deploy.equinix.com/labs/equinix-sdk-go\">Fabric Go SDK</a> </br> <a href="https://deploy.equinix.com/labs/equinix-sdk-python\">Fabric Python SDK</a> </br> <a href="https://deploy.equinix.com/labs/terraform-provider-equinix\">Equinix Terraform Provider</a> </br> <a href="https://deploy.equinix.com/labs/terraform-equinix-fabric\">Fabric Terraform Modules</a> </br> <a href="https://deploy.equinix.com/labs/pulumi-provider-equinix/">Equinix Pulumi Provider</a> </br>
feed-subscriptionv2
IBX SmartView's subscription API allows users to subscribe to near real-time message feeds for events occurring within an IBX. Users can specify the types of messages to receive for each IBX. Users are able to view all subscriptions within their organization and update any subscription to modify the message feed being received.
getprojectsv2
API documentation for project APIs
hierarchyv1
Empower yourself with Smart View Hierarchy APIs. Use these APIs to obtain location and power hierarchy for invoking other APIs. Given an account number, IBX code, and an asset Id, returns the corresponding location and power hierarchy of related assets. Required query parameters to obtain a valid response from these endpoints are account number and IBX code.
ibx-assetsv1
Empower yourself with Smart View Assets API. These provide the ability to consumers to list infra asset, fetch infra asset details, get affected customer assets based on asset id. Given an account number, IBX code, cage and asset classification (Electrical, Mechanical), information about the asset in a hierarchical structure comprising of the category, template and asset is returned. Given a category and a template, a list of assets is returned.
internetaccessv1
Equinix Internet Access provides direct access to the Internet with scalable bandwidth options in IBX data centers. This current set of API’s allows for ordering of Equinix Internet Access on ports dedicated only to this service. Ordering virtual connections to the internet over an existing Fabric port, shared with other virtual connections, will be added in a future set of API’s. Single or dual port connections are available, ranging from 1G to 100G. Multiple large Internet Service Providers (ISPs) are used at every location to ensure redundancy. Equinix Internet Access supports various protocols, including Border Gateway Protocol (BGP), VRRP (static and direct), and Direct and Static routing. Equinix Internet Access routers are connected to local Equinix Internet Exchange (IX) switches and other partner peering platforms offering a shortcut to access local peers. This approach delivers optimal performance.
internetaccessv2
Equinix Internet Access provides direct access to the Internet with scalable bandwidth options in IBX data centers.
lookupv2
Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order
metalv1
Equinix Metal provides a RESTful HTTP API which can be reached at https://api.equinix.com/metal/v1. This document describes the API and how to use it.
The API allows you to programmatically interact with all of your Equinix Metal resources, including devices, networks, addresses, organizations, projects, and your user account. Every feature of the Equinix Metal web interface is accessible through the API.
The API docs are generated from the Equinix Metal OpenAPI specification and are officially hosted at https://deploy.equinix.com/developers/api/metal/.
The Equinix Metal API uses a few methods to minimize network traffic and improve throughput. These parameters are not used in all API calls, but are used often enough to warrant their own section. Look for these parameters in the documentation for the API calls that support them.
Pagination is used to limit the number of results returned in a single request. The API will return a maximum of 100 results per page. To retrieve additional results, you can use the page and per_page query parameters.
The page parameter is used to specify the page number. The first page is 1. The per_page parameter is used to specify the number of results per page. The maximum number of results differs by resource type.
Where offered, the API allows you to sort results by a specific field. To sort results use the sort_by query parameter with the root level field name as the value. The sort_direction parameter is used to specify the sort direction, either either asc (ascending) or desc (descending).
Filtering is used to limit the results returned in a single request. The API supports filtering by certain fields in the response. To filter results, you can use the field as a query parameter.
For example, to filter the IP list to only return public IPv4 addresses, you can filter by the type field, as in the following request:
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/projects/id/ips?type=public_ipv4
Only IP addresses with the type field set to public_ipv4 will be returned.
Searching is used to find matching resources using multiple field comparissons. The API supports searching in resources that define this behavior. Currently the search parameter is only available on devices, ssh_keys, api_keys and memberships endpoints.
To search resources you can use the search query parameter.
For resources that contain references to other resources, sucha as a Device that refers to the Project it resides in, the Equinix Metal API will returns href values (API links) to the associated resource.
{
...
"project": {
"href": "/metal/v1/projects/f3f131c8-f302-49ef-8c44-9405022dc6dd"
}
}
If you're going need the project details, you can avoid a second API request. Specify the contained href resources and collections that you'd like to have included in the response using the include query parameter.
For example:
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=projects
The include parameter is generally accepted in GET, POST, PUT, and PATCH requests where href resources are presented.
To have multiple resources include, use a comma-separated list (e.g. ?include=emails,projects,memberships).
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=emails,projects,memberships
You may also include nested associations up to three levels deep using dot notation (?include=memberships.projects):
curl -H 'X-Auth-Token: my_authentication_token' \
https://api.equinix.com/metal/v1/user?include=memberships.projects
To exclude resources, and optimize response delivery, use the exclude query parameter. The exclude parameter is generally accepted in GET, POST, PUT, and PATCH requests for fields with nested object responses. When excluded, these fields will be replaced with an object that contains only an href field.
network-edgev1
Network Edge (NE) is a platform that allows customers to deploy and run virtual network services and appliances such as routers, load balancers, and firewalls on a generic device instead of additional dedicated hardware, CapEx and colo space. The Network Edge REST APIs allow you to interact with the Equinix Platform to programmatically create a virtual device and add services. Details on specific use cases can be found in the documentation available on the developer portal.
notificationsv1
Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences. Only email notifications will be returned in the notification APIs. These APIs search through these received notifications and can also retrieve the details for a specific notification.
orderhistoryv1
Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.
ordersv2
Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.
powerv1
Empower yourself with DCIM Power APIs. Use them to get current and trending information on power consumption by assets. These APIs return the power consumption info for all level values, given a customer account number, IBX and level type of ibx - cage, cabinet or circuit. Trending power data returns the kVA power draw and max allowed (%) for the given asset.
quotesv2
Quote API allow users to retrieve detailed information about their Equinix quote. Users can use this API to get line level product and service pricing. In additional, users can also obtain important information such as quote expiry date and terms of use. Note that only quotes from the past 12 months will be returned.
reportsv1
The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions. The reports can be scheduled to be generated on a recurring basis, or they can be generated on an ad hoc basis.
securecabinetv1
Secure Cabinet API
shipmentsv1
To submit a Shipment order.
shipmentsv2
All inbound and outbound shipments must be scheduled 24 hours in advance. Deliveries during non-standard business hours (after hours or weekend deliveries) require prior approval and will be billed to your account as an Equinix Smart Hands charge. You must communicate in writing any special shipping or packing instructions and if special packaging material is required. If your shipments are international, Equinix recommends that you hire a U.S. Customs Broker before shipping your equipment to and from our facilities. It is your responsibility to arrange for delivery to and from our facilities and customs clearance at the port of entry.
smarthandsv1
Request cage assistance, custom installation and equipment troubleshooting.
supportplansv2
The Smart Hands Support plan API allows users to retrieve information of their purchased plan. Information includes but is not limited to plan name, plan type, purchased minutes, consumed minutes, and remaining minutes for Smart Hands. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.
supportv2
The API for the Case Management Service.
system-alertsv2
Empower yourself with IBX SmartView System Alert APIs to access information on the alarms, now known as system alerts. Given a multiple criteria, this API retrieves all the system alerts. We recommend customers utilize the POST call, however both calls are supported and functional.
ticketsv2
Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.
troubleticketv1
If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket. If this issue is not impacting your service, please submit a Smart Hands request.
unifiednotificationv2
The notifications API will return email notifications for different categories, such as orders, IBX maintenance announcements, incidents and advisories. Please check the Category, Type, and ProductType schemas for the allowed lists of values to perform a search request.
workvisitsv2
Work visits can be scheduled at the request of the customer. This service can only be scheduled by a user with IBX Access Services ordering permission. Work visits are only applicable for visits up to 14 days long. Please note that work visits that exceed 14 days require Security Access approval instead.
workvisitv1
Schedule a Work Visit by providing the IBX and cage you will need access to, the dates and times of the visit, and some basic information about the visitors who will be arriving at the site. Work visits have a maximum duration of two weeks. If a visitor needs to be on-site for more than two weeks please add them as a user with IBX access.