v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Database branch passwords

Renew a password

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 connect_production_branch, connect_production_read_only_branch, connect_branch

OAuth Scopes

ResourceScopes
Organizationmanage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Databasemanage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Branchmanage_passwords, manage_read_only_passwords
post/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew

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

idstring required

The ID of the password

Response

Returns the renewed password

idstring required

The ID for the password

namestring required

The display name for the password

role'reader' | 'writer' | 'admin' | 'readwriter' required

The role for the password

cidrsstring[] nullable required

List of IP addresses or CIDR ranges that can use this password

created_atstring required

When the password was created

deleted_atstring nullable required

When the password was deleted

expires_atstring nullable required

When the password will expire

last_used_atstring nullable required

When the password was last used to execute a query

expiredboolean required

True if the credentials are expired

direct_vtgateboolean required

True if the credentials connect directly to a vtgate, bypassing load balancers

direct_vtgate_addressesstring[] required

The list of hosts in each availability zone providing direct access to a vtgate

ttl_secondsinteger nullable required

Time to live (in seconds) for the password. The password will be invalid when TTL has passed

access_host_urlstring required

The host URL for the password

access_host_regional_urlstring required

The regional host URL

access_host_regional_urlsstring[] required

The read-only replica host URLs

usernamestring required

The username for the password

plain_textstring nullable required

The plaintext password. Null except in the response from the create endpoint.

replicaboolean required

Whether or not the password is for a read replica

renewableboolean required

Whether or not the password can be renewed