Get settings history version

GET

/api/admin/settings/{category}/history/{version}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/example/history/1 \
  --header 'Authorization: Bearer <token>'

Returns one settings-history snapshot, its recorded changes, actor metadata, change source, and creation timestamp.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

category

required

string

version

required

integer

>= 1

Responses

200

Successful JSON response.

Media type application/json

object

category

string

version

integer

snapshot

Settings snapshot.

object

key

additional properties

changes

Array<object>

Recorded setting change.

object

key

additional properties

actor

object

id

string | null

type

string | null

key

additional properties

changeReason

string | null

changeSource

string | null

createdAt

integer

key

additional properties

Example

{
  "category": "oauth",
  "version": 12,
  "snapshot": {
    "require_pkce": true
  },
  "changes": [
    {
      "path": "require_pkce",
      "before": false,
      "after": true
    }
  ],
  "actor": {
    "id": "admin_123",
    "type": "admin"
  },
  "changeReason": "Require PKCE for all public clients.",
  "changeSource": "admin_api",
  "createdAt": 1770003600000
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}