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

Equinix IPAddresses API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IPAddresses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

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.

IPReservationList
object
2 properties
VrfIpReservationCreateInput
object
7 properties 4 required
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…
Meta
object
8 properties
VrfVirtualCircuit
object
18 properties 1 required
Address
object
7 properties 3 required
IPAssignment
object
20 properties
ParentBlock
object
4 properties
findIPAddressById_200_response
IPReservation_facility
IPAssignmentUpdateInput
object
3 properties
VrfIpReservation
object
24 properties 2 required
Organization
object
17 properties
IPAssignment_metro
Facility
object
7 properties
IPAvailabilitiesList
object
1 property
IPReservationList_ip_addresses_inner
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.
Vrf
object
17 properties
VrfIpReservation_type
string
IPReservation_type
string
Facility_features_inner
string
requestIPReservation_request
Project
object
19 properties
IPAssignment_type
string
IPReservationRequestInput
object
9 properties 2 required
Coordinates
object
2 properties
User
object
22 properties
requestIPReservation_201_response
findIPAvailabilities_cidr_parameter
string
MetalGatewayLite
object
7 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
Metro
object
4 properties
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.
IPReservation_metro
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
object
29 properties 1 required
Device_metro
findIPReservations_types_parameter_inner
string
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-ipaddresses-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 Batches 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