IMPORTANT: No additional bug fixes or documentation updates will be released for this version.
Update connectoredit
Updates a connector.
Request URLedit
PUT <kibana host>:<port>/api/action/<connector ID>
URL partsedit
The URL must include the connector ID
of the connector you are updating.
Call Find connectors to retrieve connector IDs.
Request bodyedit
A 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:
|
Yes |
|
String |
The registered ServiceNow connector. |
Yes |
Name | Type | Description | Required |
---|---|---|---|
|
Object |
Contains a
|
Yes |
|
String |
URL of the third-party instance. |
Yes |
|
String |
Jira project key. |
For Jira connectors, yes. For ServiceNow connectors, no. |
Example requestedit
Updates the description
field mapping of connector ID
61787f53-4eee-4741-8df6-8fe84fa616f7
:
PUT api/action/61787f53-4eee-4741-8df6-8fe84fa616f7 { "name": "ServiceNow", "config": { "apiUrl": "https://dev78437.service-now.com", "casesConfiguration": { "mapping": [ { "source": "title", "target": "short_description", "actionType": "overwrite" }, { "source": "description", "target": "description", "actionType": "append" }, { "source": "comments", "target": "comments", "actionType": "append" } ] } }, "secrets": { "username": "admin", "password": "securePassword123!" } }
Response codeedit
-
200
- Indicates a successful call.
Response payloadedit
The updated JSON connector object.
Example responseedit
{ "id": "61787f53-4eee-4741-8df6-8fe84fa616f7", "actionTypeId": ".servicenow", "name": "ServiceNow", "config": { "apiUrl": "https://dev78437.service-now.com", "casesConfiguration": { "mapping": [ { "source": "title", "target": "short_description", "actionType": "overwrite" }, { "source": "description", "target": "description", "actionType": "append" }, { "source": "comments", "target": "comments", "actionType": "append" } ] } } }