Update an API key

Update an API key’s name, description, permission mode, permissions or bindings. Every field is optional; bindings are replaced outright, and the response is exactly what a subsequent GET returns. You may update your own keys; organization admins may update any key in the organization. Bindings can never exceed the access of the member the key belongs to, and a key can grant at most what the key making the request holds. The token itself never changes.

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

Update an API key

Python

import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "roleBindings": [
    {
      "id": "<string>",
      "role": "ADMIN",
      "scopeType": "ORGANIZATION",
      "scopeId": "<string>"
    }
  ],
  "keyType": "personal",
  "assignedToUserId": "<string>",
  "createdByUserId": "<string>",
  "permissionMode": "<string>",
  "permissions": [
    "<string>"
  ],
  "bindings": [
    {
      "role": "ADMIN",
      "scopeType": "ORGANIZATION",
      "scopeId": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Admin API key for organization-level operations (managing projects, API keys). Create one in Settings > API Keys or via POST /api/api-keys. Format: sk-lw-{id}_{secret}.

Path Parameters

id · string · required

Minimum string length: 1

Body

application/json

name · string

Required string length: 1 - 100

description · string | null

Maximum string length: 500

permissionMode · enum<string>

'all' and 'readonly' take their meaning from the bindings alone; 'restricted' additionally requires an explicit permissions list.

Available options: all, readonly, restricted

permissions · string[]

Restricted mode only: the exact resource:action permissions the key's CUSTOM bindings grant.

Pattern: ^[a-z][a-zA-Z0-9_-]*:[a-z][a-zA-Z0-9_-]*$

bindings · object[]

Replaces the key's bindings outright. Whatever is accepted here is exactly what a subsequent GET returns.

Required array length: 1 - 20 elements

Show child attributes

Response

200

application/json

Success

id · string · required

Minimum string length: 1

name · string · required

description · string | null · required

createdAt · string<date-time> · required

expiresAt · string<date-time> | null · required

lastUsedAt · string<date-time> | null · required

revokedAt · string<date-time> | null · required

roleBindings · object[] · required

Show child attributes

keyType · enum<string> · required

Available options: personal, service

assignedToUserId · string | null · required

createdByUserId · string | null · required

permissionMode · string · required

permissions · string[] · required

Pattern: ^[a-z][a-zA-Z0-9_-]*:[a-z][a-zA-Z0-9_-]*$

bindings · object[] · required

Show child attributes