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

Equinix 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/).

Equinix Batches API is one of 74 APIs that Equinix 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 API documentation.

This API exposes 4 operations across 3 paths, and defines 21 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 3 paths 21 schemas 1 DELETE2 GET1 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
Terms of Service
Resource Areas
1

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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-batches-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability 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
Equinix Devices API