Get 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

OAuth Scopes

Resource	Scopes
Organization	read_deploy_requests
Database	read_deploy_requests

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

Get deploy request throttler configurations

cURL

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler \
  --header 'Authorization: Bearer <token>'

200

{
  "keyspaces": [
    "<string>"
  ],
  "configurable": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "configurations": [
    {
      "keyspace_name": "<string>",
      "ratio": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization · string · required

The name of the deploy request's organization

database · string · required

The name of the deploy request's database

number · integer · required

The number of the deploy request

Response

200

application/json

Deploy request throttler configurations

keyspaces · string[] · required

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

configurable · object · required

Show child attributes

configurations · object[] · required

Show child attributes