WebsiteTest DriveStatus

Response Actions

get

List all response actions

Authorizations
AuthorizationstringRequired
Query parameters
is_archivedbooleanOptional

Filter by archived status (default: false)

Responses
200

List of response actions

application/json
get
/app/api/v1/response-actions
GET /app/api/v1/response-actions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_at": "2025-11-25T12:39:09.431Z",
    "display_name": "text",
    "id": 1,
    "is_archived": true,
    "is_enabled": true,
    "trigger_def": {
      "created_at": "2025-11-25T12:39:09.431Z",
      "display_index": 1,
      "is_archived": true,
      "is_runnable": true,
      "is_scriptable": true,
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "script_var_names": [
        "text"
      ],
      "trigger_arg_names": [
        "text"
      ],
      "trigger_display_name": "text",
      "trigger_fn_name": "text",
      "trigger_tree_labels": [
        "text"
      ],
      "updated_at": "2025-11-25T12:39:09.431Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "updated_at": "2025-11-25T12:39:09.431Z"
  }
]
post

Create a new response action

Authorizations
AuthorizationstringRequired
Body
codestringOptional
display_namestringRequired
trigger_def_uuidstring · uuidRequired
Responses
post
/app/api/v1/response-actions
POST /app/api/v1/response-actions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "code": "text",
  "display_name": "text",
  "trigger_def_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "created_at": "2025-11-25T12:39:09.431Z",
  "display_name": "text",
  "id": 1,
  "is_archived": true,
  "is_enabled": true,
  "trigger_def": {
    "created_at": "2025-11-25T12:39:09.431Z",
    "display_index": 1,
    "is_archived": true,
    "is_runnable": true,
    "is_scriptable": true,
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "script_var_names": [
      "text"
    ],
    "trigger_arg_names": [
      "text"
    ],
    "trigger_display_name": "text",
    "trigger_fn_name": "text",
    "trigger_tree_labels": [
      "text"
    ],
    "updated_at": "2025-11-25T12:39:09.431Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "updated_at": "2025-11-25T12:39:09.431Z"
}
post

Execute a test run of a response action script without saving to database. Useful for testing and debugging scripts before deployment.

Authorizations
AuthorizationstringRequired
Body
script_codestringRequired

The Python code to execute

trigger_argsobjectRequired

Arguments to pass to the script (depends on trigger type)

Responses
200

Test run completed successfully

application/json
post
/app/api/v1/response-actions/test
POST /app/api/v1/response-actions/test HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "script_code": "text",
  "trigger_args": {}
}
{
  "status": "text",
  "stderr": "text",
  "stdout": "text"
}
get

List available response triggers for action creation

Authorizations
AuthorizationstringRequired
Responses
200

List of available triggers

application/json
get
/app/api/v1/response-actions/triggers
GET /app/api/v1/response-actions/triggers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_at": "2025-11-25T12:39:09.431Z",
    "display_index": 1,
    "is_archived": true,
    "is_runnable": true,
    "is_scriptable": true,
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "script_var_names": [
      "text"
    ],
    "trigger_arg_names": [
      "text"
    ],
    "trigger_display_name": "text",
    "trigger_fn_name": "text",
    "trigger_tree_labels": [
      "text"
    ],
    "updated_at": "2025-11-25T12:39:09.431Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
]
get

Get response action details with version and run counts

Authorizations
AuthorizationstringRequired
Path parameters
script_idintegerRequired
Responses
200

Response action details with counts and latest version/run

application/json
get
/app/api/v1/response-actions/{script_id}
GET /app/api/v1/response-actions/{script_id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "counts": {
    "run": 1,
    "version": 1
  },
  "latest": {
    "run": {},
    "version": {}
  }
}
delete

Archive (soft delete) a response action. Deletes unreferenced versions.

Authorizations
AuthorizationstringRequired
Path parameters
script_idintegerRequired
Responses
delete
/app/api/v1/response-actions/{script_id}
DELETE /app/api/v1/response-actions/{script_id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
patch

Update response action properties

Authorizations
AuthorizationstringRequired
Path parameters
script_idintegerRequired
Body
display_namestringOptional
is_enabledbooleanOptional
trigger_def_uuidstring · uuidOptional
Responses
200

Response action updated successfully

No content
patch
/app/api/v1/response-actions/{script_id}
PATCH /app/api/v1/response-actions/{script_id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "display_name": "text",
  "is_enabled": true,
  "trigger_def_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
No content
get

List all runs for a response action

Authorizations
AuthorizationstringRequired
Path parameters
script_idintegerRequired
Responses
200

List of response action runs

application/json
get
/app/api/v1/response-actions/{script_id}/runs
GET /app/api/v1/response-actions/{script_id}/runs HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_at": "2025-11-25T12:39:09.431Z",
    "id": 1,
    "script": {
      "created_at": "2025-11-25T12:39:09.431Z",
      "display_name": "text",
      "id": 1,
      "is_archived": true,
      "is_enabled": true,
      "trigger_def": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-11-25T12:39:09.431Z"
    },
    "script_version": {
      "author": {
        "email": "[email protected]",
        "first_name": "text",
        "id": 1,
        "last_name": "text",
        "oidc_user_id": "text",
        "role": "admin"
      },
      "code": "text",
      "created_at": "2025-11-25T12:39:09.431Z",
      "id": 1,
      "script": 1,
      "updated_at": "2025-11-25T12:39:09.431Z",
      "v_num": 1
    },
    "status": "running",
    "stderr": "text",
    "stdout": "text",
    "syserr": "text",
    "trigger_run": {
      "batch": 1,
      "created_at": "2025-11-25T12:39:09.431Z",
      "id": 1,
      "trigger_args": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "trigger_def": {
        "created_at": "2025-11-25T12:39:09.431Z",
        "display_index": 1,
        "is_archived": true,
        "is_runnable": true,
        "is_scriptable": true,
        "parent": "123e4567-e89b-12d3-a456-426614174000",
        "script_var_names": [
          "text"
        ],
        "trigger_arg_names": [
          "text"
        ],
        "trigger_display_name": "text",
        "trigger_fn_name": "text",
        "trigger_tree_labels": [
          "text"
        ],
        "updated_at": "2025-11-25T12:39:09.431Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "updated_at": "2025-11-25T12:39:09.431Z"
    },
    "updated_at": "2025-11-25T12:39:09.431Z"
  }
]
PreviousPingNextSystem Events

Last updated

Was this helpful?