---
title: "Get the deploy queue"
method: GET
path: "/organizations/{organization}/databases/{database}/deploy-queue"
tags: ["Deploy requests"]
---

# Get the deploy queue

`GET /organizations/{organization}/databases/{database}/deploy-queue`

The deploy queue returns the current list of deploy requests in the order they will be deployed.

## Path parameters

- `organization` string, required
- `database` string, required

## Response `200`

Returns the deploy queue for a database

- object
  - `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
    - `id` string, required — The ID of the deployment
    - `auto_cutover` boolean, required — Whether or not to automatically cutover once deployment is finished
    - `auto_delete_branch` boolean, required — Whether or not to automatically delete the head branch once deployment is finished
    - `created_at` string, required — When the deployment was created
    - `cutover_at` string, required — When the cutover for the deployment was initiated
    - `cutover_expiring` boolean, required — Whether or not the deployment cutover will expire soon
    - `deploy_check_errors` string, required — Deploy check errors for the deployment
    - `finished_at` string, required — When the deployment was finished
    - `queued_at` string, required — When the deployment was queued
    - `ready_to_cutover_at` string, required — When the deployment was ready for cutover
    - `started_at` string, required — When the deployment was started
    - `state` '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', required — The state the deployment is in
    - `submitted_at` string, required — When the deployment was submitted
    - `updated_at` string, required — When the deployment was last updated
    - `into_branch` string, required — The name of the base branch the deployment will be merged into
    - `deploy_request_number` integer, required — The number of the deploy request associated with this deployment
    - `deployable` boolean, required — Whether the deployment is deployable
    - `preceding_deployments` object[], required — The deployments ahead of this one in the queue
    - `deploy_operations` object[], required
      - `id` string, required — The ID for the deploy operation
      - `state` 'pending' | 'queued' | 'in_progress' | 'complete' | 'cancelled' | 'error', required — The state of the deploy operation
      - `keyspace_name` string, required — The keyspace modified by the deploy operation
      - `table_name` string, required — The name of the table modifed by the deploy operation
      - `operation_name` string, required — The operation name of the deploy operation
      - `eta_seconds` number, required — The estimated seconds until completion for the deploy operation
      - `progress_percentage` number, required — The percent completion for the deploy operation
      - `deploy_error_docs_url` string, required — A link to documentation explaining the deploy error, if present
      - `ddl_statement` string, required — The DDL statement for the deploy operation
      - `syntax_highlighted_ddl` string, required — A syntax-highlighted DDL statement for the deploy operation
      - `created_at` string, required — When the deploy operation was created
      - `updated_at` string, required — When the deploy operation was last updated
      - `throttled_at` string, required — When the deploy operation was last throttled
      - `can_drop_data` boolean, required — Whether or not the deploy operation is capable of dropping data
      - `table_locked` boolean, required — Whether or not the table modified by the deploy operation is currently locked
      - `table_recently_used` boolean, required — Whether or not the table modified by the deploy operation was recently used
      - `table_recently_used_at` string, required — When the table modified by the deploy operation was last used
      - `removed_foreign_key_names` string[], required — Names of foreign keys removed by this operation
      - `deploy_errors` string, required — Deploy errors for the deploy operation
    - `deploy_operation_summaries` object[], required
      - `id` string, required — The ID for the deploy operation summary
      - `created_at` string, required — When the deploy operation summary was created
      - `deploy_errors` string, required — Deploy errors for the deploy operation summary
      - `ddl_statement` string, required — The DDL statement for the deploy operation summary
      - `eta_seconds` integer, required — The estimated seconds until completion for the deploy operation summary
      - `keyspace_name` string, required — The keyspace modified by the deploy operation summary
      - `operation_name` string, required — The operation name of the deploy operation summary
      - `progress_percentage` number, required — The percent completion for the deploy operation summary
      - `state` 'pending' | 'in_progress' | 'complete' | 'cancelled' | 'error', required — The state of the deploy operation summary
      - `syntax_highlighted_ddl` string, required — A syntax-highlighted DDL statement for the deploy operation summary
      - `table_name` string, required — The name of the table modifed by the deploy operation summary
      - `table_recently_used_at` string, required — When the table modified by the deploy operation summary was last used
      - `throttled_at` string, required — When the deploy operation summary was last throttled
      - `removed_foreign_key_names` string[], required — Names of foreign keys removed by this operation summary
      - `shard_count` integer, required — The number of shards in the keyspace modified by the deploy operation summary
      - `shard_names` string[], required — Names of shards in the keyspace modified by the deploy operation summary
      - `can_drop_data` boolean, required — Whether or not the deploy operation summary is capable of dropping data
      - `table_recently_used` boolean, required — Whether or not the table modified by the deploy operation summary was recently used
      - `sharded` boolean, required — Whether or not the keyspace modified by the deploy operation summary is sharded
      - `operations` object[], required
        - `id` string, required — The ID for the deploy operation
        - `shard` string, required — The shard the deploy operation is being performed on
        - `state` 'pending' | 'queued' | 'in_progress' | 'complete' | 'cancelled' | 'error', required — The state of the deploy operation
        - `progress_percentage` number, required — The percent completion for the deploy operation
        - `eta_seconds` integer, required — The estimated seconds until completion for the deploy operation
    - `lint_errors` object[], required — Schema lint errors preventing the deployment from completing
    - `sequential_diff_dependencies` object[], required — The schema dependencies that must be satisfied
    - `lookup_vindex_operations` object[], required — Lookup Vitess index operations
    - `throttler_configurations` object[], required — Deployment throttling configurations
    - `deployment_revert_request` object, required — The request to revert the schema operations in this deployment
    - `actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar
    - `cutover_actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar
    - `cancelled_actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar
    - `schema_last_updated_at` string, required — When the schema was last updated for the deployment
    - `table_locked` boolean, required — Whether or not the deployment has a table locked
    - `locked_table_name` string, required — The name of he table that is locked by the deployment
    - `instant_ddl` boolean, required — Whether or not the deployment is an instant DDL deployment
    - `instant_ddl_eligible` boolean, required — Whether or not the deployment is eligible for instant DDL

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/planetscale/apis/planetscale-api.md) · [All operations](https://skmtc.dev/planetscale/apis/planetscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/planetscale/planetscale-api/revisions/ed1825db11c6/schema)