Workspace API Keys

Create a key for the caller, or for a service account with serviceAccountId. Needs api_key.create; a service account also needs api_key.manage on it. The secret is returned once. A workspace holds at most 5 active keys per creator (409). Managing the credentials of a service account lets the holder act with that service account's rights.

post/v4/workspaces/{workspaceId}/api-keys

Request

  • Base URL: https://api.merkl.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.merkl.xyz/v4/workspaces/{workspaceId}/api-keys
  • Auth: apiKey (a scheme the document does not define)

Path parameters

workspaceIdstring uuid required

Request body

descriptionstring
expiresAtstring date-time

ISO 8601, in the future

serviceAccountIdstring uuid

The service account the key belongs to. Omit it for a personal key of the caller. Managing the credentials of a service account lets the holder act with that service account's rights.

Response

Response for status 200

idstring required
workspaceIdstring nullable required
userIdstring nullable required

The identity that holds the key: a person or a service account

prefixstring required
descriptionstring nullable required
tiernumber required
issuedByUserIdstring nullable required

The person who issued the key. Absent for historical keys

createdAtstring required
expiresAtstring nullable required
revokedAtstring nullable required
rawKeystring nullable required

The secret. Returned once. A repeated Idempotency-Key never returns it again

Changes