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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Equinix

Equinix MetalGateways API

Metal Gateway Management.Check out the product docs to learn more about [Metal Gateways](https://metal.equinix.com/developers/docs/networking/metal-gateway/).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 6 operations across 3 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.

6 operations 3 paths 40 schemas 1 DELETE3 GET2 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
Contact
Equinix API Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 6

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

MetalGateways 6

Metal Gateway Management.Check out the product docs to learn more about [Metal Gateways](https://metal.equinix.com/developers/docs/networking/metal-gateway/).

DELETE
/metal-gateways/{id}
Deletes the metal gateway
deleteMetalGateway 3 params → 202401404
GET
/metal-gateways/{id}
Returns the metal gateway
findMetalGatewayById 3 params → 200401404
GET
/metal-gateways/{id}/ips
List Metal Gateway Elastic IPs
getMetalGatewayElasticIps 3 params → 200401404
POST
/metal-gateways/{id}/ips
Create a Metal Gateway Elastic IP
createMetalGatewayElasticIp 3 params body → 201401403404422
GET
/projects/{project_id}/metal-gateways
Returns all metal gateways for a project
findMetalGatewaysByProject 5 params → 200401404
POST
/projects/{project_id}/metal-gateways
Create a metal gateway
createMetalGateway 5 params body → 201401404422

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.

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
findMetalGatewayById_200_response
IPReservation_facility
VrfIpReservation
object
24 properties 2 required
Organization
object
17 properties
IPAssignment_metro
VrfMetalGatewayCreateInput
object
2 properties 2 required
Facility
object
7 properties
MetalGateway
object
9 properties
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
MetalGatewayElasticIpCreateInput
object
4 properties 2 required
MetalGatewayList_metal_gateways_inner
createMetalGateway_request
VrfMetalGateway
object
10 properties
VrfIpReservation_type
string
IPReservation_type
string
Facility_features_inner
string
Project
object
19 properties
IPAssignment_type
string
Coordinates
object
2 properties
VirtualNetwork
object
13 properties
User
object
22 properties
MetalGatewayCreateInput
object
3 properties 1 required
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.
MetalGatewayLite
object
7 properties
IPReservation_metro
IPAssignmentList
object
1 property
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
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
MetalGatewayList
object
2 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-metalgateways-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#MetalGateways
← Back to E APIs
API Details
ID
equinix:equinix-metalgateways-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network