Skip to content
Authrim

Rollback settings category

POST
/api/admin/settings/{category}/rollback
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/settings/example/rollback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "targetVersion": 5, "reason": "Revert accidental change" }'

Restores a settings category to a target history version and records the rollback as a new current version.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
category
required
string

Request Body required

Section titled “Request Body required ”

Settings version rollback target.

Media type application/json
object
targetVersion
required
integer
>= 1
reason
string
key
additional properties
Example 
{
  "targetVersion": 5,
  "reason": "Revert accidental change"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
boolean
category
string
previousVersion
integer
currentVersion
integer
restoredFromVersion
integer
key
additional properties
Example 
{
  "success": true,
  "category": "oauth",
  "previousVersion": 13,
  "currentVersion": 14,
  "restoredFromVersion": 12
}

400

Section titled “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

Section titled “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

Section titled “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"
}

500

Section titled “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"
}