GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
passwords
List passwords
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/passwords \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "role": "reader",
      "cidrs": [
        "<string>"
      ],
      "created_at": "<string>",
      "deleted_at": "<string>",
      "expires_at": "<string>",
      "last_used_at": "<string>",
      "expired": true,
      "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
      },
      "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

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
number
default:1

If provided, specifies the page offset of returned results

per_page
number
default:25

If provided, specifies the number of returned results

Response

Returns passwords for the branch

current_page
number
required

The current page number

next_page
number
required

The next page number

next_page_url
string
required

The next page of results

prev_page
number
required

The previous page number

prev_page_url
string
required

The previous page of results

data
object[]
required