{ "opencollection": "1.0.0", "info": { "name": "Equinix API Authentication MetalGateways API", "version": "1.2" }, "items": [ { "info": { "name": "MetalGateways", "type": "folder" }, "items": [ { "info": { "name": "Returns the metal gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal-gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Metal Gateway 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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ] }, "docs": "Returns a specific metal gateway" }, { "info": { "name": "Deletes the metal gateway", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.equinix.com/metal-gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Metal Gateway 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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ] }, "docs": "Deletes a metal gateway and any elastic IP assignments associated with this metal gateway." }, { "info": { "name": "List Metal Gateway Elastic IPs", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal-gateways/:id/ips", "params": [ { "name": "id", "value": "", "type": "path", "description": "Metal Gateway 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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ] }, "docs": "Returns the list of Elastic IPs assigned to this Metal Gateway" }, { "info": { "name": "Create a Metal Gateway Elastic IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/metal-gateways/:id/ips", "params": [ { "name": "id", "value": "", "type": "path", "description": "Metal Gateway 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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Elastic IP on this Metal Gateway.\n\nAssign an IPv4 range as an elastic IP to the Metal Gateway, with a specified next-hop address contained within the Metal Gateway.\n\nNotice: Elastic IPs on Metal Gateways are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.\n" }, { "info": { "name": "Returns all metal gateways for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/projects/:project_id/metal-gateways", "params": [ { "name": "project_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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." }, { "name": "page", "value": "", "type": "query", "description": "Page to return" }, { "name": "per_page", "value": "", "type": "query", "description": "Items returned per page" } ] }, "docs": "Return all metal gateways for a project" }, { "info": { "name": "Create a metal gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/projects/:project_id/metal-gateways", "params": [ { "name": "project_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." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." }, { "name": "page", "value": "", "type": "query", "description": "Page to return" }, { "name": "per_page", "value": "", "type": "query", "description": "Items returned per page" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a metal gateway in a project" } ] } ], "bundled": true }