Rotate a single-owner Gateway Token

Mints a replacement token for the gateway. A current token the gateway has connected with keeps working until the gateway first connects with the replacement or 4 hours elapse, whichever comes first; a token no gateway has ever connected with is replaced immediately. Rotating again before the gateway picks up the replacement replaces only the pending token and never invalidates the one in use. Once the replacement is confirmed the previous token is deleted - rolling the gateway's configuration back to it will strand the gateway.

post/sites/{site_id}/gateways/{gateway_id}/token/rotate

Path parameters

site_idstring required

Site ID

gateway_idstring required

Gateway ID

Response

New Token Response

Example response

{
  "data": {
    "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
    "token": "secret-token-here"
  }
}

Changes

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