Cancel Action Run

• Action Runs

Cancels an action run which is currently being executed

Request

URI

PATCH

https://vra-interop-222-139.lvn.broadcom.net/abx/api/resources/action-runs/{id}/cancel

COPY

Path Parameters

string

id

Required

ID of the action run

---

Request Body

ActionRun of type(s) application/json

Required

{
    "id": "string",
    "name": "string",
    "createdMillis": 0,
    "orgId": "string",
    "runState": "string",
    "actionId": "string",
    "actionType": "string",
    "inputs": {
        "inputs": {}
    },
    "outputs": {
        "outputs": {}
    },
    "errorMessage": "string",
    "logs": "string",
    "triggeredBy": "string",
    "endTimeMillis": 0,
    "startTimeMillis": 0,
    "runtime": "string",
    "provider": "string",
    "source": "string",
    "timeoutSeconds": 0,
    "projectId": "string",
    "runProjectId": "string",
    "scalable": false,
    "actionVersionId": "string",
    "actionVersionName": "string",
    "configuration": {
        "configuration": {}
    },
    "system": false
}

string

id

Optional

id

string

name

Optional

name

integer As int64 As int64

createdMillis

Optional

createdMillis

string

orgId

Optional

orgId

string

runState

Optional

runState

Possible values are : CREATED, DEPLOYING, RUNNING, FINISHING, COMPLETED, DEPLOYMENT_FAILED, FAILED, CANCELLED, UNKNOWN, DEPLOYED, HANDLING_ERROR,

string

actionId

Optional

actionId

string

actionType

Optional

actionType

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW, VAULT, CYBERARK,

object

inputs

Optional

inputs

object

outputs

Optional

outputs

string

errorMessage

Optional

errorMessage

string

logs

Optional

logs

string

triggeredBy

Optional

triggeredBy

integer As int64 As int64

endTimeMillis

Optional

endTimeMillis

integer As int64 As int64

startTimeMillis

Optional

startTimeMillis

string

runtime

Optional

runtime

string

provider

Optional

provider

string

source

Optional

source

integer As int32 As int32

timeoutSeconds

Optional

timeoutSeconds

string

projectId

Optional

projectId

string

runProjectId

Optional

runProjectId

boolean

scalable

Optional

scalable

string

actionVersionId

Optional

actionVersionId

string

actionVersionName

Optional

actionVersionName

object

configuration

Optional

configuration

boolean

system

Optional

system

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Hide Details

Action run cancelled

Returns ActionRun of type(s) */*

"ActionRun Object"

string

id

Optional

id

string

name

Optional

name

integer As int64 As int64

createdMillis

Optional

createdMillis

string

orgId

Optional

orgId

string

runState

Optional

runState

Possible values are : CREATED, DEPLOYING, RUNNING, FINISHING, COMPLETED, DEPLOYMENT_FAILED, FAILED, CANCELLED, UNKNOWN, DEPLOYED, HANDLING_ERROR,

string

actionId

Optional

actionId

string

actionType

Optional

actionType

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW, VAULT, CYBERARK,

object

inputs

Optional

inputs

object

outputs

Optional

outputs

string

errorMessage

Optional

errorMessage

string

logs

Optional

logs

string

triggeredBy

Optional

triggeredBy

integer As int64 As int64

endTimeMillis

Optional

endTimeMillis

integer As int64 As int64

startTimeMillis

Optional

startTimeMillis

string

runtime

Optional

runtime

string

provider

Optional

provider

string

source

Optional

source

integer As int32 As int32

timeoutSeconds

Optional

timeoutSeconds

string

projectId

Optional

projectId

string

runProjectId

Optional

runProjectId

boolean

scalable

Optional

scalable

string

actionVersionId

Optional

actionVersionId

string

actionVersionName

Optional

actionVersionName

object

configuration

Optional

configuration

boolean

system

Optional

system

400

Hide Details

Unable to cancel action run

Returns ActionRun of type(s) */*

"ActionRun Object"

string

id

Optional

id

string

name

Optional

name

integer As int64 As int64

createdMillis

Optional

createdMillis

string

orgId

Optional

orgId

string

runState

Optional

runState

Possible values are : CREATED, DEPLOYING, RUNNING, FINISHING, COMPLETED, DEPLOYMENT_FAILED, FAILED, CANCELLED, UNKNOWN, DEPLOYED, HANDLING_ERROR,

string

actionId

Optional

actionId

string

actionType

Optional

actionType

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW, VAULT, CYBERARK,

object

inputs

Optional

inputs

object

outputs

Optional

outputs

string

errorMessage

Optional

errorMessage

string

logs

Optional

logs

string

triggeredBy

Optional

triggeredBy

integer As int64 As int64

endTimeMillis

Optional

endTimeMillis

integer As int64 As int64

startTimeMillis

Optional

startTimeMillis

string

runtime

Optional

runtime

string

provider

Optional

provider

string

source

Optional

source

integer As int32 As int32

timeoutSeconds

Optional

timeoutSeconds

string

projectId

Optional

projectId

string

runProjectId

Optional

runProjectId

boolean

scalable

Optional

scalable

string

actionVersionId

Optional

actionVersionId

string

actionVersionName

Optional

actionVersionName

object

configuration

Optional

configuration

boolean

system

Optional

system

404

Hide Details

Action run not found

Returns ActionRun of type(s) */*

"ActionRun Object"

string

id

Optional

id

string

name

Optional

name

integer As int64 As int64

createdMillis

Optional

createdMillis

string

orgId

Optional

orgId

string

runState

Optional

runState

Possible values are : CREATED, DEPLOYING, RUNNING, FINISHING, COMPLETED, DEPLOYMENT_FAILED, FAILED, CANCELLED, UNKNOWN, DEPLOYED, HANDLING_ERROR,

string

actionId

Optional

actionId

string

actionType

Optional

actionType

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW, VAULT, CYBERARK,

object

inputs

Optional

inputs

object

outputs

Optional

outputs

string

errorMessage

Optional

errorMessage

string

logs

Optional

logs

string

triggeredBy

Optional

triggeredBy

integer As int64 As int64

endTimeMillis

Optional

endTimeMillis

integer As int64 As int64

startTimeMillis

Optional

startTimeMillis

string

runtime

Optional

runtime

string

provider

Optional

provider

string

source

Optional

source

integer As int32 As int32

timeoutSeconds

Optional

timeoutSeconds

string

projectId

Optional

projectId

string

runProjectId

Optional

runProjectId

boolean

scalable

Optional

scalable

string

actionVersionId

Optional

actionVersionId

string

actionVersionName

Optional

actionVersionName

object

configuration

Optional

configuration

boolean

system

Optional

system

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
                

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Action Runs Operations

GET

Get All 2 1

POST

Create 2

DELETE

Delete 3

PATCH

Cancel Action Run

GET

Get By Id 2

DELETE

Delete 4