{ "opencollection": "1.0.0", "info": { "name": "PlanetScale Platform Backups Passwords API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Passwords", "type": "folder" }, "items": [ { "info": { "name": "List passwords", "type": "http" }, "http": { "method": "GET", "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/passwords", "params": [ { "name": "organization", "value": "", "type": "path", "description": "The name of the organization." }, { "name": "database", "value": "", "type": "path", "description": "The name of the database." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch." }, { "name": "page", "value": "", "type": "query", "description": "The page number for pagination." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page." } ] }, "docs": "Returns a list of all passwords for a specific branch. Passwords are connection credentials used to connect to the branch." }, { "info": { "name": "Create a password", "type": "http" }, "http": { "method": "POST", "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/passwords", "params": [ { "name": "organization", "value": "", "type": "path", "description": "The name of the organization." }, { "name": "database", "value": "", "type": "path", "description": "The name of the database." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new password for a specific branch. The plaintext password is only returned once in the creation response." }, { "info": { "name": "Get a password", "type": "http" }, "http": { "method": "GET", "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/passwords/:password_id", "params": [ { "name": "organization", "value": "", "type": "path", "description": "The name of the organization." }, { "name": "database", "value": "", "type": "path", "description": "The name of the database." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch." }, { "name": "password_id", "value": "", "type": "path", "description": "The ID of the password." } ] }, "docs": "Returns details about a specific password. The plaintext password value is not included." }, { "info": { "name": "Delete a password", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/passwords/:password_id", "params": [ { "name": "organization", "value": "", "type": "path", "description": "The name of the organization." }, { "name": "database", "value": "", "type": "path", "description": "The name of the database." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch." }, { "name": "password_id", "value": "", "type": "path", "description": "The ID of the password." } ] }, "docs": "Deletes a password, revoking its access to the branch." }, { "info": { "name": "Renew a password", "type": "http" }, "http": { "method": "POST", "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/passwords/:password_id/renew", "params": [ { "name": "organization", "value": "", "type": "path", "description": "The name of the organization." }, { "name": "database", "value": "", "type": "path", "description": "The name of the database." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch." }, { "name": "password_id", "value": "", "type": "path", "description": "The ID of the password." } ] }, "docs": "Renews a password, extending its expiration time." } ] } ], "bundled": true }