Update API key description

PUT

/api-keys/{apiKeyId}

Updates the description of an existing API key. Only the description field
can be modified after creation. The API key must belong to the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.perfectworks.io/api/v0/api-keys/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Updated API key description"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

API key updated successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-08-22 18:48:44

Get API key by ID

Delete API key