{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List SSH Keys API", "version": "v1" }, "items": [ { "info": { "name": "SSH Keys", "type": "folder" }, "items": [ { "info": { "name": "List SSH keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Sort order of the SSH keys." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number. Value must be greater or equal to 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page. Value must be between 1 and 100." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter by Organization ID." }, { "name": "name", "value": "", "type": "query", "description": "Name of group to find." }, { "name": "project_id", "value": "", "type": "query", "description": "Filter by Project ID." }, { "name": "disabled", "value": "", "type": "query", "description": "Defines whether to include disabled SSH keys or not." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`." }, { "info": { "name": "Create an SSH key", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`." }, { "info": { "name": "Get an SSH key", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path", "description": "ID of the SSH key." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response." }, { "info": { "name": "Update an SSH key", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of an SSH key, including `name` and `disable`." }, { "info": { "name": "Delete an SSH key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/iam/v1alpha1/ssh-keys/:ssh_key_id", "params": [ { "name": "ssh_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key." } ] } ], "bundled": true }