{ "opencollection": "1.0.0", "info": { "name": "Metal Authentication BGP API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "BGP", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a BGP session", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/bgp/sessions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "BGP session UUID" }, { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." } ] }, "docs": "Returns a BGP session" }, { "info": { "name": "Update the BGP session", "type": "http" }, "http": { "method": "PUT", "url": "https://api.equinix.com/metal/v1/bgp/sessions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "BGP session UUID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the BGP session by either enabling or disabling the default route functionality." }, { "info": { "name": "Delete the BGP session", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.equinix.com/metal/v1/bgp/sessions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "BGP session UUID" } ] }, "docs": "Deletes the BGP session." }, { "info": { "name": "Retrieve a bgp config", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/projects/:id/bgp-config", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" }, { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." } ] }, "docs": "Returns a bgp config" }, { "info": { "name": "Requesting bgp config", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/metal/v1/projects/:id/bgp-configs", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" }, { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requests to enable bgp configuration for a project." }, { "info": { "name": "Retrieve all BGP sessions for project", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/projects/:id/bgp/sessions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" } ] }, "docs": "Provides a listing of available BGP sessions for the project." }, { "info": { "name": "Retrieve all global bgp ranges", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/projects/:id/global-bgp-ranges", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" } ] }, "docs": "Returns all global bgp ranges for a project" } ] } ], "bundled": true }