Set System Counter

This command assigns a specific value to the system counter.

Implementation	System
Command Category	System Utility
Tags	LOCAL SHARED DATA CONTEXT DATA SYSTEM COUNTER

Inputs

Parameter Name	Required/Optional	Description	Sample Data
System Counter Name	Required	The name of the system counter	`MyCounter`
Value	Required	The value to set to the specified system counter	`5`

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

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

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": {
    "System Counter Name": <System Counter Name here>,
    "Value": <Value here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
System Counter Name	`Text`	Required	The name of the system counter
Value	`Number`	Required	The value to set to the specified system counte

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "System Counter Name": "MyCounter",
    "Value": 5
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "5",
}