Skip to main content
POST
/
api
/
gateway
/
v1
/
virtual-keys
/
{id}
/
rotate
Rotate virtual key secret
import requests

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

headers = {"X-Auth-Token": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};

fetch('https://app.langwatch.ai/api/gateway/v1/virtual-keys/{id}/rotate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
curl --request POST \
  --url https://app.langwatch.ai/api/gateway/v1/virtual-keys/{id}/rotate \
  --header 'X-Auth-Token: <api-key>'
{
  "virtual_key": {
    "id": "<string>",
    "display_prefix": "<string>",
    "name": "<string>",
    "description": "<string>",
    "principal_user_id": "<string>",
    "provider_credential_ids": [
      "<string>"
    ],
    "revision": "<string>",
    "last_used_at": "<string>",
    "created_at": "<string>"
  },
  "secret": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<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

Response

Rotated

virtual_key
object
required
secret
string
required