Remediation Update Action

This API is used for updating a remediation action. Update API expects all parameters retrived via get API. Fields "action_name", "file_type", "created_on" and "last_updated" are read-only and can't be updated. Any missing non mandatory field in update request, will be set to default values.

Request

URI

PUT

https://{api_host}/remediation-rest/actions/{action_name}

COPY

Path Parameters

string

action_name

Required

Unique id, to indentify the action

Request Body

RemediationAction of type(s) application/json

Required

Show optional properties

{
    "action_name": "slack_action",
    "file_type": "PYTHON",
    "params": [
        {
            "parameterName": "slack_message",
            "option": "mandatory"
        },
        {
            "parameterName": "slack_channel",
            "option": "mandatory"
        }
    ]
}

{
    "action_name": "string",
    "file_data": "string",
    "created_on": "string",
    "last_updated": "string",
    "params": [
        {}
    ]
}

string

action_name

Required

Name of the remediation action

file_type

Required

either PYTHON or YAML

Possible values are : PYTHON, YAML,

string

file_data

Optional

file content

string

created_on

Optional

action creation timestamp

string

last_updated

Optional

action last update timestamp

array of object

params

Required

list of string parameterName and option, option can be mandatory or optional

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

201

Created

Operation doesn't return any data structure

400

Invalid Request sent by the user

Operation doesn't return any data structure

404

resouce not found

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"action_name:"string","file_type":"{}","params":["object"]}' https://{api_host}/remediation-rest/actions/{action_name}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Remediation Rest Operations

GET

Remediation Get Policies