Update Guardrail

Updates an existing guardrail’s name, checks, or actions

PUT /guardrails/{guardrailId}

Update a guardrail

cURL

curl --request PUT \
  --url https://api.portkey.ai/v1/guardrails/{guardrailId} \
  --header 'Content-Type: application/json' \
  --header 'x-portkey-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "checks": [
    {
      "parameters": {
        "jwksUri": "<string>",
        "headerKey": "<string>",
        "cacheMaxAge": 86400,
        "clockTolerance": 5,
        "maxTokenAge": "1d",
        "algorithms": [
          "RS256"
        ]
      },
      "name": "<string>",
      "is_enabled": true
    }
  ]
}
'

import requests

url = "https://api.portkey.ai/v1/guardrails/{guardrailId}"

payload = {
    "name": "<string>",
    "checks": [
        {
            "parameters": {
                "jwksUri": "<string>",
                "headerKey": "<string>",
                "cacheMaxAge": 86400,
                "clockTolerance": 5,
                "maxTokenAge": "1d",
                "algorithms": ["RS256"]
            },
            "name": "<string>",
            "is_enabled": True
        }
    ]
}
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({
    name: '<string>',
    checks: [
      {
        parameters: {
          jwksUri: '<string>',
          headerKey: '<string>',
          cacheMaxAge: 86400,
          clockTolerance: 5,
          maxTokenAge: '1d',
          algorithms: ['RS256']
        },
        name: '<string>',
        is_enabled: true
      }
    ]
  })
};

fetch('https://api.portkey.ai/v1/guardrails/{guardrailId}', 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/guardrails/{guardrailId}",
  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([
    'name' => '<string>',
    'checks' => [
        [
                'parameters' => [
                                'jwksUri' => '<string>',
                                'headerKey' => '<string>',
                                'cacheMaxAge' => 86400,
                                'clockTolerance' => 5,
                                'maxTokenAge' => '1d',
                                'algorithms' => [
                                                                'RS256'
                                ]
                ],
                'name' => '<string>',
                'is_enabled' => true
        ]
    ]
  ]),
  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/guardrails/{guardrailId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"checks\": [\n    {\n      \"parameters\": {\n        \"jwksUri\": \"<string>\",\n        \"headerKey\": \"<string>\",\n        \"cacheMaxAge\": 86400,\n        \"clockTolerance\": 5,\n        \"maxTokenAge\": \"1d\",\n        \"algorithms\": [\n          \"RS256\"\n        ]\n      },\n      \"name\": \"<string>\",\n      \"is_enabled\": true\n    }\n  ]\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/guardrails/{guardrailId}")
  .header("x-portkey-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"checks\": [\n    {\n      \"parameters\": {\n        \"jwksUri\": \"<string>\",\n        \"headerKey\": \"<string>\",\n        \"cacheMaxAge\": 86400,\n        \"clockTolerance\": 5,\n        \"maxTokenAge\": \"1d\",\n        \"algorithms\": [\n          \"RS256\"\n        ]\n      },\n      \"name\": \"<string>\",\n      \"is_enabled\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/guardrails/{guardrailId}")

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  \"name\": \"<string>\",\n  \"checks\": [\n    {\n      \"parameters\": {\n        \"jwksUri\": \"<string>\",\n        \"headerKey\": \"<string>\",\n        \"cacheMaxAge\": 86400,\n        \"clockTolerance\": 5,\n        \"maxTokenAge\": \"1d\",\n        \"algorithms\": [\n          \"RS256\"\n        ]\n      },\n      \"name\": \"<string>\",\n      \"is_enabled\": true\n    }\n  ]\n}"

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

200

{
  "id": "<string>",
  "slug": "<string>",
  "version_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "type": "<string>"
  }
}

Authorizations

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

Path Parameters

guardrailId · string · required

Guardrail UUID or slug to update

Body

application/json

name · string

Updated name of the guardrail

checks · object[]

Updated array of guardrail checks

Minimum array length: 1

Show child attributes

actions · object

Actions to take when guardrail checks fail or pass

Show child attributes

Response

200

application/json

Guardrail updated successfully

id · string · required

Unique identifier of the updated guardrail

slug · string · required

URL-friendly slug for the guardrail

version_id · string

New version identifier after update