Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
traffic
/
budgets
List traffic budgets
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "mode": "enforce",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "rules": [
        {
          "id": "<string>",
          "kind": "match",
          "tags": [
            {
              "key_id": "<string>",
              "key": "<string>",
              "value": "<string>",
              "source": "sql"
            }
          ],
          "actor": {
            "id": "<string>",
            "display_name": "<string>",
            "avatar_url": "<string>"
          },
          "syntax_highlighted_sql": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "fingerprint": "<string>",
          "keyspace": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "capacity": 123,
      "rate": 123,
      "burst": 123,
      "concurrency": 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

Organization name slug from list_organizations. Example: acme.

database
string
required

Database name slug from list_databases. Example: app-db.

branch
string
required

Branch name from list_branches. Example: main.

Query Parameters

page
integer
default:1

If provided, specifies the page offset of returned results

per_page
integer
default:25

If provided, specifies the number of returned results

period
string

Time period filter (e.g., '1h', '24h', '7d')

created_at
string

Filter by creation date range (format: 'start..end')

fingerprint
string

Filter budgets by query fingerprint

Response

Returns the traffic budgets for the branch

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