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

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/deploy-requests/{number}/operations \
  --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>",
      "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

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

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

200

application/json

Returns deploy operations for the deploy request

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