Update a cache rule

Partial update. matchers and action REPLACE the stored value when provided.

PATCH /api/gateway/v1/cache-rules/{id}

Update a cache rule

Python

import requests

url = "https://app.langwatch.ai/api/gateway/v1/cache-rules/{id}"

payload = {}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "cache_rule": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "priority": 0,
    "enabled": true,
    "matchers": {},
    "action": {
      "mode": "respect",
      "ttl": 0,
      "salt": "<string>"
    },
    "mode_enum": "respect",
    "archived_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

id · string · required

Minimum string length: 1

Body

application/json

name · string

Required string length: 1 - 128

description · string | null

Maximum string length: 512

priority · integer

Required range: 0 <= x <= 1000

enabled · boolean

matchers · object

Show child attributes

action · object

Show child attributes

Response

200

application/json

Success

cache_rule · object · required

Show child attributes