API keys (PIT)

The Personal Integration Token — the credential this whole reference authenticates with. See Authentication for how to use it.

GET/api-key

Get the caller's key

Returns the caller's own PIT key, or null if one was never generated.

bash
curl -X GET 'https://api.conexus-x.example/api/api-key' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json
{
  "apiKey": "cxpt_9f3a7c2e8b1d4a6f0c5e2b7d9a1f3c6e",
  "nextAllowedAt": "2026-08-02T16:01:00.000Z"
}
POST/api-key/generate

Generate a new key

Rotates the caller's PIT key. Rate-limited to once per 20 minutes — a request inside that window is rejected with nextAllowedAt in the error body.

bash
curl -X POST 'https://api.conexus-x.example/api/api-key/generate' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json
{
  "apiKey": "cxpt_9f3a7c2e8b1d4a6f0c5e2b7d9a1f3c6e",
  "nextAllowedAt": "2026-08-02T16:01:00.000Z"
}