Update connector
editUpdate connector
editUpdates a connector.
Console supports only Elasticsearch APIs. Console doesn’t allow interactions with Kibana APIs. You must use curl
or another HTTP tool instead. For more information, refer to Run Elasticsearch API requests.
Request URL
editPUT <kibana host>:<port>/api/actions/connector/<connector ID>
URL parts
editThe URL must include the connector ID
of the connector you are updating.
Call Find connectors to retrieve connector IDs.
Request body
editA JSON object with the fields you want to update:
Name | Type | Description | Required |
---|---|---|---|
|
Object containing the action’s configuration. |
Yes |
|
|
Object |
Object containing the third-party account information used to create and update incidents. For ServiceNow connectors:
For Jira connectors:
For IBM Resilient connectors:
For Swimlane connectors:
|
Yes |
|
String |
The connector’s name. |
Yes |
Name | Type | Description | Required |
---|---|---|---|
|
String |
URL of the third-party instance. |
Yes |
|
String |
The type of the connector. Must be one of these:
|
For Swimlane connectors, yes. For other connectors, no. |
|
Object |
The field mapping. Must be:
The object of each attribute in the
|
For Swimlane connectors, yes. or other connectors, no. |
|
String |
Jira project key. |
For Jira connectors, yes. For other connectors, no. |
|
String |
IBM Resilient organization ID. |
For IBM Resilient connectors, yes. For other connectors, no. |
Example request
editUpdates the description
field mapping of connector ID
61787f53-4eee-4741-8df6-8fe84fa616f7
:
PUT api/actions/connector/61787f53-4eee-4741-8df6-8fe84fa616f7 { "config": { "apiUrl": "https://dev357417.service-now.com", }, "name": "SN API", "secrets": { "password": "stongpassword123!", "username": "admin" } }
Response code
edit-
200
- Indicates a successful call.