Skip to main content
PATCH
/
v1
/
auth
/
api-keys
/
{id}
Update an API key
curl --request PATCH \
  --url http://127.0.0.1:8787/v1/auth/api-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enabled": true,
  "permissions": [
    "webhooks:read"
  ],
  "metadata": {}
}
'
{
  "data": {
    "status": "success",
    "message": "<string>"
  },
  "error": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.kayle.id/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
Minimum string length: 1

Body

application/json
​
name
string
Minimum string length: 1
​
enabled
boolean
​
permissions
enum<string>[]
Minimum array length: 1
Available options:
webhooks:read,
webhooks:write,
sessions:read,
sessions:write,
analytics:read
​
metadata
object

Response

API key updated successfully.

​
data
object
required
​
error
object
required