Update virtual key

Partial update: send only the fields you want to change.

PATCH /api/gateway/v1/virtual-keys/{id}

Update virtual key

Python

import requests

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

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

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

print(response.text)

200

{
  "virtual_key": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "active",
    "purpose": "user",
    "display_prefix": "<string>",
    "principal_user_id": "<string>",
    "trace_project_id": "<string>",
    "trace_project_archived": true,
    "external_id": "<string>",
    "metadata": {},
    "scopes": [
      {
        "scope_type": "organization",
        "scope_id": "<string>"
      }
    ],
    "routing_policy_id": "<string>",
    "routing_mode": "none",
    "config": "<unknown>",
    "revision": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

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

scopes · object[]

Minimum array length: 1

Show child attributes

trace_project_id · string | null

routing_policy_id · string | null

routing_mode · enum<string>

Available options: none, fallback_all, policy

expires_at · unknown

budget · object | null

Show child attributes

config · object

Show child attributes

external_id · string | null

Required string length: 1 - 128

metadata · object

Show child attributes

Response

200

application/json

Success

virtual_key · object · required

Show child attributes