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

Port ManagementCheck out the product docs to learn more about [Port configurations](https://metal.equinix.com/developers/docs/layer2-networking/overview/).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 14 operations across 12 paths, and defines 23 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.

14 operations 12 paths 23 schemas 1 DELETE5 GET8 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 Ports 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 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 5 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Ports 14

Port ManagementCheck out the product docs to learn more about [Port configurations](https://metal.equinix.com/developers/docs/layer2-networking/overview/).

GET
/ports/{id}
Retrieve a port
findPortById 2 params → 200401404
POST
/ports/{id}/assign
Assign a port to virtual network
assignPort 2 params body → 200401403404422
POST
/ports/{id}/bond
Enabling bonding
bondPort 3 params → 200401403404422
POST
/ports/{id}/convert/layer-2
Convert to Layer 2
convertLayer2 2 params body → 200401403404422
POST
/ports/{id}/convert/layer-3
Convert to Layer 3
convertLayer3 2 params body → 200401403404422
POST
/ports/{id}/disbond
Disabling bonding
disbondPort 3 params → 200401403404422
DELETE
/ports/{id}/native-vlan
Remove native VLAN
deleteNativeVlan 2 params → 200401404422
POST
/ports/{id}/native-vlan
Assign a native VLAN
assignNativeVlan 3 params → 200401404422
POST
/ports/{id}/unassign
Unassign a port
unassignPort 2 params body → 200401403404422
GET
/ports/{id}/vlan-assignments
List Current VLAN assignments for a port
findPortVlanAssignments 2 params → 200401403404
GET
/ports/{id}/vlan-assignments/{assignment_id}
Show a particular Port VLAN assignment's details
findPortVlanAssignmentByPortIdAndAssignmentId 3 params → 200401403404
GET
/ports/{id}/vlan-assignments/batches
List the VLAN Assignment Batches for a port
findPortVlanAssignmentBatches 1 param → 200401403404
POST
/ports/{id}/vlan-assignments/batches
Create a new Port-VLAN Assignment management batch
createPortVlanAssignmentBatch 2 params body → 201401403404422
GET
/ports/{id}/vlan-assignments/batches/{batch_id}
Retrieve a VLAN Assignment Batch's details
findPortVlanAssignmentBatchByPortIdAndBatchId 3 params → 200401403404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are VirtualNetwork (13 properties), Port (10 properties), PortVlanAssignmentBatch (9 properties), PortVlanAssignment (8 properties). Each schema is shown below with its type and property counts.

PortVlanAssignmentBatchCreateInput_vlan_assignments_inner
object
3 properties
PortVlanAssignmentList
object
1 property
PortAssignInput
object
1 property
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…
VirtualNetwork
object
13 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
PortConvertLayer3Input
object
1 property
PortVlanAssignmentBatchCreateInput
object
1 property
Port_network_type
string
Composite network type of the bond
Port_type
string
Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports
PortVlanAssignmentBatch_vlan_assignments_inner_state
string
PortVlanAssignmentBatch
object
9 properties
Port
object
Port is a hardware port associated with a reserved or instantiated hardware device.
10 properties
PortData
object
2 properties
PortVlanAssignmentBatch_vlan_assignments_inner
object
4 properties
PortVlanAssignmentBatchList
object
1 property
PortVlanAssignmentBatch_state
string
Href
object
1 property 1 required
BondPortData
object
2 properties
PortVlanAssignment_state
string
PortVlanAssignment
object
8 properties
MetalGatewayLite
object
7 properties
PortConvertLayer3Input_request_ips_inner
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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