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/).
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
deleteBgpSession1 param→ 204401403404
GET
/bgp/sessions/{id}
Retrieve a BGP session
findBgpSessionById2 params→ 200401403404
PUT
/bgp/sessions/{id}
Update the BGP session
updateBgpSession1 parambody→ 200401403404422
GET
/projects/{id}/bgp-config
Retrieve a bgp config
findBgpConfigByProject2 params→ 200401403404
POST
/projects/{id}/bgp-configs
Requesting bgp config
requestBgpConfig2 paramsbody→ 204401403404422
GET
/projects/{id}/bgp/sessions
Retrieve all BGP sessions for project
findProjectBgpSessions1 param→ 200401404
GET
/projects/{id}/global-bgp-ranges
Retrieve all global bgp ranges
findGlobalBgpRanges1 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.
BgpSession_address_family
string
BgpSession
object
9 properties1 required
BgpSessionList
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
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…
BgpConfig_status
string
Status of the BGP Config. Status "requested" is valid only with the "global" deploymenttype.
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…
BgpConfig
object
13 properties
GlobalBgpRange
object
5 properties
GlobalBgpRangeList
object
1 property
BgpConfigRequestInput
object
4 properties2 required
Href
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
