Patch Remediation Variable

Patch Remediation Variable

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

Request
URI
PATCH
https://{api_host}/tcsa.host.com/variables/{variable_key}
COPY
Path Parameters
string
variable_key
Required

Unique id, to indentify the parameter

Request Body
RemediationVariable of type(s) application/json
Required

Show optional properties

{
    "description": "test variable",
    "key": "testing",
    "value": "123"
}
{
    "key": "string",
    "value": "string",
    "description": "string"
}
string
key
Required

Name of the remediation parameter

string
value
Required

value associated with the key

string
description
Required

description of the parameter

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns RemediationVariable of type(s) application/json 
{
    "description": "test variable",
    "key": "testing",
    "value": "123"
}
string
key
Required

Name of the remediation parameter

string
value
Required

value associated with the key

string
description
Required

description of the parameter


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

On This Page
Remediation Rest Operations
POST
Create Remediation Connection
POST
Create Remediation Variable
DELETE
Delete Remediation
GET
Get All Dagrunstatus
GET
Get All Remediation Connections
GET
Get All Remediation Variables
GET
Get Dagrunstatus By Dag Run Id
GET
Get Remediation Connection By Id
POST
Get Remediation Servertools
GET
Get Remediation Variable By Key
PATCH
Patch Remediation Connection By Id
PATCH
Patch Remediation Variable
POST
Remediation Create Action
POST
Remediation Create Policy
DELETE
Remediation Delete Action
DELETE
Remediation Delete Connection By Id
DELETE
Remediation Delete Policy By Id
GET
Remediation Get Action
GET
Remediation Get Actions All
GET
Remediation Get Policies
GET
Remediation Get Policy
POST
Remediation Run Action
PUT
Remediation Update Action
PUT
Remediation Update Policy