Create a custom integration

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

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
}

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body