Packet Host Plans API
Plan Management (Device). Check out the product docs to learn more about [Device Plans](https://metal.equinix.com/developers/docs/servers/).
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/packet-host-plans-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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 Specification
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 Plans API
version: 1.0.0
servers:
- url: https://api.equinix.com/metal/v1
security:
- x_auth_token: []
tags:
- description: Plan Management (Device). Check out the product docs to learn more about Device Plans.
name: Plans
paths:
/plans:
get:
description: Provides a listing of available plans to provision your device on.
operationId: findPlans
parameters:
- description: Filter plans by its category
in: query
name: categories
schema:
items:
$ref: '#/components/schemas/findOrganizationDevices_categories_parameter_inner'
type: array
- description: Filter plans by its plan type
in: query
name: type
schema:
$ref: '#/components/schemas/findPlans_type_parameter'
- description: Filter plans by slug
in: query
name: slug
schema:
example: c3.small.x86
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/PlanList'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
summary: Retrieve all plans
tags:
- Plans
/projects/{id}/plans:
get:
description: Returns a listing of available plans for the given project
operationId: findPlansByProject
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/PlanList'
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 plans visible by the project
tags:
- Plans
components:
schemas:
Plan_specs_features:
example:
txt: true
uefi: true
raid: true
properties:
raid:
type: boolean
txt:
type: boolean
uefi:
type: boolean
type: object
Plan_specs_memory:
example:
total: total
properties:
total:
type: string
type: object
Plan_specs:
example:
features:
txt: true
uefi: true
raid: true
memory:
total: total
cpus:
- count: 6
type: type
- count: 6
type: type
drives:
- size: 3.84TB
count: 1
type: type
category: null
- size: 3.84TB
count: 1
type: type
category: null
nics:
- count: 2
type: type
- count: 2
type: type
properties:
cpus:
items:
$ref: '#/components/schemas/Plan_specs_cpus_inner'
type: array
memory:
$ref: '#/components/schemas/Plan_specs_memory'
drives:
items:
$ref: '#/components/schemas/Plan_specs_drives_inner'
type: array
nics:
items:
$ref: '#/components/schemas/Plan_specs_nics_inner'
type: array
features:
$ref: '#/components/schemas/Plan_specs_features'
type: object
findPlans_type_parameter:
enum:
- standard
- workload_optimized
- custom
example: standard
type: string
Plan_available_in_inner_price:
example:
hour: 1.23
properties:
hour:
example: 1.23
format: double
type: number
type: object
Plan:
example:
legacy: true
line: line
available_in_metros:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
description: description
available_in:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
type: null
specs:
features:
txt: true
uefi: true
raid: true
memory:
total: total
cpus:
- count: 6
type: type
- count: 6
type: type
drives:
- size: 3.84TB
count: 1
type: type
category: null
- size: 3.84TB
count: 1
type: type
category: null
nics:
- count: 2
type: type
- count: 2
type: type
deployment_types:
- null
- null
name: name
categories:
- categories
- categories
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
class: m3.large.x86
pricing: '{}'
slug: m3.large.x86
properties:
available_in:
description: Shows which facilities the plan is available in, and the facility-based price if it is different from the default price.
items:
$ref: '#/components/schemas/Plan_available_in_inner'
type: array
available_in_metros:
description: Shows which metros the plan is available in, and the metro-based price if it is different from the default price.
items:
$ref: '#/components/schemas/Plan_available_in_metros_inner'
type: array
categories:
description: Categories of the plan, like compute or storage. A Plan can belong to multiple categories.
items:
type: string
type: array
class:
example: m3.large.x86
type: string
description:
type: string
deployment_types:
items:
$ref: '#/components/schemas/Plan_deployment_types_inner'
minItems: 0
type: array
uniqueItems: true
id:
format: uuid
type: string
legacy:
description: Deprecated. Always return false
type: boolean
x-deprecated: true
line:
type: string
name:
type: string
pricing:
type: object
slug:
example: m3.large.x86
type: string
specs:
$ref: '#/components/schemas/Plan_specs'
type:
$ref: '#/components/schemas/Plan_type'
type: object
PlanList:
example:
plans:
- legacy: true
line: line
available_in_metros:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
description: description
available_in:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
type: null
specs:
features:
txt: true
uefi: true
raid: true
memory:
total: total
cpus:
- count: 6
type: type
- count: 6
type: type
drives:
- size: 3.84TB
count: 1
type: type
category: null
- size: 3.84TB
count: 1
type: type
category: null
nics:
- count: 2
type: type
- count: 2
type: type
deployment_types:
- null
- null
name: name
categories:
- categories
- categories
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
class: m3.large.x86
pricing: '{}'
slug: m3.large.x86
- legacy: true
line: line
available_in_metros:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
description: description
available_in:
- price:
hour: 1.23
href: href
- price:
hour: 1.23
href: href
type: null
specs:
features:
txt: true
uefi: true
raid: true
memory:
total: total
cpus:
- count: 6
type: type
- count: 6
type: type
drives:
- size: 3.84TB
count: 1
type: type
category: null
- size: 3.84TB
count: 1
type: type
category: null
nics:
- count: 2
type: type
- count: 2
type: type
deployment_types:
- null
- null
name: name
categories:
- categories
- categories
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
class: m3.large.x86
pricing: '{}'
slug: m3.large.x86
properties:
plans:
items:
$ref: '#/components/schemas/Plan'
type: array
type: object
Plan_specs_drives_inner:
example:
size: 3.84TB
count: 1
type: type
category: null
properties:
count:
type: integer
type:
type: string
size:
example: 3.84TB
type: string
category:
$ref: '#/components/schemas/Plan_specs_drives_inner_category'
type: object
Plan_deployment_types_inner:
enum:
- on_demand
- spot_market
type: string
Plan_specs_cpus_inner:
example:
count: 6
type: type
properties:
count:
type: integer
type:
type: string
type: object
Plan_specs_drives_inner_category:
enum:
- boot
- cache
- storage
type: string
Plan_available_in_inner:
example:
price:
hour: 1.23
href: href
properties:
href:
description: href to the Facility
type: string
price:
$ref: '#/components/schemas/Plan_available_in_inner_price'
type: object
Plan_type:
description: The plan type
enum:
- standard
- workload_optimized
- custom
type: string
Plan_available_in_metros_inner:
example:
price:
hour: 1.23
href: href
properties:
href:
description: href to the Metro
type: string
price:
$ref: '#/components/schemas/Plan_available_in_inner_price'
type: object
Plan_specs_nics_inner:
example:
count: 2
type: type
properties:
count:
example: 2
type: integer
type:
type: string
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
findOrganizationDevices_categories_parameter_inner:
enum:
- compute
- storage
- vmce
- legacy_gen
- current_gen
example: compute
type: string
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