How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Packet Host

Packet Host Devices API

Device Management. Check out the product docs to learn more about [Server Devices](https://metal.equinix.com/developers/docs/servers/).

Documentation Provider Profile APIs.io OpenAPI GitHub

Packet Host Devices API is one of 40 APIs that Packet Host 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 an API reference.

This API exposes 20 operations across 15 paths, and defines 94 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.equinix.com/metal/v1.

20 operations 15 paths 94 schemas 1 DELETE14 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.equinix.com/metal/v1
Authentication
API Key
Contact
Equinix Metal API Team
License
Equinix Metal
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Packet Host Devices API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (x_auth_token). By default, every request must be authenticated.

  • x_auth_token — HTTP header containing the User or Project API key that will be used to authenticate the request.

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
deleteDevice 2 params → 204401403404422
GET
/devices/{id}
Retrieve a device
findDeviceById 3 params → 200401403404
PUT
/devices/{id}
Update the device
updateDevice 3 params body → 200401403404422
POST
/devices/{id}/actions
Perform an action
performAction 1 param body → 202401404422
GET
/devices/{id}/bandwidth
Retrieve an instance bandwidth
findInstanceBandwidth 3 params → 200403404
GET
/devices/{id}/bgp/neighbors
Retrieve BGP neighbor data for this device
getBgpNeighborData 2 params → 200401403404
GET
/devices/{id}/bgp/sessions
Retrieve all BGP sessions
findBgpSessions 2 params → 200401403
POST
/devices/{id}/bgp/sessions
Create a BGP session
createBgpSession 2 params body → 201401403422
GET
/devices/{id}/customdata
Retrieve the custom metadata of an instance
findDeviceCustomdata 1 param → 200401403404
GET
/devices/{id}/diagnostics/health/rollup
Get Device's Health Status
getDeviceHealthRollup 1 param → 200401404500
GET
/devices/{id}/firmware-sets
Get Device's associated Firmware Set
getDeviceFirmwareSets 1 param → 200401404500
GET
/devices/{id}/ips
Retrieve all ip assignments
findIPAssignments 3 params → 200401404
POST
/devices/{id}/ips
Create an ip assignment
createIPAssignment 3 params body → 201401404422
GET
/devices/{id}/metadata
Retrieve metadata
findDeviceMetadataByID 1 param → 200401404422
GET
/devices/{id}/traffic
Retrieve device traffic
findTraffic 5 params → 200401403404
GET
/devices/{id}/userdata
Retrieve userdata
findDeviceUserdataByID 1 param → 200401404422
GET
/devices/{instance_id}/ips/{id}/customdata
Retrieve the custom metadata of an IP Assignment
findIPAssignmentCustomdata 2 params → 200401403404
GET
/organizations/{id}/devices
Retrieve all devices of an organization
findOrganizationDevices 13 params → 200401403404
GET
/projects/{id}/devices
Retrieve all devices of a project
findProjectDevices 14 params → 200401403404
POST
/projects/{id}/devices
Create a device
createDevice 3 params body → 201401403404422

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.

Project
object
19 properties
findTraffic_timeframe_parameter
object
2 properties 2 required
HardwareReservation
object
14 properties
VirtualNetwork
object
13 properties
Metadata_network
object
3 properties
Plan
object
14 properties
Partition
object
3 properties
Component
object
11 properties
findOrganizationDevices_categories_parameter_inner
string
Coordinates
object
2 properties
DeviceHealthRollup_health_rollup
string
Health Status
FirmwareSetResponse
object
Represents single Firmware set response
1 property
Plan_deployment_types_inner
string
Device_actions_inner
object
2 properties
DeviceActionInput_type
string
Action to perform. See Device.actions for possible actions.
DeviceList
object
2 properties
IPAddress_address_family
integer
Address Family for IP Address
BondPortData
object
2 properties
IPAssignment_metro
Plan_specs_drives_inner
object
4 properties
findTraffic_interval_parameter
string
MetalGatewayLite
object
7 properties
Plan_available_in_inner_price
object
1 property
Mount
object
4 properties
FirmwareSet
object
Represents a Firmware Set
6 properties 2 required
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.
BgpSessionNeighbors
object
1 property
Plan_specs
object
5 properties
UserLite
object
10 properties 2 required
Storage
object
3 properties
Port
object
Port is a hardware port associated with a reserved or instantiated hardware device.
10 properties
PortData
object
2 properties
Plan_available_in_metros_inner
object
2 properties
SSHKeyInput
object
3 properties
DeviceCreateInput
object
25 properties 2 required
Plan_specs_nics_inner
object
2 properties
DeviceCreateInMetroInput
Plan_specs_cpus_inner
object
2 properties
IPAssignment
object
20 properties
Address
object
7 properties 3 required
BgpSession
object
9 properties 1 required
IPAssignmentInput
object
2 properties 1 required
Meta
object
8 properties
BgpSessionList
object
1 property
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
IPAddress
object
4 properties
Plan_available_in_inner
object
2 properties
Event
object
10 properties
Device_metro
DeviceUpdateInput
object
12 properties
Port_network_type
string
Composite network type of the bond
BgpRoute
object
2 properties
Metro
object
4 properties
FacilityInput
object
1 property 1 required
Device
object
43 properties
Attribute
object
4 properties
AttributeData
object
4 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.
Plan_specs_memory
object
1 property
Plan_specs_features
object
3 properties
findTraffic_direction_parameter
string
Device_project_lite
BGPSessionInput
object
2 properties
Facility
object
7 properties
Filesystem
object
1 property
IPAssignment_type
string
BgpSession_address_family
string
Metadata_network_network_bonding
object
3 properties
Href
object
1 property 1 required
Metadata_network_network
object
1 property
Organization
object
17 properties
Raid
object
3 properties
DeviceHealthRollup
object
Represents a Device Health Status
2 properties
createDevice_request
findTraffic_bucket_parameter
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…
DeviceCreateInput_billing_cycle
string
The billing cycle of the device.
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…
MetroInput
object
1 property 1 required
ParentBlock
object
4 properties
BGPSessionInput_address_family
string
Address family for BGP session.
Plan_type
string
The plan type
Port_type
string
Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports
Disk
object
3 properties
OperatingSystem
object
11 properties
Userdata
object
1 property
Metadata
object
18 properties
BgpNeighborData
object
10 properties
IPAssignmentList
object
1 property
DeviceActionInput
object
6 properties 1 required
Device_created_by
Facility_features_inner
string
DeviceCreateInFacilityInput
Plan_specs_drives_inner_category
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

packet-host-devices-api-openapi.yml Raw ↑

Other APIs Packet Host publishes across the network.

Packet Host Authentication API
AE Profile APIs.io
Packet Host Batches API
AE Profile APIs.io
Packet Host BGP API
AE Profile APIs.io
Packet Host Capacity API
AE Profile APIs.io
Packet Host Console Log Details API
AE Profile APIs.io
Packet Host Emails API
AE Profile APIs.io
Packet Host Events API
AE Profile APIs.io
Packet Host Facilities API
AE Profile APIs.io
Packet Host Firmware Sets API
AE Profile APIs.io
Packet Host HardwareReservations API
AE Profile APIs.io
Packet Host Incidents API
AE Profile APIs.io
Packet Host Interconnections API
AE Profile APIs.io
#Devices
← Back to P APIs
API Details
ID
packet-host:packet-host-devices-api
Base URL
https://api.equinix.com/metal/v1
Docs
https://docs.equinix.com/metal/
Provider
Packet Host
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=packet-host-devices-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/packet-host-devices-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Packet Host Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.