Equinix Devices API
Device Management. Check out the product docs to learn more about [Server Devices](https://metal.equinix.com/developers/docs/servers/).
Equinix Devices API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 20 operations across 15 paths, and defines 94 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.
20 operations
15 paths
94 schemas
1 DELETE14 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 20
Across 15 paths, the API surfaces 20 operations — 1 DELETE, 14 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Devices 20
Device Management. Check out the product docs to learn more about [Server Devices](https://metal.equinix.com/developers/docs/servers/).
DELETE
/devices/{id}
Delete the device
GET
/devices/{id}
Retrieve a device
PUT
/devices/{id}
Update the device
POST
/devices/{id}/actions
Perform an action
GET
/devices/{id}/bandwidth
Retrieve an instance bandwidth
GET
/devices/{id}/bgp/neighbors
Retrieve BGP neighbor data for this device
GET
/devices/{id}/bgp/sessions
Retrieve all BGP sessions
POST
/devices/{id}/bgp/sessions
Create a BGP session
GET
/devices/{id}/customdata
Retrieve the custom metadata of an instance
GET
/devices/{id}/diagnostics/health/rollup
Get Device's Health Status
GET
/devices/{id}/firmware-sets
Get Device's associated Firmware Set
GET
/devices/{id}/ips
Retrieve all ip assignments
POST
/devices/{id}/ips
Create an ip assignment
GET
/devices/{id}/metadata
Retrieve metadata
GET
/devices/{id}/traffic
Retrieve device traffic
GET
/devices/{id}/userdata
Retrieve userdata
GET
/devices/{instance_id}/ips/{id}/customdata
Retrieve the custom metadata of an IP Assignment
GET
/organizations/{id}/devices
Retrieve all devices of an organization
GET
/projects/{id}/devices
Retrieve all devices of a project
POST
/projects/{id}/devices
Create a device
Schemas 94
The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are Device (43 properties), DeviceCreateInput (25 properties), IPAssignment (20 properties), Project (19 properties). Each schema is shown below with its type and property counts.
BgpSessionList
object
1 property
Organization
object
17 properties
IPAssignment_metro
findOrganizationDevices_categories_parameter_inner
string
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…
Facility_features_inner
string
Plan_specs_cpus_inner
object
2 properties
Plan_available_in_inner
object
2 properties
Metadata_network_network_bonding
object
3 properties
Port_network_type
string
Composite network type of the bond
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.
DeviceUpdateInput
object
12 properties
MetroInput
object
1 property
1 required
Metadata_network_network
object
1 property
Device_metro
BGPSessionInput
object
2 properties
Userdata
object
1 property
IPAssignmentInput
object
2 properties
1 required
DeviceCreateInFacilityInput
Plan_specs_drives_inner_category
string
createDevice_request
FacilityInput
object
1 property
1 required
DeviceList
object
2 properties
Plan_available_in_inner_price
object
1 property
Plan_specs
object
5 properties
Metadata_network
object
3 properties
Plan_deployment_types_inner
string
Plan_available_in_metros_inner
object
2 properties
DeviceHealthRollup
object
Represents a Device Health Status
2 properties
ParentBlock
object
4 properties
BgpSession_address_family
string
FirmwareSet
object
Represents a Firmware Set
6 properties
2 required
Event
object
10 properties
Attribute
object
4 properties
Facility
object
7 properties
IPAddress
object
4 properties
DeviceCreateInMetroInput
PortData
object
2 properties
BondPortData
object
2 properties
findTraffic_timeframe_parameter
object
2 properties
2 required
IPAssignment_type
string
Port_type
string
Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports
Coordinates
object
2 properties
OperatingSystem
object
11 properties
Filesystem
object
1 property
IPAssignmentList
object
1 property
Plan_specs_nics_inner
object
2 properties
AttributeData
object
4 properties
BGPSessionInput_address_family
string
Address family for BGP session.
BgpSession
object
9 properties
1 required
Device_actions_inner
object
2 properties
Device_project_lite
Address
object
7 properties
3 required
Plan_specs_features
object
3 properties
IPAssignment
object
20 properties
Plan
object
14 properties
SSHKeyInput
object
3 properties
findTraffic_direction_parameter
string
BgpNeighborData
object
10 properties
Partition
object
3 properties
Plan_specs_memory
object
1 property
Port
object
Port is a hardware port associated with a reserved or instantiated hardware device.
10 properties
DeviceHealthRollup_health_rollup
string
Health Status
DeviceActionInput_type
string
Action to perform. See Device.actions for possible actions.
IPAddress_address_family
integer
Address Family for IP Address
Plan_type
string
The plan type
VirtualNetwork
object
13 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…
Storage
object
3 properties
Metadata
object
18 properties
Meta
object
8 properties
Mount
object
4 properties
Device
object
43 properties
BgpSessionNeighbors
object
1 property
Raid
object
3 properties
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.
Component
object
11 properties
DeviceCreateInput_billing_cycle
string
The billing cycle of the device.
findTraffic_interval_parameter
string
Project
object
19 properties
Disk
object
3 properties
DeviceActionInput
object
6 properties
1 required
FirmwareSetResponse
object
Represents single Firmware set response
1 property
HardwareReservation
object
14 properties
UserLite
object
10 properties
2 required
DeviceCreateInput
object
25 properties
2 required
Metro
object
4 properties
findTraffic_bucket_parameter
string
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
BgpRoute
object
2 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
More from Equinix 12
Other APIs Equinix publishes across the network.
Equinix Agent Templates API
Equinix Agents API
Equinix Authentication 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
#Devices