Update Task Soar icon

Update Task Soar

Update Task in Soar

Overview

This node, named "Update Task Soar," is designed to update a task in a SOAR (Security Orchestration, Automation, and Response) system via its API. It sends an HTTP PUT request to the specified SOAR API endpoint with detailed task information to modify existing tasks.

Common scenarios for this node include:

  • Automating updates to security incident tasks within a SOAR platform.
  • Integrating task status or metadata changes into broader workflows.
  • Synchronizing task details from other systems into the SOAR environment.

For example, you might use this node to update the priority, description, or status of a security investigation task after receiving new information or completing certain automated checks.

Properties

Name Meaning
Url of Soar API The endpoint URL for the SOAR API service where the task update request will be sent. Example: http://192.168.143.73:2025/api/tasks/{taskId}
Type Numeric type identifier of the task (e.g., 0).
Name Name of the task to update.
Code Unique code identifying the task.
Department Code Code representing the department responsible for the task.
Case Code Code associated with the case linked to the task.
Username Username of the user performing the update.
Catalog Priority Code Priority code assigned to the task.
SLA Code Service Level Agreement code related to the task.
Description Textual description of the task.
Status Numeric status code of the task (e.g., 0).
Attachment IDs JSON string representing an array of attachment IDs associated with the task (e.g., [422]).
Tenancy Code Optional tenancy code for multi-tenant environments.

Output

The node outputs an array of JSON objects, each corresponding to an input item processed. Each output object contains:

  • success: Boolean indicating if the update was successful.
  • response: The full response data returned by the SOAR API after the update.
  • taskName: The name of the task that was updated.

In case of failure (and if the node is configured to continue on error), the output includes:

  • success: false
  • error: Error message describing what went wrong.
  • statusCode: HTTP status code from the failed request.
  • response: Response body or text from the SOAR API, if available.
  • caseName: The case name parameter value related to the failed update.

The node does not output binary data.

Dependencies

  • Requires access to a SOAR API endpoint that supports task updates via HTTP PUT requests.
  • Needs an API authentication token credential to authorize requests to the SOAR API.
  • The node expects the token to be provided through n8n credentials configuration.
  • The HTTP request includes headers with the token and sets the language preference to Vietnamese (Accept-Language: vi).

Troubleshooting

  • Common issues:

    • Incorrect or missing SOAR API URL can cause connection failures.
    • Invalid or expired API token will result in authorization errors.
    • Malformed JSON in the Attachment IDs property may cause parsing errors.
    • Missing required properties like task name or code can lead to API rejection.

  • Error messages:

    • Errors during the HTTP request are logged with detailed information including status codes and response bodies.
    • If the node is set to stop on failure, it throws a detailed error containing the message, status code, response content, URL, and request body.
    • To resolve errors, verify all input parameters, ensure the API token is valid, and confirm the SOAR API endpoint is reachable and correctly formatted.

Links and References

Discussion