v17

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

Deploy requests

Update deploy request throttler configurations

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, create_deploy_request

OAuth Scopes

Resource	Scopes
Organization	deploy_deploy_requests
Database	deploy_deploy_requests

patch/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler

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

Request body

ratiointeger

A throttler ratio between 0 and 95 that will apply to all keyspaces affected by the deploy request. 0 effectively disables throttler, while 95 drastically slows down migrations in the deploy request

configurationsstring[]

If specifying throttler ratios per keyspace, an array of { "keyspace_name": "mykeyspace", "ratio": 10 }, one for each eligible keyspace

Response

Deploy request throttler configurations

keyspacesstring[] required

Keyspaces that are eligible for throttler configuration in the configurable resource (database or deploy request)