Create a custom integration

Base URL: https://{kibana_url}

POST /api/fleet/epm/custom_integrations
POST /s/{space_id}/api/fleet/epm/custom_integrations

Auth

Create a new custom integration package with user-defined data streams.

Required privileges

Privileges integrations-all and fleet-agent-policies-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

datasets object[] · max items: 10 required
force boolean
integrationName string required

Responses

Successful response

application/json

_meta object required
items union anyOf[] · max items: 10000 required: Any of:

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new custom integration

Console Kibana Dev Tools

POST kbn:/api/fleet/epm/custom_integrations
{
  "datasets": [
    {
      "name": "my_custom_logs.access",
      "type": "logs"
    }
  ],
  "integrationName": "my_custom_logs"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/epm/custom_integrations" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "datasets": [
      {
        "name": "my_custom_logs.access",
        "type": "logs"
      }
    ],
    "integrationName": "my_custom_logs"
  }'

Generated from the API spec

Response

Custom integration successfully created

{
  "_meta": {
    "install_source": "custom"
  },
  "items": [
    {
      "id": "my_custom_logs-logs-my_custom_logs.access",
      "type": "index_template"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}