Skip to the page

A refresh token for a new pair (the refresh token is spent)

POST/v1/cli/sessions/refresh

Operation session.refresh · stable

No token: this route is how one is madeAnswers200 OK

A new pair of tokens, in the same shape as session.create.

Called without a bearer token. A refresh token used twice means someone holds a copy: the whole session is ended for both.

Body (JSON)

Fields not listed here are refused.

refreshTokenstringrequired
The refresh token (rkr_) from the last pair. It is spent: keep the new one.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:

  • session_ended
POST/v1/cli/sessions/refresh
curl -X POST "https://api.rykloud.com/v1/cli/sessions/refresh" \
  -H "Content-Type: application/json" \
  -d '{
  "refreshToken": "<refreshToken>"
}'