Skip to main content
Skip table of contents

Delay

This command can only be executed within an event/incident playbook and delays the playbook's execution for the specified time in seconds.

Reader Note

Please note that this command is only applicable within an event Playbook.

Implementation

System

Command Category

System Utility

Tags

PLAYBOOK

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Seconds

Optional

The time in seconds to delay the playbook execution

20

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
20

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE
https:/{base_url}/{api_namespace}/api/Command/Delay

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

CODE
{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Site Name": "<SiteName here>",
    "Site Description": "<Site Description here>",
    "Site Type": "<Site Type here>",
    "Shared Connection": "<Shared Connection here>",
    "Is Active": "<Is Active here>",
    "Time Zone": "<Time Zone here>",
    "Language": "<Language here>",
    "Is Master": "<Is Master here>"
  }
}

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.

Seconds

Number

Optional

The time in seconds to delay the playbook execution

Sample Request

SAMPLE DATA

CODE
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Seconds": 20
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

Number

The return data from the API request.

Sample Response

CODE
{
    "error":"",
    "returnData":"20",
    "rawData":"",
    "contextData":"",
    "outputData":""
JavaScript errors detected

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

If this problem persists, please contact our support.