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

List passwords

cURL

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/passwords \
  --header 'Authorization: Bearer <token>'

200

{
  "type": "<string>",
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "cidrs": [
        "<string>"
      ],
      "created_at": "<string>",
      "deleted_at": "<string>",
      "expires_at": "<string>",
      "last_used_at": "<string>",
      "expired": true,
      "direct_vtgate": true,
      "direct_vtgate_addresses": [
        "<string>"
      ],
      "ttl_seconds": 123,
      "access_host_url": "<string>",
      "access_host_regional_url": "<string>",
      "access_host_regional_urls": [
        "<string>"
      ],
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "region": {
        "id": "<string>",
        "provider": "<string>",
        "enabled": true,
        "public_ip_addresses": [
          "<string>"
        ],
        "display_name": "<string>",
        "location": "<string>",
        "slug": "<string>",
        "current_default": true,
        "mysql_supported": true,
        "postgresql_supported": true
      },
      "username": "<string>",
      "plain_text": "<string>",
      "replica": true,
      "renewable": true,
      "database_branch": {
        "name": "<string>",
        "id": "<string>",
        "production": true,
        "mysql_edge_address": "<string>",
        "private_edge_connectivity": true
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization · string · required

The name of the organization the password belongs to

database · string · required

The name of the database the password belongs to

branch · string · required

The name of the branch the password belongs to

Query Parameters

read_only_region_id · string

A read-only region of the database branch. If present, the password results will be filtered to only those in the region

page · integer · default: 1

If provided, specifies the page offset of returned results

per_page · integer · default: 25

If provided, specifies the number of returned results

Response

200

application/json

Returns passwords for the branch

type · string · required

The response type. Always "list" for paginated responses.

current_page · integer · required

The current page number

next_page · integer | null · required

The next page number, or null when this is the last page

next_page_url · string | null · required

The next page of results, or null when this is the last page

prev_page · integer | null · required

The previous page number, or null when this is the first page

prev_page_url · string | null · required

The previous page of results, or null when this is the first page

data · object[] · required

Show child attributes