{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Secret Versions API", "version": "v1" }, "items": [ { "info": { "name": "Secret Versions", "type": "folder" }, "items": [ { "info": { "name": "Access a secret's version using the secret's name and path", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets-by-path/versions/:revision/access", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- an integer (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." }, { "name": "secret_path", "value": "", "type": "query", "description": "Secret's path." }, { "name": "secret_name", "value": "", "type": "query", "description": "Secret's name." }, { "name": "project_id", "value": "", "type": "query", "description": "ID of the Project to target. (UUID format)" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Access sensitive data in a secret's version specified by the `region`, `secret_name`, `secret_path` and `revision` parameters." }, { "info": { "name": "List versions of a secret using the secret's ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Filter results by status." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve the list of a given secret's versions specified by the `secret_id` and `region` parameters." }, { "info": { "name": "Create a version", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a version of a given secret specified by the `region` and `secret_id` parameters." }, { "info": { "name": "Get metadata of a secret's version using the secret's ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve the metadata of a secret's given version specified by the `region`, `secret_id` and `revision` parameters." }, { "info": { "name": "Update metadata of a version", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Edit the metadata of a secret's given version, specified by the `region`, `secret_id` and `revision` parameters." }, { "info": { "name": "Delete a version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone." }, { "info": { "name": "Access a secret's version using the secret's ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision/access", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters." }, { "info": { "name": "Disable a version", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision/disable", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Make a specific version inaccessible. You must specify the `region`, `secret_id` and `revision` parameters." }, { "info": { "name": "Enable a version", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/secret-manager/v1beta1/regions/:region/secrets/:secret_id/versions/:revision/enable", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "secret_id", "value": "", "type": "path", "description": "ID of the secret. (UUID format)" }, { "name": "revision", "value": "", "type": "path", "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:\n- a number (the revision number)\n- \"latest\" (the latest revision)\n- \"latest_enabled\" (the latest enabled revision)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Make a specific version accessible. You must specify the `region`, `secret_id` and `revision` parameters." } ] } ], "bundled": true }