Update a approval-request

PUT

/approval-requests/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Request Body ^required

object

data

object

action_type

required

Machine-readable action identifier, e.g. backup.policy.apply, runbook.execute, bulk.deauth

string

action_label

Human-readable label for the action

string

payload

required

The action payload that will be executed on approval

status

required

string

Allowed values: pending approved rejected expired

blast_radius

{ resource_count: number, resource_types: string[], estimated_impact: string }

cost_delta

Estimated cost change in USD (negative = savings)

number

rollback_plan

Step-by-step rollback instructions

string

dry_run_result

Result of pre-execution dry run

dry_run_status

Lifecycle status of the dry-run simulation

string

Allowed values: pending running completed failed

cost_delta_usd

Estimated cost change in USD from running this action (negative = savings)

number

expires_at

required

Approval TTL — auto-set to now+4h on create

string format: date-time

approved_at

string format: date-time

rejection_reason

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

requester

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

approved_by

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

Responses

200

Updated

object

data

object

action_type

required

Machine-readable action identifier, e.g. backup.policy.apply, runbook.execute, bulk.deauth

string

action_label

Human-readable label for the action

string

payload

required

The action payload that will be executed on approval

status

required

string

Allowed values: pending approved rejected expired

blast_radius

{ resource_count: number, resource_types: string[], estimated_impact: string }

cost_delta

Estimated cost change in USD (negative = savings)

number

rollback_plan

Step-by-step rollback instructions

string

dry_run_result

Result of pre-execution dry run

dry_run_status

Lifecycle status of the dry-run simulation

string

Allowed values: pending running completed failed

cost_delta_usd

Estimated cost change in USD from running this action (negative = savings)

number

expires_at

required

Approval TTL — auto-set to now+4h on create

string format: date-time

approved_at

string format: date-time

rejection_reason

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

requester

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

approved_by

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found