Streams

Reset token

Rotate the stream token: invalidate the current token and generate a new one. Any client using the old token must be updated.

Result. Always HTTP 200: check status (1 on success) and read the new token. An unknown stream ID returns 404.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/streams/{id}/token/reset

Request

idinteger required

Unique identifier of the resource.

Successful Response

statusinteger required

1 the token was reset. Errors: 0 no API key, 2 no user, 3 no customer, 4 stream ID missing, 5 stream not found, 6 the reset failed.

messagestring required

OK, or the error text.

tokenstring nullable

The new stream token, on success only. The previous token stops being valid.

{
  "message": "OK",
  "status": 1,
  "token": "578f7b486a401391ccb41b660d969d92c320334d"
}