Packet Host Facilities API
Facility Management. Check out the product docs to learn more about [Facilities](https://metal.equinix.com/developers/docs/locations/).
Facility Management. Check out the product docs to learn more about [Facilities](https://metal.equinix.com/developers/docs/locations/).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/packet-host-facilities-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@equinixmetal.com
name: Equinix Metal API Team
description: '# Introduction
Equinix Metal provides a RESTful HTTP API which can be reached at .'
license:
name: Equinix Metal
url: https://metal.equinix.com/legal/
termsOfService: https://metal.equinix.com/legal/
title: Metal Facilities API
version: 1.0.0
servers:
- url: https://api.equinix.com/metal/v1
security:
- x_auth_token: []
tags:
- description: Facility Management. Check out the product docs to learn more about Facilities.
name: Facilities
paths:
/facilities:
get:
deprecated: true
description: Provides a listing of available datacenters where you can provision Packet devices.
operationId: findFacilities
parameters:
- description: Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.
in: query
name: include
schema:
items:
$ref: '#/components/schemas/findFacilities_include_parameter_inner'
type: array
style: form
- description: Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.
in: query
name: exclude
schema:
default:
- address
items:
$ref: '#/components/schemas/findFacilities_include_parameter_inner'
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityList'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
summary: Retrieve all facilities
tags:
- Facilities
/organizations/{id}/facilities:
get:
deprecated: true
description: Returns a listing of available datacenters for the given organization
operationId: findFacilitiesByOrganization
parameters:
- description: Organization UUID
in: path
name: id
required: true
schema:
format: uuid
type: string
- description: 'Nested attributes to include. Included objects will return their full
attributes. Attribute names can be dotted (up to 3 levels) to included deeply
nested objects.'
explode: false
in: query
name: include
schema:
items:
type: string
type: array
style: form
- description: 'Nested attributes to exclude. Excluded objects will return only the href
attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply
nested objects.'
explode: false
in: query
name: exclude
schema:
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityList'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: not found
summary: Retrieve all facilities visible by the organization
tags:
- Facilities
/projects/{id}/facilities:
get:
deprecated: true
description: Returns a listing of available datacenters for the given project
operationId: findFacilitiesByProject
parameters:
- description: Project UUID
in: path
name: id
required: true
schema:
format: uuid
type: string
- description: 'Nested attributes to include. Included objects will return their full
attributes. Attribute names can be dotted (up to 3 levels) to included deeply
nested objects.'
explode: false
in: query
name: include
schema:
items:
type: string
type: array
style: form
- description: 'Nested attributes to exclude. Excluded objects will return only the href
attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply
nested objects.'
explode: false
in: query
name: exclude
schema:
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityList'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: not found
summary: Retrieve all facilities visible by the project
tags:
- Facilities
components:
schemas:
FacilityList:
example:
facilities:
- features:
- baremetal
- backend_transfer
- global_ipv4
address:
country: country
address: address
address2: address2
city: city
coordinates:
latitude: latitude
longitude: longitude
state: state
zip_code: zip_code
code: code
ip_ranges:
- 2604:1380::/36
- 147.75.192.0/21
metro: null
name: name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- features:
- baremetal
- backend_transfer
- global_ipv4
address:
country: country
address: address
address2: address2
city: city
coordinates:
latitude: latitude
longitude: longitude
state: state
zip_code: zip_code
code: code
ip_ranges:
- 2604:1380::/36
- 147.75.192.0/21
metro: null
name: name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
properties:
facilities:
items:
$ref: '#/components/schemas/Facility'
type: array
type: object
Error:
description: Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
properties:
error:
description: A description of the error that caused the request to fail.
type: string
errors:
description: A list of errors that contributed to the request failing.
items:
description: An error message that contributed to the request failing.
type: string
type: array
type: object
Coordinates:
example:
latitude: latitude
longitude: longitude
properties:
latitude:
type: string
longitude:
type: string
type: object
Device_metro:
allOf:
- $ref: '#/components/schemas/Metro'
- description: The metro the facility is in
type: object
Facility:
example:
features:
- baremetal
- backend_transfer
- global_ipv4
address:
country: country
address: address
address2: address2
city: city
coordinates:
latitude: latitude
longitude: longitude
state: state
zip_code: zip_code
code: code
ip_ranges:
- 2604:1380::/36
- 147.75.192.0/21
metro: null
name: name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
properties:
address:
$ref: '#/components/schemas/Address'
code:
type: string
features:
example:
- baremetal
- backend_transfer
- global_ipv4
items:
$ref: '#/components/schemas/Facility_features_inner'
type: array
id:
format: uuid
type: string
ip_ranges:
description: IP ranges registered in facility. Can be used for GeoIP location
example:
- 2604:1380::/36
- 147.75.192.0/21
items:
type: string
type: array
metro:
$ref: '#/components/schemas/Device_metro'
name:
type: string
type: object
Facility_features_inner:
enum:
- baremetal
- backend_transfer
- layer_2
- global_ipv4
- ibx
type: string
Address:
example:
country: country
address: address
address2: address2
city: city
coordinates:
latitude: latitude
longitude: longitude
state: state
zip_code: zip_code
properties:
address:
type: string
address2:
type: string
city:
type: string
coordinates:
$ref: '#/components/schemas/Coordinates'
country:
type: string
state:
type: string
zip_code:
type: string
required:
- address
- country
- zip_code
type: object
findFacilities_include_parameter_inner:
enum:
- address
- labels
type: string
Metro:
example:
country: country
code: code
name: name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
properties:
code:
type: string
country:
type: string
id:
format: uuid
type: string
name:
type: string
type: object
securitySchemes:
x_auth_token:
description: 'HTTP header containing the User or Project API key that will be used to authenticate the request.
'
in: header
name: X-Auth-Token
type: apiKey
x-displayName: X-Auth-Token
x-tagGroups:
- name: Accounts and Organization
tags:
- Authentication
- Emails
- Invitations
- Memberships
- Organizations
- OTPs
- PasswordResetTokens
- PaymentMethods
- Projects
- SSHKeys
- SupportRequest
- TransferRequests
- TwoFactorAuth
- Users
- UserVerificationTokens
- name: Services and Billing
tags:
- Events
- Facilities
- Incidents
- Invoices
- Licenses
- Metros
- Plans
- Usages
- name: Servers
tags:
- Devices
- Batches
- Capacity
- HardwareReservations
- OperatingSystems
- Ports
- SelfServiceReservations
- SpotMarket
- Userdata
- Volumes
- name: Networking
tags:
- BGP
- Interconnections
- IPAddresses
- MetalGateways
- VLANs
- VRFs