Skip to main content
Skip table of contents

Modify Incident Form‎

LAST UPDATED: OCT 29, 2024

POST /Command/ModifyIncidentForm

Modifies the incident forms by either adding or deleting a section.

CAUTION

When a section is removed from a specific incident type, all incidents of that type will lose the section along with any associated dynamic field values.

READER NOTE

Only reusable form items can be added via this command.

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

Incident Types

array<string>

Required

The incident types to be modified.

Section

string

Required

The section to be added or deleted.

Action

string

Required

The modification performed. The options are:

  • Add

  • Delete

Actions will execute idempotently, making no changes when adding a section that already exists or deleting a section that does not exist.

Body Sample Data

application/json
JSON
{
    "Username": "Admin",
    "Site": "Security Operations",
    "CommandParams": {
        "Incident Types": [
            "demo_incident_form"
        ],
        "Section": "Privilege Escalation",
        "Action": "Delete"
    }
}

Response

200 OK

application/json

Response Fields

Field Name

Type

Description

error

string

The error message if the command execution failed.

returnData

string

The return data from the API request.

Sample Data

JSON
{
    "error": "",
    "returnData": {
        "Status": "Successful"
    }
}

400 BadRequest

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "Unexpected Error."}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.