Update Rate Limits Policy

Update an existing rate limits policy.

PUT /policies/rate-limits/{rateLimitsPolicyId}

Update Rate Limits Policy

cURL

curl --request PUT \
  --url https://api.portkey.ai/v1/policies/rate-limits/{rateLimitsPolicyId} \
  --header 'Content-Type: application/json' \
  --header 'x-portkey-api-key: <api-key>' \
  --data '
{
  "value": 200,
  "unit": "rph"
}
'

import requests

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

payload = {
    "value": 200,
    "unit": "rph"
}
headers = {
    "x-portkey-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-portkey-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: 200, unit: 'rph'})
};

fetch('https://api.portkey.ai/v1/policies/rate-limits/{rateLimitsPolicyId}', 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/rate-limits/{rateLimitsPolicyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => 200,
    'unit' => 'rph'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"value\": 200,\n  \"unit\": \"rph\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-portkey-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.portkey.ai/v1/policies/rate-limits/{rateLimitsPolicyId}")
  .header("x-portkey-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": 200,\n  \"unit\": \"rph\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": 200,\n  \"unit\": \"rph\"\n}"

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

200

{}

Authorizations

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

Path Parameters

rateLimitsPolicyId · string<uuid> · required

Rate limits policy UUID

Body

application/json

name · string

Policy name

Maximum string length: 255

unit · enum<string>

Rate unit

Available options: rpm, rph, rpd

value · number

Rate limit value

Response

200

application/json

OK

The response is of type object.