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

Packet Host Batches API

Manage device batches. See project endpoints to list batches for a particular project. Check out the product docs to learn more about [Batch Deployment](https://metal.equinix.com/developers/docs/deploy/batch-deployment/).

Packet Host Batches 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 Batches. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

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

4 operations 3 paths 21 schemas 1 DELETE2 GET1 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

Packet Host Batches 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 4

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

Batches 4

Manage device batches. See project endpoints to list batches for a particular project. Check out the product docs to learn more about [Batch Deployment](https://metal.equinix.com/…

DELETE
/batches/{id}
Delete the Batch
deleteBatch 2 params → 204403404
GET
/batches/{id}
Retrieve a Batch
findBatchById 2 params → 200401404
GET
/projects/{id}/batches
Retrieve all batches by project
findBatchesByProject 2 params → 200401403404
POST
/projects/{id}/devices/batch
Create a devices batch
createDeviceBatch 1 param body → 201401403404422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DeviceCreateInput (25 properties), Batch (8 properties), Mount (4 properties), IPAddress (4 properties). Each schema is shown below with its type and property counts.

Mount
object
4 properties
DeviceCreateInput_billing_cycle
string
The billing cycle of the device.
InstancesBatchCreateInput_batches_inner
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
MetroInput
object
1 property 1 required
IPAddress
object
4 properties
Partition
object
3 properties
FacilityInput
object
1 property 1 required
Disk
object
3 properties
Storage
object
3 properties
SSHKeyInput
object
3 properties
InstancesBatchCreateInput
object
1 property
Filesystem
object
1 property
DeviceCreateInput
object
25 properties 2 required
IPAddress_address_family
integer
Address Family for IP Address
Batch
object
8 properties
Href
object
1 property 1 required
BatchesList
object
1 property
Raid
object
3 properties
DeviceCreateInFacilityInput
DeviceCreateInMetroInput

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Packet Host publishes across the network.

Packet Host Authentication API
Packet Host BGP API
Packet Host Capacity API
Packet Host Console Log Details API
Packet Host Devices API
Packet Host Emails API
Packet Host Events API
Packet Host Facilities API
Packet Host Firmware Sets API
Packet Host HardwareReservations API
Packet Host Incidents API
Packet Host Interconnections API
Where this information came from

This is an independent, third-party profile of Packet Host Batches 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.