Skip to content

Renew the calling session token (rotates the credential, extends expiry)

POST
/v1/auth/refresh
curl --request POST \
--url https://example.com/v1/auth/refresh \
--header 'Authorization: Bearer <token>'

Rotates the calling session credential and extends its expiry, returning a fresh token; the old one stops working. It applies to session principals only, and an API token is reissued rather than refreshed.

OK

Media type application/json
object
expires_at
required
string format: date-time
session_id
required
string format: uuid
token
required

Opaque session token (olvs_…)

string
Example generated
{
"expires_at": "2026-04-15T12:00:00Z",
"session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"token": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}