Skip to main content
GET
/
policies
/
rate-limits
/
{rateLimitsPolicyId}
Get Rate Limits Policy
curl --request GET \
  --url https://api.portkey.ai/v1/policies/rate-limits/{rateLimitsPolicyId} \
  --header 'x-portkey-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "requests",
  "unit": "rpm",
  "value": 123,
  "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"
    }
  ],
  "object": "policy_rate_limits"
}

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
rateLimitsPolicyId
string<uuid>
required

Rate limits policy UUID

Query Parameters

​
status
enum<string>
default:active

Filter by status

Available options:
active,
archived

Response

Rate limits policy details

​
id
string<uuid>
required

Policy UUID

​
type
enum<string>
required

Policy type

Available options:
requests,
tokens
​
unit
enum<string>
required

Rate unit

Available options:
rpm,
rph,
rpd
​
value
number
required

Rate limit value

​
status
enum<string>
required

Policy status

Available options:
active,
archived
​
workspace_id
string<uuid>
required

Workspace UUID

​
organisation_id
string<uuid>
required

Organization UUID

​
created_at
string<date-time>
required

Creation timestamp

​
last_updated_at
string<date-time>
required

Last update timestamp

​
name
string | null

Policy name

​
conditions
object[]

Array of conditions

​
group_by
object[]

Array of group by fields

​
object
string
Example:

"policy_rate_limits"