Remediation Run Action

This API is used to trigger execution of a manual remediation rule. Rule name, action name and Notification data should be part of the relevant payload.

Request

URI

POST

https://{api_host}/runaction

COPY

Request Body

RemediationRunAction of type(s) application/json

Required

Show optional properties

{
    "ActionName": "rule1:slack_action",
    "NotificationId": {
        "UserDefined8": "",
        "TroubleTicketID": "",
        "UserDefined9": "",
        "UserDefined6": "",
        "Owner": "",
        "UserDefined7": "",
        "InMaintenance": false,
        "SourceInfo": "INCHARGE-AM-PM",
        "IsProblem": true,
        "EventType": "DURABLE",
        "IsLiveNotification": true,
        "ProcessedTimeStamp": 1573652238482,
        "UserDefined1": "VMWARE",
        "InstanceDisplayName": "us-kir-6thb-01-03",
        "UserDefined4": "",
        "UserDefined5": "",
        "UserDefined2": "BANGALORE",
        "ElementClassName": "WirelessAccessPoint",
        "Name": "NOTIFICATION-WirelessAccessPoint_C8-C7-C8-C3-5B-1C_Down",
        "UserDefined3": "",
        "LastModified": null,
        "PollingID": null,
        "EventText": "IndicatesthatafailureonaWirelessAccessPointistherootcause.",
        "ElementName": "C8-C7-C8-C3-5B-1C",
        "LastChangedAt": 1697834351000,
        "LastClearedAt": null,
        "elementUUID": "C8-C7-C8-C3-5B-1C$WirelessAccessPoint$INCHARGE-SA-PRES",
        "Impact": 0,
        "deviceType": "WirelessAccessPoint",
        "UserDefined19": "",
        "UserDefined18": "",
        "UserDefined17": "",
        "UserDefined16": "",
        "HasCauses": false,
        "UserDefined15": "",
        "UserDefined14": "",
        "UserDefined13": "",
        "OriginalSources": [],
        "NotificationStates": [
            {
                "syncTimestamp": 1573652238482,
                "eventState": "ACTIVE",
                "source": "INCHARGE-SA-PRES",
                "eventTimestamp": 1573652238000,
                "syncId": 1685727630939
            }
        ],
        "tags": {
            "location": "NewYork",
            "customer": "Acme"
        },
        "InstanceName": "C8-C7-C8-C3-5B-1C",
        "DeDupKey": "Name:NOTIFICATION-WirelessAccessPoint_C8-C7-C8-C3-5B-1C_Down$Source:INCHARGE-SA-PRES$",
        "Active": true,
        "ToolInfo": null,
        "AcknowledgmentTime": null,
        "LastNotifiedAt": null,
        "State": null,
        "SourceDomainName": "INCHARGE-AM-PM",
        "UserDefined20": "",
        "Acknowledged": false,
        "IsRoot": true,
        "Category": "Availability",
        "EventDisplayName": "Down",
        "Certainty": 50,
        "elementUUID_PM": "C8-C7-C8-C3-5B-1C$WirelessAccessPoint$",
        "Source": "INCHARGE-SA-PRES-TEST",
        "UserDefined12": "",
        "ClassName": "WirelessAccessPoint",
        "DisplayName": "WirelessAccessPoint Down 100.0%: us-kir-6thb-01-03",
        "instanceUUID": "C8-C7-C8-C3-5B-1C$WirelessAccessPoint$INCHARGE-SA-PRES",
        "UserDefined11": "",
        "UserDefined10": "",
        "FirstNotifiedAt": 1697834351000,
        "EventState": "ACTIVE",
        "Severity": 1,
        "EventName": "Down",
        "SourceSpecific": "primary",
        "ClassDisplayName": "WirelessAccessPoint",
        "OccurrenceCount": 1,
        "PollingState": "POLLING-STARTED",
        "ClearOnAcknowledge": false,
        "SourceEventType": "PROBLEM"
    }
}

{
    "ActionName": "rule1:slack_action",
    "NotificationId": {}
}

string

ActionName

Required

remediation rule name and action name separated by colon symbol

object

NotificationId

Required

Notification object

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

success

Operation doesn't return any data structure

400

Invalid Request sent by the user

Operation doesn't return any data structure

404

Not Found Remediation action rule_name:action_name currently unavailable for execution.\nPlease retry in a few minutes

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"ActionName:"string","NotificationId:"object"}' https://{api_host}/runaction

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Remediation Rest Operations

GET

Remediation Get Policies

GET