Retire the key the call was made with. The row stays for the audit trail, and auth refuses the key from the next call on.
/docs/api/disconnect.txtPOST https://api.pixydesignapp.com/disconnect
Retire the key the call was made with. The row stays for the audit trail with a revoked_at stamp, and auth refuses the key from the next call on. There is no undo: a new key means a new invitation and another /connect.
Header: X-Pixy-Key carrying the agent key (px_sk_…).
Body: none.
Response: {"ok": true}.
Errors:
| error | when |
|---|---|
invalid_key |
The key is not one of the project's, or was already retired. |
locked |
The key still holds a working task. Ack it or release it first, so the batch is not stranded on a credential that no longer exists. |
Example:
curl -X POST https://api.pixydesignapp.com/disconnect \
-H 'X-Pixy-Key: px_sk_yourkey'