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 IPAddresses API

Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device. Check out the product docs to learn more about [the basic networking features](https://metal.equinix.com/developers/docs/networking/standard-ips/).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

7 operations 4 paths 40 schemas 1 DELETE4 GET1 PATCH1 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
Contact
Equinix Metal API Team
License
Equinix Metal
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Packet Host IPAddresses 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 7

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

IPAddresses 7

Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device. Check out the product docs to learn more about [the bas…

DELETE
/ips/{id}
Unassign an ip address
deleteIPAddress 1 param → 204401403404
GET
/ips/{id}
Retrieve an ip address
findIPAddressById 3 params → 200401403404
PATCH
/ips/{id}
Update an ip address
updateIPAddress 3 params body → 200401403404
GET
/ips/{id}/available
Retrieve all available subnets of a particular reservation
findIPAvailabilities 2 params → 200401403404
GET
/ips/{id}/customdata
Retrieve the custom metadata of an IP Reservation or IP Assignment
findIPAddressCustomdata 1 param → 200401403404
GET
/projects/{id}/ips
Retrieve all ip reservations
findIPReservations 5 params → 200401403404
POST
/projects/{id}/ips
Requesting IP reservations
requestIPReservation 3 params body → 201401403404422

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are IPReservation (29 properties), VrfIpReservation (24 properties), User (22 properties), IPAssignment (20 properties). Each schema is shown below with its type and property counts.

IPReservation_metro
Project
object
19 properties
IPAssignment
object
20 properties
VrfVirtualCircuit
object
18 properties 1 required
Address
object
7 properties 3 required
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…
IPReservation_type
string
Meta
object
8 properties
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
ParentBlock
object
4 properties
VrfIpReservation
object
24 properties 2 required
IPReservationList
object
2 properties
IPReservationRequestInput
object
9 properties 2 required
Device_metro
IPReservation
object
29 properties 1 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.
Metro
object
4 properties
IPReservationList_ip_addresses_inner
VrfVirtualCircuit_status
string
The status changes of a VRF virtual circuit are generally the same as Virtual Circuits that aren't in a VRF. However, for VRF Virtual Circuits on Fabric VCs, t…
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.
Coordinates
object
2 properties
findIPAvailabilities_cidr_parameter
string
IPReservation_facility
findIPAddressById_200_response
Facility
object
7 properties
requestIPReservation_request
IPAssignment_type
string
User
object
22 properties
requestIPReservation_201_response
Href
object
1 property 1 required
Vrf
object
17 properties
Organization
object
17 properties
IPAvailabilitiesList
object
1 property
Facility_features_inner
string
IPAssignment_metro
IPAssignmentUpdateInput
object
3 properties
VrfIpReservationCreateInput
object
7 properties 4 required
VrfIpReservation_type
string
findIPReservations_types_parameter_inner
string
MetalGatewayLite
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

packet-host-ipaddresses-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 Devices 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
#IP Addresses
← Back to P APIs
API Details
ID
packet-host:packet-host-ipaddresses-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-ipaddresses-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/packet-host-ipaddresses-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 IPAddresses 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.