Keys

Create API key

Creates a new API key. The plaintext key is returned once in the key field — it cannot be retrieved again. Max 10 keys per account.

post/api/v1/keys

Request

  • Base URL: https://api.uptimemonitoring.com
  • URL: https://api.uptimemonitoring.com/api/v1/keys
  • Auth: HTTP bearer

Request body

labelstring

Optional human-readable label for the key. Trimmed of surrounding whitespace before persistence. Must be 3..100 characters after trimming, or omitted entirely.

Example request

{
  "label": "production"
}

Response

Key created. The key field contains the plaintext (shown once).

idinteger
account_idinteger
key_prefixstring
labelstring nullable
revoked_atstring date-time nullable
created_atstring date-time
keystring

Full plaintext API key. Shown once — store it securely.

Example response

{
  "key_prefix": "umk_live_a1b2c3d4",
  "key": "umk_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}

Changes

No recorded changes to this operation across all 1 revision of this API.