Perform Remediation Action on Event
For API version information, refer to the API Version History section.
Non-Versioned
This API allows you to take remediation actions on selected events.
Input Parameters for Remediation Action on EventInput Parameters for Remediation Action on Event
Input Parameters |
Mandatory/Optional |
Format |
Description |
---|---|---|---|
Authorization |
Mandatory |
String |
Authorization token to authenticate to the Qualys Enterprise TruRisk™ Platform. Prepend token with "Bearer" and one space. For example - Bearer authToken |
user |
Mandatory |
String |
Name of the user associated with the action. |
userId | Mandatory | String | User Id of the user associated with the action. |
comment | Optional | String | Use the comment parameter to mention the reason behind the action. |
Sample - Perform Remediation Action on EventSample - Perform Remediation Action on Event
API request
curl -X POST "<qualys_base_url>/ioc/remediation-actions/performAction?user=username&userId=XXc42aXX-03XX-XXdd-aXX8-42fXXXd7cXXX" --header "accept: */*" --header "Authorization: Bearer <token>"-H "Content-Type: application/json" -d "<JSON payload>"
Sample JSON Payload
[
{
"actionId": 0,
"agentId": "XXX85f64-5XX7-XX62-b3XX-XX963f6XXfaX",
"eventId": "string",
"eventType": "string",
"pid": 0,
"uniqueId": "string"
}
]
Response
{ "remediationIds": [ "RTF_4ea39afb-be5a-47a3-ae66-cdcfe0494007_2-2025_2c3afaac-66be-3c1f-adc1-54d41e90336a" ] }
Response Field DescriptionsResponse Field Descriptions
Dataset Name |
Field Name |
Data Type |
Description |
---|---|---|---|
remediation-action | remediationIds | Array of Strings | A list of unique identifiers for the remediation actions. Each ID corresponds to a specific remediation event. |
V1.0
This API allows you to take remediation actions on selected events.
Input Parameters for Remediation Action on EventInput Parameters for Remediation Action on Event
Input Parameters |
Mandatory/Optional |
Format |
Description |
---|---|---|---|
Authorization |
Mandatory |
String |
Authorization token to authenticate to the Qualys Enterprise TruRisk™ Platform. Prepend token with "Bearer" and one space. For example - Bearer authToken |
user |
Mandatory |
String |
Name of the user associated with the action. |
userId | Mandatory | String | User Id of the user associated with the action. |
comment | Optional | String | Use the comment parameter to mention the reason behind the action. |
Sample - Perform Remediation Action on EventSample - Perform Remediation Action on Event
API request
curl -X POST "<qualys_base_url>/ioc/v1/remediation-actions/performAction?user=username&userId=XXc42aXX-03XX-XXdd-aXX8-42fXXXd7cXXX" --header "accept: */*" --header "Authorization: Bearer <token>"-H "Content-Type: application/json" -d "<JSON payload>"
Sample JSON Payload
[
{
"actionId": 0,
"agentId": "XXX85f64-5XX7-XX62-b3XX-XX963f6XXfaX",
"eventId": "string",
"eventType": "string",
"pid": 0,
"uniqueId": "string"
}
]
Response
{ "remediationIds": [ "RTF_4ea39afb-be5a-47a3-ae66-cdcfe0494007_2-2025_2c3afaac-66be-3c1f-adc1-54d41e90336a" ] }
Response Field DescriptionsResponse Field Descriptions
Dataset Name |
Field Name |
Data Type |
Description |
---|---|---|---|
remediation-action | remediationIds | Array of Strings | A list of unique identifiers for the remediation actions. Each ID corresponds to a specific remediation event. |
API Version History
The following table depicts the information about the different versions of this API along with the status:
API Version | API Status | Release Date |
/ioc/remediation-actions/performAction | Active | |
/ioc/v1/remediation-actions/performAction | Active | May 2025 |