Create Remediation Connection

Create Remediation Connection

This API is used for creating a new remediation connection.

Request
URI
POST
https://{api_host}/tcsa.host.com/remediation-rest/connections
COPY
Request Body
RemediationConnection of type(s) application/json
Required

Show optional properties

{
    "conn_type": "http",
    "connection_id": "jira_connection",
    "host": "https://jira.eng.vmware.com/",
    "login": "username"
}
{
    "connection_id": "jira_connection",
    "description": "string",
    "host": "string",
    "login": "string",
    "password": "string",
    "port": "string",
    "schema": "string",
    "extra": "string"
}
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

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns RemediationConnection of type(s) application/json
{
    "conn_type": "http",
    "connection_id": "jira_connection",
    "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

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure