Get the deploy queue

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "auto_cutover": true,
      "auto_delete_branch": true,
      "created_at": "<string>",
      "cutover_at": "<string>",
      "cutover_expiring": true,
      "deploy_check_errors": "<string>",
      "finished_at": "<string>",
      "queued_at": "<string>",
      "ready_to_cutover_at": "<string>",
      "started_at": "<string>",
      "state": "pending",
      "submitted_at": "<string>",
      "updated_at": "<string>",
      "into_branch": "<string>",
      "deploy_request_number": 123,
      "deployable": true,
      "preceding_deployments": [
        {}
      ],
      "deploy_operations": [
        {
          "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_operation_summaries": [
        {
          "id": "<string>",
          "created_at": "<string>",
          "deploy_errors": "<string>",
          "ddl_statement": "<string>",
          "eta_seconds": 123,
          "keyspace_name": "<string>",
          "operation_name": "<string>",
          "progress_percentage": 123,
          "state": "pending",
          "syntax_highlighted_ddl": "<string>",
          "table_name": "<string>",
          "table_recently_used_at": "<string>",
          "throttled_at": "<string>",
          "removed_foreign_key_names": [
            "<string>"
          ],
          "shard_count": 123,
          "shard_names": [
            "<string>"
          ],
          "can_drop_data": true,
          "table_recently_used": true,
          "sharded": true,
          "operations": [
            {
              "id": "<string>",
              "shard": "<string>",
              "state": "pending",
              "progress_percentage": 123,
              "eta_seconds": 123
            }
          ]
        }
      ],
      "lint_errors": [
        {}
      ],
      "sequential_diff_dependencies": [
        {}
      ],
      "lookup_vindex_operations": [
        {}
      ],
      "throttler_configurations": [
        {}
      ],
      "deployment_revert_request": {},
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "cutover_actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "cancelled_actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "schema_last_updated_at": "<string>",
      "table_locked": true,
      "locked_table_name": "<string>",
      "instant_ddl": true,
      "instant_ddl_eligible": true
    }
  ]
}

GET

organizations

{organization}

databases

{database}

deploy-queue

Get the deploy queue

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "auto_cutover": true,
      "auto_delete_branch": true,
      "created_at": "<string>",
      "cutover_at": "<string>",
      "cutover_expiring": true,
      "deploy_check_errors": "<string>",
      "finished_at": "<string>",
      "queued_at": "<string>",
      "ready_to_cutover_at": "<string>",
      "started_at": "<string>",
      "state": "pending",
      "submitted_at": "<string>",
      "updated_at": "<string>",
      "into_branch": "<string>",
      "deploy_request_number": 123,
      "deployable": true,
      "preceding_deployments": [
        {}
      ],
      "deploy_operations": [
        {
          "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_operation_summaries": [
        {
          "id": "<string>",
          "created_at": "<string>",
          "deploy_errors": "<string>",
          "ddl_statement": "<string>",
          "eta_seconds": 123,
          "keyspace_name": "<string>",
          "operation_name": "<string>",
          "progress_percentage": 123,
          "state": "pending",
          "syntax_highlighted_ddl": "<string>",
          "table_name": "<string>",
          "table_recently_used_at": "<string>",
          "throttled_at": "<string>",
          "removed_foreign_key_names": [
            "<string>"
          ],
          "shard_count": 123,
          "shard_names": [
            "<string>"
          ],
          "can_drop_data": true,
          "table_recently_used": true,
          "sharded": true,
          "operations": [
            {
              "id": "<string>",
              "shard": "<string>",
              "state": "pending",
              "progress_percentage": 123,
              "eta_seconds": 123
            }
          ]
        }
      ],
      "lint_errors": [
        {}
      ],
      "sequential_diff_dependencies": [
        {}
      ],
      "lookup_vindex_operations": [
        {}
      ],
      "throttler_configurations": [
        {}
      ],
      "deployment_revert_request": {},
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "cutover_actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "cancelled_actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "schema_last_updated_at": "<string>",
      "table_locked": true,
      "locked_table_name": "<string>",
      "instant_ddl": true,
      "instant_ddl_eligible": true
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

organization

string

required

The name of the deploy request's organization

database

string

required

The name of the deploy request's database

Response

Returns the deploy queue for a database

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 of the deployment

data.auto_cutover

boolean

required

Whether or not to automatically cutover once deployment is finished

data.auto_delete_branch

boolean

required

Whether or not to automatically delete the head branch once deployment is finished

data.created_at

string

required

When the deployment was created

data.cutover_at

string

required

When the cutover for the deployment was initiated

data.cutover_expiring

boolean

required

Whether or not the deployment cutover will expire soon

data.deploy_check_errors

string

required

Deploy check errors for the deployment

data.finished_at

string

required

When the deployment was finished

data.queued_at

string

required

When the deployment was queued

data.ready_to_cutover_at

string

required

When the deployment was ready for cutover

data.started_at

string

required

When the deployment was started

data.state

enum<string>

required

The state the deployment is in

Available options:

pending,

ready,

no_changes,

queued,

submitting,

in_progress,

pending_cutover,

in_progress_vschema,

in_progress_cancel,

in_progress_cutover,

complete,

complete_cancel,

complete_error,

complete_pending_revert,

in_progress_revert,

in_progress_revert_vschema,

complete_revert,

complete_revert_error,

cancelled,

error

data.submitted_at

string

required

When the deployment was submitted

data.updated_at

string

required

When the deployment was last updated

data.into_branch

string

required

The name of the base branch the deployment will be merged into

data.deploy_request_number

integer

required

The number of the deploy request associated with this deployment

data.deployable

boolean

required

Whether the deployment is deployable

data.preceding_deployments

object[]

required

The deployments ahead of this one in the queue

data.deploy_operations

object[]

required

Show child attributes

data.deploy_operations.id

string

required

The ID for the deploy operation

data.deploy_operations.state

enum<string>

required

The state of the deploy operation

Available options:

pending,

queued,

in_progress,

complete,

cancelled,

error

data.deploy_operations.keyspace_name

string

required

The keyspace modified by the deploy operation

data.deploy_operations.table_name

string

required

The name of the table modifed by the deploy operation

data.deploy_operations.operation_name

string

required

The operation name of the deploy operation

data.deploy_operations.eta_seconds

number

required

The estimated seconds until completion for the deploy operation

data.deploy_operations.progress_percentage

number

required

The percent completion for the deploy operation

data.deploy_operations.deploy_error_docs_url

string

required

A link to documentation explaining the deploy error, if present

data.deploy_operations.ddl_statement

string

required

The DDL statement for the deploy operation

data.deploy_operations.syntax_highlighted_ddl

string

required

A syntax-highlighted DDL statement for the deploy operation

data.deploy_operations.created_at

string

required

When the deploy operation was created

data.deploy_operations.updated_at

string

required

When the deploy operation was last updated

data.deploy_operations.throttled_at

string

required

When the deploy operation was last throttled

data.deploy_operations.can_drop_data

boolean

required

Whether or not the deploy operation is capable of dropping data

data.deploy_operations.table_locked

boolean

required

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

data.deploy_operations.table_recently_used

boolean

required

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

data.deploy_operations.table_recently_used_at

string

required

When the table modified by the deploy operation was last used

data.deploy_operations.removed_foreign_key_names

string[]

required

Names of foreign keys removed by this operation

data.deploy_operations.deploy_errors

string

required

Deploy errors for the deploy operation

data.deploy_operation_summaries

object[]

required

Show child attributes

data.deploy_operation_summaries.id

string

required

The ID for the deploy operation summary

data.deploy_operation_summaries.created_at

string

required

When the deploy operation summary was created

data.deploy_operation_summaries.deploy_errors

string

required

Deploy errors for the deploy operation summary

data.deploy_operation_summaries.ddl_statement

string

required

The DDL statement for the deploy operation summary

data.deploy_operation_summaries.eta_seconds

integer

required

The estimated seconds until completion for the deploy operation summary

data.deploy_operation_summaries.keyspace_name

string

required

The keyspace modified by the deploy operation summary

data.deploy_operation_summaries.operation_name

string

required

The operation name of the deploy operation summary

data.deploy_operation_summaries.progress_percentage

number

required

The percent completion for the deploy operation summary

data.deploy_operation_summaries.state

enum<string>

required

The state of the deploy operation summary

Available options:

pending,

in_progress,

complete,

cancelled,

error

data.deploy_operation_summaries.syntax_highlighted_ddl

string

required

A syntax-highlighted DDL statement for the deploy operation summary

data.deploy_operation_summaries.table_name

string

required

The name of the table modifed by the deploy operation summary

data.deploy_operation_summaries.table_recently_used_at

string

required

When the table modified by the deploy operation summary was last used

data.deploy_operation_summaries.throttled_at

string

required

When the deploy operation summary was last throttled

data.deploy_operation_summaries.removed_foreign_key_names

string[]

required

Names of foreign keys removed by this operation summary

data.deploy_operation_summaries.shard_count

integer

required

The number of shards in the keyspace modified by the deploy operation summary

data.deploy_operation_summaries.shard_names

string[]

required

Names of shards in the keyspace modified by the deploy operation summary

data.deploy_operation_summaries.can_drop_data

boolean

required

Whether or not the deploy operation summary is capable of dropping data

data.deploy_operation_summaries.table_recently_used

boolean

required

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

data.deploy_operation_summaries.sharded

boolean

required

Whether or not the keyspace modified by the deploy operation summary is sharded

data.deploy_operation_summaries.operations

object[]

required

Show child attributes

data.deploy_operation_summaries.operations.id

string

required

The ID for the deploy operation

data.deploy_operation_summaries.operations.shard

string

required

The shard the deploy operation is being performed on

data.deploy_operation_summaries.operations.state

enum<string>

required

The state of the deploy operation

Available options:

pending,

queued,

in_progress,

complete,

cancelled,

error

data.deploy_operation_summaries.operations.progress_percentage

number

required

The percent completion for the deploy operation

data.deploy_operation_summaries.operations.eta_seconds

integer

required

The estimated seconds until completion for the deploy operation

data.lint_errors

object[]

required

Schema lint errors preventing the deployment from completing

data.sequential_diff_dependencies

object[]

required

The schema dependencies that must be satisfied

data.lookup_vindex_operations

object[]

required

Lookup Vitess index operations

data.throttler_configurations

object[]

required

Deployment throttling configurations

data.deployment_revert_request

object

required

The request to revert the schema operations in this deployment

data.actor

object

required

Show child attributes

data.actor.id

string

required

The ID of the actor

data.actor.display_name

string

required

The name of the actor

data.actor.avatar_url

string

required

The URL of the actor's avatar

data.cutover_actor

object

required

Show child attributes

data.cutover_actor.id

string

required

The ID of the actor

data.cutover_actor.display_name

string

required

The name of the actor

data.cutover_actor.avatar_url

string

required

The URL of the actor's avatar

data.cancelled_actor

object

required

Show child attributes

data.cancelled_actor.id

string

required

The ID of the actor

data.cancelled_actor.display_name

string

required

The name of the actor

data.cancelled_actor.avatar_url

string

required

The URL of the actor's avatar

data.schema_last_updated_at

string

required

When the schema was last updated for the deployment

data.table_locked

boolean

required

Whether or not the deployment has a table locked

data.locked_table_name

string

required

The name of he table that is locked by the deployment

data.instant_ddl

boolean

required

Whether or not the deployment is an instant DDL deployment

data.instant_ddl_eligible

boolean

required

Whether or not the deployment is eligible for instant DDL

Update database throttler configurations

List deploy requests

⌘I

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Vitess API endpoints

Get the deploy queue

Authorizations

Path Parameters

Response