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

Manage BGP configs and sessions. See device endpoints to create and list BGP sessions for a particular device. Check out the product docs to learn more about [Local and Global BGP](https://metal.equinix.com/developers/docs/networking/local-global-bgp/).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

7 operations 5 paths 12 schemas 1 DELETE4 GET1 POST1 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 BGP 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 7

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

BGP 7

Manage BGP configs and sessions. See device endpoints to create and list BGP sessions for a particular device. Check out the product docs to learn more about [Local and Global BGP…

DELETE
/bgp/sessions/{id}
Delete the BGP session
deleteBgpSession 1 param → 204401403404
GET
/bgp/sessions/{id}
Retrieve a BGP session
findBgpSessionById 2 params → 200401403404
PUT
/bgp/sessions/{id}
Update the BGP session
updateBgpSession 1 param body → 200401403404422
GET
/projects/{id}/bgp-config
Retrieve a bgp config
findBgpConfigByProject 2 params → 200401403404
POST
/projects/{id}/bgp-configs
Requesting bgp config
requestBgpConfig 2 params body → 204401403404422
GET
/projects/{id}/bgp/sessions
Retrieve all BGP sessions for project
findProjectBgpSessions 1 param → 200401404
GET
/projects/{id}/global-bgp-ranges
Retrieve all global bgp ranges
findGlobalBgpRanges 1 param → 200401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are BgpConfig (13 properties), BgpSession (9 properties), GlobalBgpRange (5 properties), BgpConfigRequestInput (4 properties). Each schema is shown below with its type and property counts.

BgpConfig_status
string
Status of the BGP Config. Status "requested" is valid only with the "global" deploymenttype.
Href
object
1 property 1 required
BgpConfig
object
13 properties
BgpConfigRequestInput_deployment_type
string
Wether the BGP deployment is local or global. Local deployments are configured immediately. Global deployments will need to be reviewed by Equinix Metal engine…
GlobalBgpRange
object
5 properties
BgpSession
object
9 properties 1 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
BgpSessionList
object
1 property
BgpConfigRequestInput
object
4 properties 2 required
BgpConfig_deployment_type
string
In a Local BGP deployment, a customer uses an internal ASN to control routes within a single Equinix Metal datacenter. This means that the routes are never adv…
GlobalBgpRangeList
object
1 property
BgpSession_address_family
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

packet-host-bgp-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 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
Packet Host Interconnections API
AE Profile APIs.io
#BGP
← Back to P APIs
API Details
ID
packet-host:packet-host-bgp-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-bgp-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/packet-host-bgp-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 BGP 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.