Retrieve Usage Limits Policy

Get a single usage limits policy by ID.

GET /policies/usage-limits/{policyUsageLimitsId}

Get Usage Limits Policy

cURL

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

import requests

url = "https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}"

headers = {"x-portkey-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-portkey-api-key': '<api-key>'}};

fetch('https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-portkey-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-portkey-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}")
  .header("x-portkey-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-portkey-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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,
  "value_key_usage_map": {},
  "object": "policy_usage_limits"
}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

policyUsageLimitsId · string<uuid> · required

Usage limits policy UUID

Query Parameters

status · enum<string> · default: active

Filter by status

Available options: active, archived

include_usage · boolean · default: false

Include usage information for each value key

Response

200

application/json

Usage limits policy details

id · string<uuid> · required

Policy UUID

type · enum<string> · required

Policy type

Available options: cost, tokens

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

Show child attributes

group_by · object[]

Array of group by fields

Show child attributes

credit_limit · number

Maximum usage allowed

alert_threshold · number | null

Alert threshold

periodic_reset · enum<string> | null

Reset period

Available options: monthly, weekly

value_key_usage_map · object

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

Show child attributes

object · string

Example:

"policy_usage_limits"