Error

A valid request URL is required to generate request examples

[
  {
    "action": "<string>",
    "config": {},
    "created_at": "<string>",
    "created_by": "<string>",
    "current_spend_usd": 123,
    "current_usage": [
      {
        "value": 123
      }
    ],
    "description": "<string>",
    "enabled": true,
    "id": "<string>",
    "is_system_generated": true,
    "name": "<string>",
    "organization_id": "<string>",
    "parent_policy_id": "<string>",
    "policy_type": "<string>",
    "priority": 123,
    "subject_matchers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "updated_at": "<string>"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

List gateway policies

Returns every gateway policy in the current organization. The response includes both admin-created policies and runtime-materialized children of default_spend_cap and default_rate_limit policies (children carry parent_policy_id).

Spend tracking: each spend-cap policy carries current_spend_usd — the spend accumulated in the policy’s active window.

Filters (all optional):

policy_type — spend_cap, default_spend_cap, guard, route_config, rate_limit, or default_rate_limit
subject_matcher_key + subject_matcher_value — narrow to policies whose subject_matchers contain {key, value}

For batch lookups by a set of subject values (e.g. many run_rule_ids at once), use POST /v1/platform/gateway-policies/search; it accepts the values in a JSON body and avoids the URL-length ceiling that a repeated query param would hit at scale.

GET

api

platform

gateway-policies

Error

A valid request URL is required to generate request examples

[
  {
    "action": "<string>",
    "config": {},
    "created_at": "<string>",
    "created_by": "<string>",
    "current_spend_usd": 123,
    "current_usage": [
      {
        "value": 123
      }
    ],
    "description": "<string>",
    "enabled": true,
    "id": "<string>",
    "is_system_generated": true,
    "name": "<string>",
    "organization_id": "<string>",
    "parent_policy_id": "<string>",
    "policy_type": "<string>",
    "priority": 123,
    "subject_matchers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "updated_at": "<string>"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

policy_type

string

Filter by policy_type

subject_matcher_key

string

Filter by subject matcher key

subject_matcher_value

string

Filter by subject matcher value (paired with subject_matcher_key)

Response

action

string

config

object

created_at

string

created_by

string

current_spend_usd

number

CurrentSpendUSD is the spend in the policy's current window. Set for any spend_cap policy regardless of enabled state — disabled policies still surface usage so users can see what would have been counted. Nil for non-spend_cap policies or when the spend lookup failed.

current_usage

object[]

CurrentUsage is the consumed units in each configured limit's current window. Set for any rate_limit policy regardless of enabled state, one entry per limit in the config. Nil for non-rate_limit policies or when the usage lookup failed.

Show child attributes

description

string

enabled

boolean

string

is_system_generated

boolean

name

string

organization_id

string

parent_policy_id

string

ParentPolicyID is set on materialized children of a default_spend_cap to the default's id. An explicit Update or a Create with the same matchers clears the link and takes ownership of the materialized row. Delete on the parent cascade-soft-deletes children still attached.

policy_type

string

priority

integer

subject_matchers

object[]

Show child attributes

updated_at

string