{ "opencollection": "1.0.0", "info": { "name": "Metal Authentication SSHKeys API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "SSHKeys", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a device's ssh keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/devices/:id/ssh-keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" }, { "name": "Search string", "value": "", "type": "query", "description": "Search by key, label, or fingerprint" }, { "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 collection of the device's ssh keys." }, { "info": { "name": "Retrieve a project's ssh keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/projects/:id/ssh-keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "Project UUID" }, { "name": "query", "value": "", "type": "query", "description": "Search by key, label, or fingerprint" }, { "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 collection of the project's ssh keys." }, { "info": { "name": "Create a ssh key for the given project", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/metal/v1/projects/:id/ssh-keys", "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": "Creates a ssh key." }, { "info": { "name": "Retrieve all ssh keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/ssh-keys", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search by key, label, or fingerprint" }, { "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 collection of the user’s ssh keys." }, { "info": { "name": "Create a ssh key for the current user", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/metal/v1/ssh-keys", "params": [ { "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": "Creates a ssh key." }, { "info": { "name": "Retrieve a ssh key", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/metal/v1/ssh-keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "SSH Key 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 single ssh key if the user has access" }, { "info": { "name": "Update the ssh key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.equinix.com/metal/v1/ssh-keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "SSH Key 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": "Updates the ssh key." }, { "info": { "name": "Delete the ssh key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.equinix.com/metal/v1/ssh-keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ssh key UUID" } ] }, "docs": "Deletes the ssh key." } ] } ], "bundled": true }