Get Remediation Connection By Id

Get Remediation Connection By Id

connection name.

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

connection name.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RemediationConnection of type(s) application/json 
{
    "conn_type": "http",
    "connection_id": "tco_jira",
    "description": "JIRA connection",
    "host": "https://jira.eng.vmware.com/",
    "login": "username",
    "port": "",
    "schema": ""
}
string
connection_id
Required

name of the connection

conn_type
Required

either http or slackwebhook

Possible values are : http, slackwebhook, ssh,
string
description
Optional

connection description

string
host
Required

host URL of the external service

string
login
Required

user login

string
password
Optional

user password

string
port
Optional

external service port for DB connections

string
schema
Optional

external service schema for DB connections

string
extra
Optional

HTTP header with Auth info


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


On This Page
Remediation Rest Operations
POST
Create Remediation Connection
GET
Get All Remediation Connections
GET
Get Remediation Connection By Id
POST
Get Remediation Servertools
PATCH
Patch Remediation Connection By Id
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