Get a managed integration | Kibana API documentation

Get a managed integration Experimental; added in 9.5.0

GET /api/fleet/managed_integrations/{policyId}

Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/managed_integrations/{policyId}

Refer to Spaces for more information.

Get a managed integration by ID

Path parameters

policyId string Required

The ID of the managed integration to retrieve.

Maximum length is 256.

Responses

200 application/json

Indicates a successful response
Hide response attribute Show response attribute object
- item object Required
  
  Additional properties are NOT allowed.
  
  Hide item attributes Show item attributes object
  
  additional_datastreams_permissions array[string]
  
  Additional data stream permissions granted to the managed integration.
  
  Not more than 1000 elements. Maximum length of each is 256.
  
  cloud_connector object
  
  Additional properties are NOT allowed.
  
  Hide cloud_connector attributes Show cloud_connector attributes object
  
  cloud_connector_id string Required
  
  The ID of the cloud connector.
  
  Maximum length is 255.
  
  enabled boolean Required
  
  Whether the cloud connector is active for this policy.
  
  created_at string Required
  
  Creation timestamp (ISO 8601).
  
  Maximum length is 64.
  
  created_by string Required
  
  User who created the policy.
  
  Maximum length is 1024.
  
  description string
  
  Managed integration description.
  
  Maximum length is 2048.
  
  global_data_tags array[object]
  
  Custom data tags applied to all data produced by this policy.
  
  Not more than 100 elements.
  
  Hide global_data_tags attributes Show global_data_tags attributes object
  
  name string Required
  
  The name of the custom field.
  
  Maximum length is 1024.
  
  value string | number Required
  
  The value of the custom field.
  
  Any of:
  string-1 string number-2 number
  
  Maximum length is 1024.
  
  id string Required
  
  Managed integration unique identifier.
  
  Maximum length is 255.
  
  inputs object Required
  
  Package policy inputs. Refer to the integration documentation to know which inputs are available.
  
  Hide inputs attribute Show inputs attribute object
  
  * object Additional properties
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  condition string | null
  
  Agent condition expression to evaluate whether to apply this input.
  
  Maximum length is 10000.
  
  deprecated object
  
  Additional properties are NOT allowed.
  
  Hide deprecated attributes Show deprecated attributes object
  
  description string Required
  
  Maximum length is 4096.
  
  replaced_by object
  
  Hide replaced_by attribute Show replaced_by attribute object
  
  * string Additional properties
  
  Maximum length is 1024.
  
  since string
  
  Maximum length is 50.
  
  enabled boolean
  
  Enable or disable that input. Defaults to true (enabled).
  
  streams object
  
  Input streams. Refer to the integration documentation to know which streams are available.
  
  Hide streams attribute Show streams attribute object
  
  * object Additional properties
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  condition string | null
  
  Agent condition expression to evaluate whether to apply this stream.
  
  Maximum length is 10000.
  
  deprecated object
  
  Additional properties are NOT allowed.
  
  Hide deprecated attributes Show deprecated attributes object
  
  description string Required
  
  Maximum length is 4096.
  
  replaced_by object
  
  Hide replaced_by attribute Show replaced_by attribute object
  
  * string Additional properties
  
  Maximum length is 1024.
  
  since string
  
  Maximum length is 50.
  
  enabled boolean
  
  Enable or disable that stream. Defaults to true (enabled).
  
  var_group_selections object
  
  Variable group selections. Maps var_group name to the selected option name within that group.
  
  Hide var_group_selections attribute Show var_group_selections attribute object
  
  * string Additional properties
  
  Maximum length is 1024.
  
  vars object
  
  Input/stream level variable. Refer to the integration documentation for more information.
  
  vars object
  
  Input/stream level variable. Refer to the integration documentation for more information.
  
  name string Required
  
  Managed integration name.
  
  Maximum length is 255.
  
  namespace string
  
  Policy namespace. Defaults to the agent policy namespace.
  
  Maximum length is 100.
  
  package object Required
  
  Additional properties are NOT allowed.
  
  Hide package attributes Show package attributes object
  
  name string Required
  
  Integration package name.
  
  Maximum length is 255.
  
  title string Required
  
  Integration package display title.
  
  Maximum length is 255.
  
  version string Required
  
  Integration package version.
  
  Maximum length is 50.
  
  updated_at string Required
  
  Last update timestamp (ISO 8601).
  
  Maximum length is 64.
  
  updated_by string Required
  
  User who last updated the policy.
  
  Maximum length is 1024.
  
  var_group_selections object
  
  Variable group selections. Maps var_group name to the selected option name within that group.
  
  Hide var_group_selections attribute Show var_group_selections attribute object
  
  * string Additional properties
  
  Maximum length is 1024.
  
  vars object
  
  Input/stream level variable. Refer to the integration documentation for more information.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- attributes Required
- error string
- errorType string
- message string Required
- statusCode number
404 application/json

Not Found
Hide response attribute Show response attribute object
- message string Required

GET /api/fleet/managed_integrations/{policyId}

curl \
 --request GET 'https://localhost:5601/api/fleet/managed_integrations/{policyId}' \
 --header "Authorization: $API_KEY"

Response examples (200)

Example response for getting a managed integration by ID

{
  "item": {
    "created_at": "2025-11-06T18:27:43.541Z",
    "created_by": "test_user",
    "description": "test",
    "id": "d52a7812-5736-4fdc-aed8-72152afa1ffa",
    "inputs": {
      "ESS Billing-cel": {
        "enabled": true,
        "streams": {
          "ess_billing.billing": {
            "enabled": true,
            "vars": {
              "hide_sensitive": true,
              "http_client_timeout": "30s",
              "lookbehind": 365,
              "tags": [
                "forwarded",
                "billing"
              ]
            }
          },
          "ess_billing.credits": {
            "enabled": false
          }
        },
        "vars": {
          "api_key": {
            "id": "QY1sWpoBbWcMW-edr0Ee",
            "isSecretRef": true
          },
          "organization_id": "1234",
          "url": "https://billing.elastic-cloud.com"
        }
      }
    },
    "name": "ess_billing-1",
    "namespace": "default",
    "package": {
      "name": "ess_billing",
      "title": "Elasticsearch Service Billing",
      "version": "1.6.0"
    },
    "updated_at": "2025-11-06T18:27:43.541Z",
    "updated_by": "test_user"
  }
}

Response examples (400)

Example of a generic error response

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

Response examples (404)

Example of a not found error response

{
  "message": "Agentless policy d52a7812-5736-4fdc-aed8-72152afa1ffa not found"
}

Get a managed integration Experimental; added in 9.5.0

Path parameters

Responses

value string | number Required