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

VRF Management. A VRF is a project-scoped virtual router resource that defines a collection of customer-managed IP blocks that can be used in BGP peering on one or more virtual networks. Metal Gateways and Interconnection Virtual Circuits can take advantage of VRFs to enable Layer 3 routing with bespoke network ranges. Notice: VRFs are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 16 operations across 8 paths, and defines 34 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.

16 operations 8 paths 34 schemas 3 DELETE8 GET3 POST2 PUT

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 VRFs 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 16

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

VRFs 16

VRF Management. A VRF is a project-scoped virtual router resource that defines a collection of customer-managed IP blocks that can be used in BGP peering on one or more virtual ne…

DELETE
/bgp-dynamic-neighbors/{id}
Delete a VRF BGP Dynamic Neighbor
deleteBgpDynamicNeighborById 3 params → 202401403404
GET
/bgp-dynamic-neighbors/{id}
Retrieve a BGP Dynamic Neighbor
3 params → 200401404
GET
/metal-gateways/{id}/bgp-dynamic-neighbors
List BGP Dynamic Neighbors
getBgpDynamicNeighbors 3 params → 200401404
POST
/metal-gateways/{id}/bgp-dynamic-neighbors
Create a VRF BGP Dynamic Neighbor range
createBgpDynamicNeighbor 3 params body → 201401403404422
GET
/projects/{id}/vrfs
Retrieve all VRFs in the project
findVrfs 4 params → 200403404
POST
/projects/{id}/vrfs
Create a new VRF in the specified project
createVrf 3 params body → 201403404422
DELETE
/routes/{id}
Delete a VRF Route
deleteVrfRouteById 3 params → 202401403404
GET
/routes/{id}
Retrieve a VRF Route
findVrfRouteById 3 params → 200401404
PUT
/routes/{id}
Update a VRF Route
updateVrfRouteById 3 params body → 202401403404422429
DELETE
/vrfs/{id}
Delete the VRF
deleteVrf 1 param → 204401403404
GET
/vrfs/{id}
Retrieve a VRF
findVrfById 3 params → 200401403404
PUT
/vrfs/{id}
Update the VRF
updateVrf 3 params body → 200401403404422
GET
/vrfs/{id}/ips
Retrieve all VRF IP Reservations in the VRF
findVrfIpReservations 3 params → 200403404
GET
/vrfs/{vrf_id}/ips/{id}
Retrieve all VRF IP Reservations in the VRF
findVrfIpReservation 4 params → 200403404
GET
/vrfs/{id}/routes
Retrieve all routes in the VRF
getVrfRoutes 3 params → 200401404
POST
/vrfs/{id}/routes
Create a VRF route
createVrfRoute 3 params body → 200401403404422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are VrfIpReservation (24 properties), User (22 properties), Project (19 properties), VrfVirtualCircuit (18 properties). Each schema is shown below with its type and property counts.

Project
object
19 properties
VrfVirtualCircuit
object
18 properties 1 required
VrfRoute_type
string
VRF route type, like 'bgp', 'connected', and 'static'. Currently, only static routes are supported
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…
VirtualNetwork
object
13 properties
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
VrfMetalGateway
object
10 properties
BgpDynamicNeighborCreateInput
object
3 properties 2 required
VrfIpReservation
object
24 properties 2 required
VrfRouteList
object
2 properties
VrfRouteCreateInput
object
3 properties 2 required
Metro
object
4 properties
VrfList
object
1 property
UserLimited
object
5 properties 1 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…
VrfRoute_status
string
The status of the route. Potential values are "pending", "active", "deleting", and "error", representing various lifecycle states of the route and whether or n…
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
VrfRouteUpdateInput
object
3 properties
BgpDynamicNeighbor_state
string
BgpDynamicNeighborList
object
2 properties
VrfCreateInput
object
9 properties 2 required
User
object
22 properties
Href
object
1 property 1 required
Vrf
object
17 properties
Organization
object
17 properties
VrfRoute
object
12 properties
VrfUpdateInput
object
8 properties
BgpDynamicNeighbor
object
10 properties
VrfIpReservation_type
string
MetalGatewayLite
object
7 properties
VrfIpReservationList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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