Rename an API key | Docmost Octri Preview

2 body fields

The API key identifier and its new display name.

apiKeyIdstringrequired

ID of the API key to rename.

namestringrequired

New display name.

2 status codes

200Returns the updated API key.

dataobjectoptional

statusintegeroptional

successbooleanoptional

403Returned when the authenticated user is forbidden from renaming the API key.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

Both apiKeyId and name are required. A 403 is returned when the authenticated user is forbidden from renaming the API key.

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.apiKeys.update({
  apiKeyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  name: "Untitled",
});

{
  "data": {
    "createdAt": "2026-01-15T09:00:00Z",
    "creator": {
      "avatarUrl": "https://example.com",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name"
    },
    "creatorId": "550e8400-e29b-41d4-a716-446655440000",
    "deletedAt": "2026-01-15T09:00:00Z",
    "expiresAt": "2026-01-15T09:00:00Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lastUsedAt": "2026-01-15T09:00:00Z",
    "name": "Example Name",
    "updatedAt": "2026-01-15T09:00:00Z",
    "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
  },
  "status": 200,
  "success": true
}

Request

Response

Errors