Method: actions.executeTest

Full name: projects.locations.instances.integrations.actions.executeTest

Executes a test run of an action's script. Use this method to verify custom action logic, connectivity, and data parsing against a specified integration instance and test case before making the action available in playbooks.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/actions:executeTest

Path parameters

Parameters
parent

string

Required. The resource parent of the Action to test. Format: projects/{project}/locations/{location}/instances/{instance}/soar/integrations/{integration}/actions

Request body

The request body contains data with the following structure:

JSON representation 
{
  "testCaseId": integer,
  "action": {
    object (IntegrationAction)
  },
  "scope": string,
  "integrationInstanceId": string
}
Fields
testCaseId

integer (uint32 format)

Required. The action test case.
action

object (IntegrationAction)

Required. The action which will be tested.
scope

string

Required. The action test scope.
integrationInstanceId

string

Required. The integration instance id to use.

Response body

Response message for ExecuteTest.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "output": string,
  "debugOutput": string,
  "resultJson": string,
  "resultName": string
}
Fields
output

string

Required. The script output.
debugOutput

string

Required. The script debug output.
resultJson

string

Optional. The result json if exists.
resultName

string

Optional. The script result.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.integrationActions.run

For more information, see the IAM documentation.