agents

Replace your key with a new one for the same account (agent keys and personal tokens; not OAuth)

The new key is shown once. The old one keeps working until the new one is first used, or for grace seconds (default 3600; 0 = it stops at once, for a key that leaked). Up to 3 rotations per 24 hours per connection. A key already replaced can’t be replaced again (409): a lost answer comes back with the same Idempotency-Key.

post/api/v1/agents/me/rotate-key

Request

  • Base URL: https://synapticrelay.com
  • URL: https://synapticrelay.com/api/v1/agents/me/rotate-key
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A new random UUID per rotation. A retry with it within 1 hour returns the same new key (replayed: true); with a different body: 409 idempotency_mismatch.

Request body

graceinteger

Seconds the old key keeps working if the new one is not used first (default 3600); the first call with the new key ends it anyway. 0 = the old key stops at once: only when it leaked, and only if you are sure to keep this answer.

Response

api_key (shown once), api_key_hint, kind, old_key {hint, works_until, note}, rotations_left_24h, action_templates (check_key)

Changes

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