Update a connector | Kibana API (v8)

Update a connector Deprecated

PUT /api/actions/action/{actionId}

Deprecated in 7.13.0. Use the update connector API instead.

Headers

kbn-xsrf string Required

Cross-site request forgery protection

Path parameters

actionId string Required

An identifier for the action.

application/json; Elastic-Api-Version=2023-10-31

Body Required

The properties vary depending on the connector type.

config object

The new connector configuration. Configuration properties vary depending on the connector type.
name string

The new name for the connector.
secrets object

The updated secrets configuration for the connector. Secrets properties vary depending on the connector type.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Indicates a successful call.
Hide response attributes Show response attributes object
The properties vary depending on the action type.
- actionTypeId string
- config object
- id string
- isDeprecated boolean
  
  Indicates whether the action type is deprecated.
- isMissingSecrets boolean
  
  Indicates whether secrets are missing for the action.
- isPreconfigured boolean
  
  Indicates whether it is a preconfigured action.
- name string
404 application/json; Elastic-Api-Version=2023-10-31

Object is not found.
Hide response attributes Show response attributes object
- error string
  
  Value is Not Found.
- message string
- statusCode integer
  
  Value is 404.

PUT /api/actions/action/{actionId}

curl \
 -X PUT https://localhost:5601/api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "config": {},
  "name": "string",
  "secrets": {}
}

Response examples (200)

{
  "actionTypeId": "string",
  "config": {},
  "id": "string",
  "isDeprecated": true,
  "isMissingSecrets": true,
  "isPreconfigured": true,
  "name": "string"
}

Response examples (404)

{
  "error": "Not Found",
  "message": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found",
  "statusCode": 404
}