v17

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

Check deploy request storage

Checks whether the deploy request's target branch cluster has enough storage to safely deploy the schema changes.

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}/storage-check

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 storage check information for the deploy request

enough_storageboolean required

Whether the cluster has enough storage to safely deploy

upgradeableboolean required

Whether the target branch cluster can be upgraded for more storage

storage_bytes_neededinteger required

Total estimated bytes of additional storage needed for the deployment

storage_reportobject required

Per-keyspace and per-shard storage report. Keys are keyspace names.