GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
keyspaces
/
{name}
/
rollout-status
Get keyspace rollout status
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}/rollout-status \
  --header 'Authorization: <api-key>'
{
  "name": "<string>",
  "state": "<string>",
  "shards": [
    {
      "name": "<string>",
      "last_rollout_started_at": "<string>",
      "last_rollout_finished_at": "<string>",
      "state": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

The name of the organization the branch belongs to

database
string
required

The name of the database the branch belongs to

branch
string
required

The name of the branch

name
string
required

The name of the keyspace

Response

Returns information about a keyspace's rollout

name
string
required

The name of the keyspace

state
string
required

The current state of the rollout at the keyspace level

shards
object[]
required