List Usage Limits Policy

List Usage Limits Policies

curl --request GET \
  --url https://api.portkey.ai/v1/policies/usage-limits \
  --header 'x-portkey-api-key: <api-key>'

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "cost",
      "status": "active",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "conditions": [
        {
          "key": "workspace_id",
          "value": "workspace-123"
        }
      ],
      "group_by": [
        {
          "key": "api_key"
        }
      ],
      "credit_limit": 123,
      "alert_threshold": 123,
      "periodic_reset": "monthly",
      "value_key_usage_map": {}
    }
  ],
  "total": 123
}

GET

policies

usage-limits

List Usage Limits Policies

curl --request GET \
  --url https://api.portkey.ai/v1/policies/usage-limits \
  --header 'x-portkey-api-key: <api-key>'

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "cost",
      "status": "active",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "conditions": [
        {
          "key": "workspace_id",
          "value": "workspace-123"
        }
      ],
      "group_by": [
        {
          "key": "api_key"
        }
      ],
      "credit_limit": 123,
      "alert_threshold": 123,
      "periodic_reset": "monthly",
      "value_key_usage_map": {}
    }
  ],
  "total": 123
}

Authorizations

x-portkey-api-key

string

header

required

Query Parameters

workspace_id

string

Workspace ID or slug

status

enum<string>

default:active

Filter by status

Available options:

active,

archived

type

enum<string>

Filter by policy type

Available options:

cost,

tokens

page_size

integer

Number of items per page

Required range: x >= 0

current_page

integer

Current page number

Required range: x >= 0

Response

List of usage limits policies

object

string

Example:

"list"

data

object[]

Show child attributes

data.id

string<uuid>

required

Policy UUID

data.type

enum<string>

required

Policy type

Available options:

cost,

tokens

data.status

enum<string>

required

Policy status

Available options:

active,

archived

data.workspace_id

string<uuid>

required

Workspace UUID

data.organisation_id

string<uuid>

required

Organization UUID

data.created_at

string<date-time>

required

Creation timestamp

data.last_updated_at

string<date-time>

required

Last update timestamp

data.name

string | null

Policy name

data.conditions

object[]

Array of conditions

Show child attributes

data.conditions.key

string

required

Condition key. Valid values:

api_key - Apply to a specific API key
organisation_id - Apply to an organization
workspace_id - Apply to a workspace
metadata.* - Apply based on custom metadata fields (e.g., metadata.user_id, metadata.team)

Example:

"workspace_id"

data.conditions.value

string

required

Condition value

Example:

"workspace-123"

data.group_by

object[]

Array of group by fields

Show child attributes

data.group_by.key

string

required

Group by key. Valid values:

api_key - Group by API key
organisation_id - Group by organization
workspace_id - Group by workspace
metadata.* - Group by custom metadata fields

Example:

"api_key"

data.credit_limit

number

Maximum usage allowed

data.alert_threshold

number | null

Alert threshold

data.periodic_reset

enum<string> | null

Reset period

Available options:

monthly,

weekly

data.value_key_usage_map

object

Map of value keys to usage information (only included when include_usage=true)

Show child attributes

data.value_key_usage_map.{key}

object

Show child attributes

data.value_key_usage_map.{key}.current_usage

number

Current usage value

data.value_key_usage_map.{key}.status

enum<string>

Usage status

Available options:

active,

exhausted

data.value_key_usage_map.{key}.is_threshold_alerts_sent

boolean

Whether threshold alerts have been sent

data.value_key_usage_map.{key}.is_exhausted_alerts_sent

boolean

Whether exhausted alerts have been sent

total

integer

Total number of policies

Create Usage Limits Policy Retrieve Usage Limits Policy

⌘I

API Reference

Configs

Integrations

Providers

Virtual Keys

Prompts

API Keys

Analytics [BETA]

Users

User Invites

Workspaces

Workspace Members

Audit Logs

Guardrails

Policies

OpenAPI

List Usage Limits Policy

Authorizations

Query Parameters

Response