[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Patch Remediation Connection By ID

Description

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

Request

Request

URL

URL


patch
https://{api_host}tcsa.host.com/connections/{connection_id}
Copy

Path Parameters

Path Parameters

string
connection_id Required

connection name.


Request Body

Request Body

RemediationConnection of mimetype application/json Required
{
    "conn_type": "http",
    "connection_id": "tco_jira",
    "host": "https://jira.eng.vmware.com/",
    "login": "username"
}
string
conn_type Required

either http or slackwebhook

Possible values are: httpslackwebhook


string
connection_id Required

name of the connection


string
host Required

host URL of the external service


string
login Required

user login


string
description Optional

connection description


string
extra Optional

HTTP header with Auth info


string
password Optional

user password


string
port Optional

external service port for DB connections


string
schema Optional

external service schema for DB connections

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

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

either http or slackwebhook

Possible values are: httpslackwebhook


string
connection_id Required

name of the connection


string
host Required

host URL of the external service


string
login Required

user login


string
description Optional

connection description


string
extra Optional

HTTP header with Auth info


string
password Optional

user password


string
port Optional

external service port for DB connections


string
schema Optional

external service schema for DB connections

Errors

Errors

400

Invalid Request sent by the user


404

resouce not found


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"RemediationConnection":{"conn_type":"http","connection_id":"tco_jira","description":"JIRA connection","host":"https://jira.eng.vmware.com/","login":"username","port":"","schema":""},"conn_type":"http","connection_id":"tco_jira","description":"JIRA connection","host":"https://jira.eng.vmware.com/","login":"username","port":"","schema":""}' https://{api_host}tcsa.host.com/connections/{connection_id}


Feedback

Was this page helpful?