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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Equinix

Equinix HardwareReservations API

Hardware Reservation Management. Check out the product docs to learn more about [Reserved Hardware](https://metal.equinix.com/developers/docs/deploy/reserved/).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

4 operations 4 paths 58 schemas 2 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
Contact
Equinix API Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 4

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

HardwareReservations 4

Hardware Reservation Management. Check out the product docs to learn more about [Reserved Hardware](https://metal.equinix.com/developers/docs/deploy/reserved/).

GET
/hardware-reservations/{id}
Retrieve a hardware reservation
findHardwareReservationById 3 params → 200401403404
POST
/hardware-reservations/{id}/activate
Activate a spare hardware reservation
activateHardwareReservation 3 params body → 201401403404
POST
/hardware-reservations/{id}/move
Move a hardware reservation
moveHardwareReservation 3 params body → 201401403404
GET
/projects/{id}/hardware-reservations
Retrieve all hardware reservations for a given project
findProjectHardwareReservations 8 params → 200401403404

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are Device (43 properties), IPAssignment (20 properties), Project (19 properties), Organization (17 properties). Each schema is shown below with its type and property counts.

Plan_specs_drives_inner_category
string
Device_actions_inner
object
2 properties
Plan_available_in_inner_price
object
1 property
Meta
object
8 properties
Plan_specs
object
5 properties
Device_project_lite
Plan_deployment_types_inner
string
Address
object
7 properties 3 required
Plan_specs_features
object
3 properties
IPAssignment
object
20 properties
Plan_available_in_metros_inner
object
2 properties
Plan
object
14 properties
ParentBlock
object
4 properties
activateHardwareReservation_request
object
1 property
Partition
object
3 properties
Plan_specs_memory
object
1 property
Organization
object
17 properties
Mount
object
4 properties
Port
object
Port is a hardware port associated with a reserved or instantiated hardware device.
10 properties
IPAssignment_metro
Device
object
43 properties
Event
object
10 properties
Facility
object
7 properties
Raid
object
3 properties
Device_state
string
The current state the instance is in. When an instance is initially created it will be in the queued state until it is picked up by the provisioner. Once provi…
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.
PortData
object
2 properties
Facility_features_inner
string
BondPortData
object
2 properties
Plan_specs_cpus_inner
object
2 properties
Project
object
19 properties
Plan_available_in_inner
object
2 properties
findProjectHardwareReservations_provisionable_parameter
string
moveHardwareReservation_request
object
1 property
IPAssignment_type
string
Plan_type
string
The plan type
Coordinates
object
2 properties
Disk
object
3 properties
VirtualNetwork
object
13 properties
Port_type
string
Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports
OperatingSystem
object
11 properties
HardwareReservation
object
14 properties
findProjectHardwareReservations_state_parameter
string
UserLite
object
10 properties 2 required
Filesystem
object
1 property
HardwareReservationList
object
2 properties
Port_network_type
string
Composite network type of the bond
Metro
object
4 properties
IPAssignment_state
string
Only set when this is a Metal Gateway Elastic IP Assignment. Describes the current configuration state of this IP on the network.
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
MetalGatewayLite
object
7 properties
MetalGateway_state
string
The current state of the Metal Gateway. 'Ready' indicates the gateway record has been configured, but is currently not active on the network. 'Active' indicate…
Plan_specs_nics_inner
object
2 properties
Device_metro
Storage
object
3 properties
Device_created_by
Plan_specs_drives_inner
object
4 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-hardwarereservations-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#HardwareReservations
← Back to E APIs
API Details
ID
equinix:equinix-hardwarereservations-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network