Update workspace-managed API key metadata

patch

https://api.lingohub.com/v2/api-keys/{apiKeyId}

Merge-patches name, description and inclusive UTC expiration date on an active workspace-managed key. Omission preserves current values; null clears description or expiration. Scope, ownership, token and permissions remain unchanged. Empty or equal patches do not write. Optional If-Match uses the metadata GET validator. Requires workspace-level API access management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

apiKeyId

string

required

^api_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde

Body Params

Request body to partially update active workspace-managed key metadata without changing its permissions or ownership.

name

string

length ≤ 4096

Display name, unique among workspace-managed keys.

description

string | null

Optional description; null clears it.

expiration_date

date | null

Last valid day, inclusive, in UTC. Null means no configured expiration.

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Current key metadata.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404The resource does not exist, or the API key cannot see it.

412The current representation does not match If-Match (precondition_failed). No change was applied.

422The request is well-formed, but values are invalid; errors points at each of them.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.