Credentials API

POST /api/v1/credentials/list

List all credentials for the authenticated server.

Response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "uuid": "abc-123-def",
      "name": "Production API",
      "type": "API",
      "hold": false,
      "last_used_at": "2026-03-28T10:00:00Z"
    },
    {
      "id": 2,
      "uuid": "ghi-456-jkl",
      "name": "SMTP Relay",
      "type": "SMTP",
      "hold": false,
      "last_used_at": "2026-03-30T08:30:00Z"
    }
  ]
}

POST /api/v1/credentials/create

Create a new credential.

Parameters

Parameter	Type	Required	Description
`name`	`string`	Yes	Human-readable name
`type`	`string`	No	`SMTP` (default) or `API`
`hold`	`boolean`	No	Create in held state

Response

{
  "status": "success",
  "data": {
    "id": 3,
    "uuid": "mno-789-pqr",
    "name": "New API Key",
    "type": "API",
    "hold": false,
    "key": "vml_abc123def456ghi789jkl"
  }
}

POST /api/v1/credentials/regenerate

Create a new credential and revoke the old one (key rotation).

Parameters

Parameter	Type	Required	Description
`uuid`	`string`	Yes	UUID of the credential to regenerate

Response

{
  "status": "success",
  "data": {
    "old_id": 2,
    "old_uuid": "ghi-456-jkl",
    "new_id": 4,
    "new_uuid": "stu-012-vwx",
    "key": "vml_newkey123456789..."
  }
}

Triggers a CredentialLocked webhook for the old credential.

POST /api/v1/credentials/revoke

Mark a credential as held (revoked). Held credentials cannot be used for authentication.

Parameters

Parameter	Type	Required	Description
`uuid`	`string`	Yes	UUID of the credential to revoke

Response

{
  "status": "success",
  "data": {
    "id": 2,
    "uuid": "ghi-456-jkl",
    "hold": true
  }
}

Triggers a CredentialLocked webhook.

Try it

Not authenticated

POST

X-Server-API-Key

Content-Type

Response