List API keys

Lists metadata for automation API keys in the tenant. Secrets are never returned.

Technical details

Exact HTTP method and path your client calls

get/api/v1/api-keys

Responses

List API key metadata

FieldTypeDescription
ApiKeyMetadata[]
object
Example
[
  {
    "id": "string",
    "tenantId": "string",
    "workspaceId": "string",
    "label": "string",
    "status": "active",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "rotatedAt": "2026-01-01T00:00:00.000Z",
    "revokedAt": "2026-01-01T00:00:00.000Z"
  }
]

Errors return the standard envelope. See error reference.

Code samples

curl --request GET \
  --url 'https://api.not24get.me/api/v1/api-keys' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>'

Try it

Create API key

Creates a new automation API key. The raw secret is returned once in the response.

Technical details

Exact HTTP method and path your client calls

post/api/v1/api-keys

Request body

FieldTypeDescription
labelstring
workspaceIdstring
noticeVersionrequiredstring

Responses

Created API key

FieldTypeDescription
requiredobject
apiKeyrequiredstring
Raw secret; shown once at creation or rotation.
Example
{
  "metadata": {
    "id": "string",
    "tenantId": "string",
    "workspaceId": "string",
    "label": "string",
    "status": "active",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "rotatedAt": "2026-01-01T00:00:00.000Z",
    "revokedAt": "2026-01-01T00:00:00.000Z"
  },
  "apiKey": "string"
}

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/api/v1/api-keys' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>' \
  --data '{
  "label": "string",
  "workspaceId": "string",
  "noticeVersion": "string"
}'

Try it

Request body (JSON)

Revoke API key

Permanently disables an API key. Returns no body on success.

Technical details

Exact HTTP method and path your client calls

post/api/v1/api-keys/{keyId}/revoke

Path parameters

NameTypeRequiredDescription
keyIdstringrequired

Request body

FieldTypeDescription
(value)EmptyRequestPart

Responses

No Content

FieldTypeDescription
(value)EmptyResponsePart
Example
null

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/api/v1/api-keys/%3AkeyId/revoke' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>' \
  --data 'null'

Try it

Path parameters
Request body (JSON)

Rotate API key

Issues a new secret for an existing API key. The previous secret stops working immediately.

Technical details

Exact HTTP method and path your client calls

post/api/v1/api-keys/{keyId}/rotate

Path parameters

NameTypeRequiredDescription
keyIdstringrequired

Request body

FieldTypeDescription
(value)EmptyRequestPart

Responses

Rotated API key

FieldTypeDescription
requiredobject
apiKeyrequiredstring
Raw secret; shown once at creation or rotation.
Example
{
  "metadata": {
    "id": "string",
    "tenantId": "string",
    "workspaceId": "string",
    "label": "string",
    "status": "active",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "rotatedAt": "2026-01-01T00:00:00.000Z",
    "revokedAt": "2026-01-01T00:00:00.000Z"
  },
  "apiKey": "string"
}

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/api/v1/api-keys/%3AkeyId/rotate' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>' \
  --data 'null'

Try it

Path parameters
Request body (JSON)