Approve an action run

PATCH 
/v1/actions/runs/:run_id/approval

This route allows you to approve or decline a request to execute an action that requires approval.

To learn more about manual approval for actions, check out the documentation.

Request

Path Parameters

run_id stringrequired

The identifier of the action run you want to approve/decline.

application/json

Body

required

statusstringrequired

Possible values: [APPROVE, DECLINE]

descriptionstring

A description and/or reason for the given status.

Responses

201

Approved/declined successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

run

object

idstringrequired

blueprint

object

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

entity

object

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

action

object

required

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

propertiesobjectrequired

endedAtdate-time

sourcestring | objectrequired

requiredApproval

boolean,object

required

typestringrequired

Possible values: [ALL, ANY]

statusstringrequired

statusLabelstring | null

linkstring[]

summarystring

approval

object,null

descriptionstring

userIdstring | null

statestring

payload

object,null

typestring

urluri

agentboolean

synchronizedboolean

methodstring

headers

object

RUN_IDstring

body

object

port_context

object

runIdstring

responseundefined[]

createdBystring

updatedBystring

createdAtdate-time

updatedAtdate-time

Example (from schema)

{
  "ok": true,
  "run": {
    "id": "string",
    "blueprint": {
      "identifier": "string",
      "deleted": true
    },
    "entity": {
      "identifier": "string",
      "deleted": true
    },
    "action": {
      "identifier": "string",
      "deleted": true
    },
    "properties": {},
    "endedAt": "2024-07-29T15:51:28.071Z",
    "status": "string",
    "summary": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}

403

One of the following errors occurred:

Error	Description
missing_permissions	You are not permitted to approve this action. For further details, please contact your admin

404

One of the following errors occurred:

Error	Description
not_found	The action run with the provided identifier was not found

422

One of the following errors occurred:

Error	Description
invalid_request	The data provided does not match the route schema
run_not_waiting_for_approval	Action run is not waiting for approval

500

One of the following errors occurred:

Error	Description
internal_error	An internal error occurred