List deploy operations

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/deploy-requests/{number}/operations \
  --header 'Authorization: <api-key>'

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "state": "pending",
      "keyspace_name": "<string>",
      "table_name": "<string>",
      "operation_name": "<string>",
      "eta_seconds": 123,
      "progress_percentage": 123,
      "deploy_error_docs_url": "<string>",
      "ddl_statement": "<string>",
      "syntax_highlighted_ddl": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "throttled_at": "<string>",
      "can_drop_data": true,
      "table_locked": true,
      "table_recently_used": true,
      "table_recently_used_at": "<string>",
      "removed_foreign_key_names": [
        "<string>"
      ],
      "deploy_errors": "<string>"
    }
  ]
}

Deploy requests

List deploy operations

List deploy operations for a deploy request

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_deploy_request

OAuth Scopes

Resource	Scopes
Organization	`read_deploy_requests`
Database	`read_deploy_requests`

GET

organizations

{organization}

databases

{database}

deploy-requests

{number}

operations

List deploy operations

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/deploy-requests/{number}/operations \
  --header 'Authorization: <api-key>'

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "state": "pending",
      "keyspace_name": "<string>",
      "table_name": "<string>",
      "operation_name": "<string>",
      "eta_seconds": 123,
      "progress_percentage": 123,
      "deploy_error_docs_url": "<string>",
      "ddl_statement": "<string>",
      "syntax_highlighted_ddl": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "throttled_at": "<string>",
      "can_drop_data": true,
      "table_locked": true,
      "table_recently_used": true,
      "table_recently_used_at": "<string>",
      "removed_foreign_key_names": [
        "<string>"
      ],
      "deploy_errors": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

number

integer

required

The number of the deploy request

organization

string

required

The name of the deploy request's organization

database

string

required

The name of the deploy request's database

Query Parameters

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

Returns deploy operations for the deploy request

current_page

integer

required

The current page number

next_page

integer

required

The next page number

next_page_url

string

required

The next page of results

prev_page

integer

required

The previous page number

prev_page_url

string

required

The previous page of results

data

object[]

required

Show child attributes

data.id

string

required

The ID for the deploy operation

data.state

enum<string>

required

The state of the deploy operation

Available options:

pending,

queued,

in_progress,

complete,

cancelled,

error

data.keyspace_name

string

required

The keyspace modified by the deploy operation

data.table_name

string

required

The name of the table modifed by the deploy operation

data.operation_name

string

required

The operation name of the deploy operation

data.eta_seconds

number

required

The estimated seconds until completion for the deploy operation

data.progress_percentage

number

required

The percent completion for the deploy operation

data.deploy_error_docs_url

string

required

A link to documentation explaining the deploy error, if present

data.ddl_statement

string

required

The DDL statement for the deploy operation

data.syntax_highlighted_ddl

string

required

A syntax-highlighted DDL statement for the deploy operation

data.created_at

string

required

When the deploy operation was created

data.updated_at

string

required

When the deploy operation was last updated

data.throttled_at

string

required

When the deploy operation was last throttled

data.can_drop_data

boolean

required

Whether or not the deploy operation is capable of dropping data

data.table_locked

boolean

required

Whether or not the table modified by the deploy operation is currently locked

data.table_recently_used

boolean

required

Whether or not the table modified by the deploy operation was recently used

data.table_recently_used_at

string

required

When the table modified by the deploy operation was last used

data.removed_foreign_key_names

string[]

required

Names of foreign keys removed by this operation

data.deploy_errors

string

required

Deploy errors for the deploy operation

Get a deployment

Complete a revert

⌘I

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Vitess API endpoints

List deploy operations

Authorization

Authorizations

Path Parameters

Query Parameters

Response