Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
roles
/
{id}
Get a role
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "access_host_url": "<string>",
  "private_access_host_url": "<string>",
  "private_connection_service_name": "<string>",
  "username": "<string>",
  "password": "<string>",
  "database_name": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "deleted_at": "<string>",
  "expires_at": "<string>",
  "dropped_at": "<string>",
  "disabled_at": "<string>",
  "drop_failed": "<string>",
  "expired": true,
  "default": true,
  "ttl": 123,
  "inherited_roles": [
    "pscale_managed"
  ],
  "branch": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization that owns this resource

​
database
string
required

The name of the database that owns this resource

​
branch
string
required

The name of the branch that owns this resource

​
id
string
required

The ID of the role

Response

Returns a role

​
id
string
required

The ID of the role

​
name
string
required

The name of the role

​
access_host_url
string
required

The database connection string

​
private_access_host_url
string
required

The database connection string for private connections

​
private_connection_service_name
string
required

The service name to set up private connectivity

​
username
string
required

The database user name

​
password
string
required

The plain text password, available only after create

​
database_name
string
required

The database name

​
created_at
string
required

When the role was created

​
updated_at
string
required

When the role was updated

​
deleted_at
string
required

When the role was deleted

​
expires_at
string
required

When the role expires

​
dropped_at
string
required

When the role was dropped

​
disabled_at
string
required

When the role was disabled

​
drop_failed
string
required

Error message available when dropping the role fails

​
expired
boolean
required

True if the credentials are expired

​
default
boolean
required

Whether the role is the default postgres user

​
ttl
integer
required

Number of seconds before the credentials expire

​
inherited_roles
enum<string>[]
required

Database roles these credentials inherit

Available options:
pscale_managed,
pg_checkpoint,
pg_create_subscription,
pg_maintain,
pg_monitor,
pg_read_all_data,
pg_read_all_settings,
pg_read_all_stats,
pg_signal_backend,
pg_stat_scan_tables,
pg_use_reserved_connections,
pg_write_all_data,
postgres
​
branch
object
required
​
actor
object
required