Update API Key

PATCH

/api/api-keys/{id}

Update an API key's name, status, permissions, or modules.

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"name": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

]

}

Responses

API key updated

Content-Type

application/json

{

"data": {

"id": "string",

"name": "string",

"prefix": "string",

"start": "string",

"organizationId": "string",

"enabled": true,

"permissions": [

"string"

],

"modules": [

"string"

],

"expiresAt": "string",

"createdAt": "string",

"updatedAt": "string"

}

}

PATCH

/api/api-keys/{id}

Playground

Variables

Key

Value

id*

Body

Samples

Powered by VitePress OpenAPI