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>'

• this engine

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.

Authorizations

• bearerAuth
• browserSession

Responses

200

OK

Media type application/json

One of:

object

object

expires_at

required

string format: date-time

session_id

required

string format: uuid

token

required

Opaque session token (olvs_…)

string

object

object

csrf_token

required

string

expires_at

required

string format: date-time

session_id

required

string format: uuid

Example ^generated

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

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}