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

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

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

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

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.0
API Version
1.0.0
Base URL
https://api.equinix.com/metal/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Packet Host MetalGateways 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 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.

MetalGatewayCreateInput
object
3 properties 1 required
IPReservation_metro
createMetalGateway_request
Project
object
19 properties
MetalGatewayList_metal_gateways_inner
IPAssignment
object
20 properties
VrfVirtualCircuit
object
18 properties 1 required
findMetalGatewayById_200_response
Address
object
7 properties 3 required
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…
Meta
object
8 properties
VirtualNetwork
object
13 properties
ParentBlock
object
4 properties
VrfMetalGateway
object
10 properties
IPReservation_type
string
VrfIpReservation
object
24 properties 2 required
Device_metro
MetalGatewayElasticIpCreateInput
object
4 properties 2 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.
IPReservation
object
29 properties 1 required
Metro
object
4 properties
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
IPReservation_facility
MetalGateway
object
9 properties
IPAssignmentList
object
1 property
Facility
object
7 properties
VrfMetalGatewayCreateInput
object
2 properties 2 required
IPAssignment_type
string
User
object
22 properties
Href
object
1 property 1 required
Vrf
object
17 properties
Organization
object
17 properties
IPAssignment_metro
Facility_features_inner
string
MetalGatewayList
object
2 properties
VrfIpReservation_type
string
MetalGatewayLite
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

packet-host-metalgateways-api-openapi.yml Raw ↑

Other APIs Packet Host publishes across the network.

Packet Host Authentication API
Packet Host Batches API
Packet Host BGP API
Packet Host Capacity API
Packet Host Console Log Details API
Packet Host Devices API
Packet Host Emails API
Packet Host Events API
Packet Host Facilities API
Packet Host Firmware Sets API
Packet Host HardwareReservations API
Packet Host Incidents API
Where this information came from

This is an independent, third-party profile of Packet Host MetalGateways 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.