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

Equinix VRFs API is one of 74 APIs that Equinix 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 API documentation.

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

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

BgpDynamicNeighbor_state
string
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
BgpDynamicNeighborCreateInput
object
3 properties 2 required
VrfRouteCreateInput
object
3 properties 2 required
VrfRoute
object
12 properties
VrfVirtualCircuit
object
18 properties 1 required
Address
object
7 properties 3 required
VrfRouteUpdateInput
object
3 properties
UserLimited
object
5 properties 1 required
VrfIpReservation
object
24 properties 2 required
Organization
object
17 properties
VrfRouteList
object
2 properties
Vrf
object
17 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.
VrfRoute_type
string
VRF route type, like 'bgp', 'connected', and 'static'. Currently, only static routes are supported
VrfMetalGateway
object
10 properties
VrfIpReservation_type
string
Project
object
19 properties
VrfUpdateInput
object
8 properties
Coordinates
object
2 properties
VrfCreateInput
object
9 properties 2 required
VirtualNetwork
object
13 properties
User
object
22 properties
VrfIpReservationList
object
1 property
BgpDynamicNeighbor
object
10 properties
Metro
object
4 properties
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…
MetalGatewayLite
object
7 properties
VrfList
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…
BgpDynamicNeighborList
object
2 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-vrfs-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
#VRFs
← Back to E APIs
API Details
ID
equinix:equinix-vrfs-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