Database branch passwords
List passwords
Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_production_read_only_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords |
| Database | manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords |
| Branch | manage_passwords, manage_read_only_passwords |
get/organizations/{organization}/databases/{database}/branches/{branch}/passwords
Path parameters
organizationstring required
The name of the organization the password belongs to
databasestring required
The name of the database the password belongs to
branchstring required
The name of the branch the password belongs to
Query parameters
read_only_region_idstring
A read-only region of the database branch. If present, the password results will be filtered to only those in the region
statusstring
Filter passwords by status
qstring
Search passwords by name
pageinteger
If provided, specifies the page offset of returned results
per_pageinteger
If provided, specifies the number of returned results
Response
Returns passwords for the branch