List Usage Limits Policy Entities

List entities tracked by a usage limits policy with their current usage.

GET /policies/usage-limits/{policyUsageLimitsId}/entities

List Usage Limits Policy Entities

cURL

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

import requests

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

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}/entities', 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}/entities",
  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}/entities"

	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}/entities")
  .header("x-portkey-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "value_key": "<string>",
      "current_usage": 123
    }
  ],
  "total": 123
}

Authorizations

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

Path Parameters

policyUsageLimitsId · string<uuid> · required

Usage limits policy UUID

Query Parameters

status · enum<string>

Filter by entity usage status

Available options: active, exhausted

search · string

Filter entities by value key

page_size · integer

Number of items per page

Required range: 1 <= x <= 100

current_page · integer

Current page number

Required range: x >= 0

Response

200

application/json

List of entities for the policy

object · string

Example:

"list"

data · object[]

Show child attributes

total · integer

Total number of entities