Sign in

v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Deploy requests

Get a deployment

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

ResourceScopes
Organizationread_deploy_requests
Databaseread_deploy_requests
get/organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment

Path parameters

organizationstring required

The name of the deploy request's organization

databasestring required

The name of the deploy request's database

numberinteger required

The number of the deploy request

Response

Returns the deployment for a deploy request

idstring required

The ID of the deployment

auto_cutoverboolean required

Whether or not to automatically cutover once deployment is finished

auto_delete_branchboolean required

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

created_atstring required

When the deployment was created

cutover_atstring nullable required

When the cutover for the deployment was initiated

cutover_expiringboolean required

Whether or not the deployment cutover will expire soon

deploy_check_errorsstring nullable

Deploy check errors for the deployment.

finished_atstring nullable required

When the deployment was finished

force_cutover_requested_atstring nullable required

When force cutover was triggered for the deployment

queued_atstring nullable required

When the deployment was queued

ready_to_cutover_atstring nullable required

When the deployment was ready for cutover

started_atstring nullable 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_atstring nullable required

When the deployment was submitted

updated_atstring required

When the deployment was last updated

into_branchstring required

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

deploy_request_numberinteger required

The number of the deploy request associated with this deployment

deployableboolean required

Whether the deployment is deployable

preceding_deploymentsobject[] required

The deployments ahead of this one in the queue

lint_errorsobject[] required

Schema lint errors preventing the deployment from completing

sequential_diff_dependenciesobject[] required

The schema dependencies that must be satisfied

lookup_vindex_operationsobject[] required

Lookup Vitess index operations

throttler_configurationsobject nullable

Deployment throttling configurations.

deployment_revert_requestobject nullable required

The request to revert the schema operations in this deployment

schema_last_updated_atstring nullable required

When the schema was last updated for the deployment

table_lockedboolean required

Whether or not the deployment has a table locked

locked_table_namestring nullable

The name of the table that is locked by the deployment.

instant_ddlboolean required

Whether or not the deployment is an instant DDL deployment

instant_ddl_eligibleboolean required

Whether or not the deployment is eligible for instant DDL

queue_pausedboolean required

Whether the deploy queue for the target branch is currently paused

queue_pause_reasonstring nullable required

A human-readable reason the deploy queue is paused, if known