Get System Counter
This command retrieves the current value of 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 | Optional | The name of the system counter |
|
Output
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
https:/{base_url}/{api_namespace}/api/Command/GetCounter
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": <Username here>,
"Site": <Site here>,
"CommandParams": {
"System Counter Name": <System Counter Name here>
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
System Counter Name |
| Optional | The name of the system counter |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"System Counter Name": "MyCounter"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": "5",
}