Create Tenant Data Ingestion Schedule‎

POST /Command/CreateTenantDataIngestionSchedule

Sync schedule to tenant instance.

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.
Integration Name	`string`	Required	Integration name which needs create schedule
Data Ingestion Connection	`string`	Required	Connection to create data ingestion schedule
Is Fetch Incident Or Event	`string`	Required	Intake data type (Options: “Event Intake” or “Incident Intake”)
Is Shared To Client Connection	`boolean`	Required	Specify if use shared client site. The default value is false.
Tenant Region	`string`	Required	Region of the tenant
Tenant Name	`string`	Required	Name of the tenant
Tenant Site	`string`	Required	Site of the tenant
Schedule Interval	`integer`	Required	Set the interval minutes for the schedule
Event Playbook	`string`	Optional	Event playbook name
Enable Email Notification	`boolean`	Optional	Enable send email notification if schedule failed
Max Attempts	`integer`	Optional	The number of consecutive fetch failed to send email notification
Command Details	`JSON Object`	Optional	The details for command parameters
JSON Path For Site	`string`	Optional	JSON path for site
Global List For Site Mapping	`string`	Optional	Global list for site mapping

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Integration Name": "Test Integration Name",
    "Data Ingestion Connection": "Test Connection Name",
    "Is Fetch Incident Or Event": "Event Intake",
    "Is Shared To Client Connection": false,
    "Tenant Region": "AMER",
    "Tenant Name": "Test Tenant",
    "Tenant Site": "Test Tenant Site",
    "Schedule Interval": 5,
    "Event Playbook": "Event Playbook",
    "Enable Email Notification": false,
    "Max Attempts": 5,
    "Command Details": {
      "Start Time": "2023-01-01 1:00:00",
      "End Time": "2023-01-02 3:00:00",
      "Top Recent Event Number": "5",
      "Search Condition": "search condition"
    },
    "JSON Path For Site": "$.Site",
    "Global List For Site Mapping": "Global list"
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": "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."}