Skip to main content
POST
/
api
/
v1
/
relay
/
refresh
Refresh Relay Token
curl --request POST \
  --url https://api.example.com/api/v1/relay/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "relay_token": "<string>"
}
'
{
  "relay_token": "<string>",
  "relay_token_expires_in": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to refresh an expiring relay token.

​
relay_token
string
required

Existing relay token to refresh.

Response

Successful Response

Response containing a new relay token after refresh.

​
relay_token
string
required

New relay token for websocket authentication.

​
relay_token_expires_in
integer
required

Seconds until the new relay token expires.