Skip to main content

Rotate Background Agent Secret

POST 
/api/background-agents/:id/rotate-secret

Rotates the agent's gateway secret and returns the new plaintext secret.

The previous secret stops working immediately. The new secret is only returned once — store it securely. If the agent is synced to an external platform, sync it again afterwards so the platform receives the new credentials.

Request​

Responses​

Secret rotated successfully