Update API Key

PATCH 
/workspaces/:workspaceId/service-accounts/:subjectId/api-keys/:apiKeyId

Update API Key

Request

Path Parameters

workspaceId uuidrequired
subjectId uuidrequired
apiKeyId uuidrequired

application/json

Body

displayName stringnullable

text/json

Body

displayName stringnullable

application/*+json

Body

displayName stringnullable

Responses

200

API key updated.

application/json

Schema

Schema

• Array [

apiKeyId uuid
displayName string
expiresAt date-timenullable
creatorSubjectId uuidnullable
publicPrefix string
createdAt date-time

• ]

Example (from schema)

[
  {
    "apiKeyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "expiresAt": "2024-12-17T17:37:35.064Z",
    "creatorSubjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "publicPrefix": "string",
    "createdAt": "2024-12-17T17:37:35.064Z"
  }
]

400

Invalid request.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Workspace or service account not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...