Get Global List Values by JSON Paths‎

POST /Command/GetListValues

Gets values from global list by specified JSON paths.

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.
Global List Name	`string`	Optional	The name of the global list to extract from.
JSON Paths	`array<string>`	Optional	The JSON paths used to retrive data from the specified global list.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "JSON Paths": [
      "$.SystemName",
      "$.GroupID"
    ]
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

JSON

{
    "error": "",
    "returnData": [
      "D3Lab-AD",
      "2",
      "D3LABxx",
      "2",
      "D3CYBER-xx",
      "7"
    ],
    "contextData": [
      "D3Lab-AD",
      "2",
      "D3LABxx",
      "2",
      "D3CYBER-xx",
      "7"
  ]
}

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."}