Cancel a draft, ready, or running configuration Plan.

POST

/api/admin/agent-config-plans/{id}/{version}/cancel

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/agent-config-plans/example/1/cancel \
  --header 'Content-Type: application/json' \
  --cookie authrim_admin_session=<authrim_admin_session> \
  --data '{ "reason": "example" }'

Cancellation is idempotent. A running Plan stops before its next step; already completed owner-side effects are not rolled back.

Authorizations

• adminSessionCookie

Parameters

Path Parameters

id

required

string

version

required

integer

>= 1

Request Body

Media type application/json

object

reason

string

>= 1 characters <= 500 characters

key

additional properties

Example ^generated

{
  "reason": "example"
}

Responses

200

Plan cancellation state.

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"
}

409

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"
}