Overwrite Global List

Overwrite the specified global list content by the given JSON Object Array.

Implementation	System
Command Category	System Utility
Tags	GLOBAL LIST

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Global List Name

Optional

The name of the global list.

MacToSysNameMappingList

Global List Content

Optional

The content used to overwrite the global list.

CODE

[
    {
        "GroupID": 2,
        "SystemName": "D3Lab-AD",
        "MACAddress": "020806A536C7"
    },
    {
        "GroupID": 2,
        "SystemName": "D3LAB02",
        "MACAddress": "090706B536C3"
    },
    {
        "GroupID": 7,
        "SystemName": "D3CYBER-PC1",
        "MACAddress": "000C29D5765F"
    }
]

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

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "GroupID": 2,
        "SystemName": "D3Lab-AD",
        "MACAddress": "020806A536C7"
    },
    {
        "GroupID": 2,
        "SystemName": "D3LAB02",
        "MACAddress": "090706B536C3"
    },
    {
        "GroupID": 7,
        "SystemName": "D3CYBER-PC1",
        "MACAddress": "000C29D5765F"
    }
]

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/OverwriteGlobalList

Headers

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

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Global List Name": "<Global List Name here>",
    "Global List Content": "<Global List Content 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.
Global List Name	`Text`	Optional	The name of the global list.
Global List Content	`JSON Array`	Optional	The content used to overwrite the global list.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "Global List Content": [
      {
        "GroupID": 2,
        "SystemName": "D3Lab-AD",
        "MACAddress": "020806A536C7"
      },
      {
        "GroupID": 2,
        "SystemName": "D3LAB02",
        "MACAddress": "090706B536C3"
      },
      {
        "GroupID": 7,
        "SystemName": "D3CYBER-PC1",
        "MACAddress": "000C29D5765F"
      }
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.
contextData	`JSON Array`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
      {
          "GroupID": 2,
          "SystemName": "D3Lab-AD",
          "MACAddress": "020806A536C7"
      },
      {
          "GroupID": 2,
          "SystemName": "D3LAB02",
          "MACAddress": "090706B536C3"
      },
      {
          "GroupID": 7,
          "SystemName": "D3CYBER-PC1",
          "MACAddress": "000C29D5765F"
      }
    ]
}