Remediation Get Policy

Remediation Get Policy

policy name.

Request
URI
GET
https://{api_host}/tcsa.host.com/remediation-rest/policy/{policy_name}
COPY
Path Parameters
string
policy_name
Required

policy name.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RemediationPolicy of type(s) application/json
{
    "action_name": "slack_action",
    "category": "",
    "conditions": [
        {
            "condition": "OR",
            "filters": [
                {
                    "condition": "AND",
                    "expression": "match",
                    "property": "Category",
                    "value": "Availability"
                },
                {
                    "condition": null,
                    "expression": "match",
                    "property": "Certainty",
                    "value": "100"
                }
            ]
        },
        {
            "condition": null,
            "filters": [
                {
                    "condition": null,
                    "expression": "match",
                    "property": "InstanceName",
                    "value": "C8-C7-C8-C3-5B-1C"
                }
            ]
        }
    ],
    "connections": "[{\"task_post_slack_conn_id\": \"slack_connection\"}]",
    "created_on": "27 Oct, 2023, 18:41:25 UTC",
    "description": "example rule",
    "events": [
        {
            "class": "WirelessAccessPoint",
            "condition": null,
            "name": "Down",
            "type": "problem"
        }
    ],
    "last_updated": "27 Oct, 2023, 18:41:25 UTC",
    "parameters": "[{\"slack_message\": \"TCSA slack\"}, {\"slack_channel\": \"#tcsa-notifs\"}]",
    "path_type": "remediation",
    "paths": [
        {
            "condition": {
                "expression": "match",
                "property": "",
                "value": ""
            },
            "levels": [
                {
                    "action": "slack_action",
                    "connections": [
                        {
                            "task_post_slack_conn_id": "slack_connection"
                        }
                    ],
                    "duration": 1,
                    "level_description": "",
                    "level_name": "level0",
                    "parameters": [
                        {
                            "slack_message": "TCSA slack"
                        },
                        {
                            "slack_channel": "#tcsa-notifs"
                        }
                    ]
                }
            ],
            "path_description": "",
            "path_name": "Path0"
        }
    ],
    "policy_name": "examplerule",
    "policy_type": "automated",
    "state": "enable",
    "userName": "admin",
    "user_context": "{\"enterprise\":\"DEFAULT\",\"groups\":[\"Enterprise Administrator\"],\"organization\":\"DEFAULT\",\"roles\":[\"Enterprise Administrator\"],\"username\":\"admin\"}"
}
string
policy_name
Required

remediation rule name

string
policy_type
Required

either manual or automated

string
path_type
Required

either remediation or escalation

string
state
Optional

optional either enable or disable

array of object
events
Required

JSON list of dicts containing class, name and type fields.

array of object
conditions
Optional

JSON list of dicts containing propName, operation and propValue fields.

array of object
paths
Required

JSON list of dicts containing paths, levels and action names. The paths.levels.duration and paths.condition are mandatory for escalation policy.

string
created_on
Optional

rule creation timestamp

string
last_updated
Optional

rule last update timestamp

integer
duration
Optional

in case of escalation it is the time value in minutes, upon expiry the level's action will be triggered.

string
stop_criteria
Optional

optional field to specify escalation stop criteria. Either clear or ack, default value is clear


400

Invalid Request sent by the user

Returns ErrorDetails of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


404

Cannot find requested resource

Returns ErrorDetails of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


500

Internal server error

Returns ErrorDetails of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution