### Get Installed Packages Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

An example of a successful response when listing installed integration packages.

```json
{
  "items": [
    {
      "name": "system",
      "status": "installed",
      "title": "System",
      "version": "1.55.0"
    },
    {
      "name": "elastic_agent",
      "status": "installed",
      "title": "Elastic Agent",
      "version": "1.15.0"
    }
  ],
  "searchExcluded": 0,
  "total": 2
}
```

--------------------------------

### Install Package Response Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a successful response after installing a package.

```json
{
  "_meta": {
    "install_source": "registry"
  },
  "items": [
    {
      "id": "aws-logs-aws.cloudwatch_logs-default",
      "type": "index_template"
    }
  ]
}
```

--------------------------------

### Bulk install packages example

Source: https://www.elastic.co/docs/api/doc/kibana/v9.yaml

Example response showing the results of a bulk package installation.

```json
{
  "items": [
    {
      "name": "system",
      "result": {
        "assets": []
      }
    }
  ]
}
```

--------------------------------

### Bulk install packages request example

Source: https://www.elastic.co/docs/api/doc/kibana.json

Example request body for bulk installing packages.

```json
{
  "packages": [
    {
      "name": "nginx",
      "version": "1.0.0"
    }
  ]
}
```

--------------------------------

### Install Package Request Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a request to install a package, optionally ignoring constraints.

```json
{
  "ignore_constraints": false
}
```

--------------------------------

### Install Prepackaged Timelines Success Response Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a successful installation result with counts.

```json
{
  "errors": [],
  "success": true,
  "success_count": 10,
  "timelines_installed": 8,
  "timelines_updated": 2
}
```

--------------------------------

### Data streams from installed packages example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example response showing a list of data streams from installed packages.

```json
{
  "data_streams": []
}
```

--------------------------------

### Install Prepackaged Timelines Server Error Response Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a server error during prepackaged timeline installation.

```json
{
  "body": "Internal error",
  "statusCode": 500
}
```

--------------------------------

### Get Package Information Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example response for retrieving details about an installed AWS package.

```json
{
  "item": {
    "assets": {
      "kibana": {
        "dashboard": [],
        "index_pattern": []
      }
    },
    "categories": [
      "cloud"
    ],
    "description": "Collect logs and metrics from Amazon Web Services",
    "name": "aws",
    "status": "installed",
    "title": "AWS",
    "version": "2.10.0"
  }
}
```

--------------------------------

### Get proxies response example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a successful response when getting proxies.

```json
{
  "items": [
    {
      "id": "proxy-id-1",
      "is_preconfigured": false,
      "name": "My proxy",
      "url": "http://proxy.example.com:3128"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}
```

--------------------------------

### Install a package by uploading a .zip or .tar.gz archive

Source: https://www.elastic.co/docs/api/doc/kibana.json

This example demonstrates how to install a package by uploading a compressed archive. The API endpoint and required headers are specified.

```bash
POST /s/{space_id}/api/fleet/epm/packages
Host: kibana-host:5601
Content-Type: application/gzip
kbn-xsrf: true

<binary package archive>
```

--------------------------------

### Install Package by Upload Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Package successfully installed from upload.

```json
{
  "_meta": {
    "install_source": "upload"
  },
  "items": [
    {
      "id": "my-custom-package-logs-default",
      "type": "index_template"
    }
  ]
}
```

--------------------------------

### Get a monitor example

Source: https://www.elastic.co/docs/api/doc/kibana/v8.json

Example of a GET request to retrieve a specific monitor by its ID.

```json
{
    "type": "http",
    "name": "Website Availability",
    "schedule": "* * * * *",
    "locations": [
        {
            "id": "aws-us-east-1",
            "geo": {
                "continent_name": "North America",
                "country_iso_code": "US",
                "region": "US East (N. Virginia)",
                "city_name": "Ashburn"
            },
            "isServiceManaged": true
        },
        {
            "id": "aws-eu-west-1",
            "geo": {
                "continent_name": "Europe",
                "country_iso_code": "IE",
                "region": "EU (Frankfurt)",
                "city_name": "Frankfurt"
            },
            "isServiceManaged": true
        },
        {
            "id": "aws-ap-southeast-2",
            "geo": {
                "continent_name": "Asia",
                "country_iso_code": "AU",
                "region": "Asia Pacific (Sydney)",
                "city_name": "Sydney"
            },
            "isServiceManaged": true
        },
        {
            "label": "North America - US Central",
            "geo": {
                "lat": 41.25,
                "lon": -95.86
            },
            "isServiceManaged": true
        }
    ],
    "namespace": "default",
    "origin": "ui",
    "id": "a8188705-d01e-4bb6-87a1-64fa5e4b07ec",
    "max_attempts": 2,
    "__ui": {
        "is_tls_enabled": false
    },
    "max_redirects": "0",
    "response.include_body": "on_error",
    "response.include_headers": true,
    "check.request.method": "GET",
    "mode": "any",
    "response.include_body_max_bytes": "1024",
    "ipv4": true,
    "ipv6": true,
    "ssl.verification_mode": "full",
    "ssl.supported_protocols": [
        "TLSv1.1",
        "TLSv1.2",
        "TLSv1.3"
    ],
    "revision": 13,
    "created_at": "2023-11-08T08:45:29.334Z",
    "updated_at": "2023-12-18T20:31:44.770Z",
    "url": "https://fast.com"
}
```

--------------------------------

### Get Logstash Pipelines Response Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example response for getting a list of Logstash pipelines.

```json
{
  "pipelines": [
    {
      "id": "hello-world",
      "description": "Just a simple pipeline",
      "last_modified": "2018-04-14T12:23:29.772Z",
      "username": "elastic" 
    },
    {
      "id": "sleepy-pipeline",
      "description": "",

```

--------------------------------

### Start Entity Store Engines

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Examples for starting entity store engines, either all or a specific one.

```curl
curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"entityTypes":["user","host","service","generic"]}' \
  "${KIBANA_URL}/api/security/entity_store/start"
```

```Console
PUT kbn://api/security/entity_store/start
{
  "entityTypes": ["user", "host", "service", "generic"]
}
```

--------------------------------

### Agent Setup Ready Example

Source: https://www.elastic.co/docs/api/doc/kibana/v9.yaml

Fleet is ready to enroll agents — all requirements are met.

```json
{
  "is_action_secrets_storage_enabled": true,
  "is_secrets_storage_enabled": true,
  "is_space_awareness_enabled": false,
  "is_ssl_secrets_storage_enabled": false,
  "isReady": true,
  "missing_optional_features": [],
  "missing_requirements": [],
  "package_verification_key_id": "D88DB4CC"
}
```

--------------------------------

### Get Ingest Stream Settings Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of the response body for getting ingest stream settings.

```json
{
  "ingest": {
    "failure_store": {},
    "lifecycle": {},
    "processing": {
      "steps": [
        {
          "action": "grok",
          "from": "message",
          "ignore_missing": false,
          "patterns": [
            "%{IPORHOST:client.ip} %{USER:ident} %{USER:auth} [%{HTTPDATE:@timestamp}] \"%{WORD:http.method} %{DATA:url.original} HTTP/%{NUMBER:http.version}\" %{NUMBER:http.response.status_code:int} (?:%{NUMBER:http.response.body.bytes:int}|-)"
          ]
        }
      ],
      "updated_at": "2025-01-15T10:30:00.000Z"
    },
    "settings": {},
    "wired": {
      "fields": {
        "client.ip": {
          "type": "ip"
        },
        "http.method": {
          "type": "keyword"
        },
        "http.response.body.bytes": {
          "type": "long"
        },
        "http.response.status_code": {
          "type": "long"
        },
        "url.original": {
          "type": "wildcard"
        }
      },
      "routing": [
        {
          "destination": "logs.nginx.errors",
          "status": "enabled",
          "where": {
            "field": "http.response.status_code",
            "gte": 500
          }
        }
      ]
    }
  }
}
```

--------------------------------

### List Plugins Kibana Console Example

Source: https://www.elastic.co/docs/api/doc/kibana.json

Example command for Kibana Console to list all installed plugins.

```kibana-console
GET kbn://api/agent_builder/plugins
```

--------------------------------

### Fleet setup initialized successfully

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example response when Fleet setup is initialized successfully with no non-fatal errors.

```json
{
  "isInitialized": true
}
```

--------------------------------

### Get private locations response example

Source: https://www.elastic.co/docs/api/doc/kibana/v8.json

Example of a successful response when getting a list of private locations.

```json
[
    {
        "label": "Test private location",
        "id": "fleet-server-policy",
        "agentPolicyId": "fleet-server-policy",
        "isInvalid": false,
        "geo": {
            "lat": 0,
            "lon": 0
        },
        "namespace": "default"
    },
    {
        "label": "Test private location 2",
        "id": "691225b0-6ced-11ee-8f5a-376306ee85ae",
        "agentPolicyId": "691225b0-6ced-11ee-8f5a-376306ee85ae",
        "isInvalid": false,
        "geo": {
            "lat": 0,
            "lon": 0
        },
        "namespace": "test"
    }
]
```

--------------------------------

### Install a package from the registry

Source: https://www.elastic.co/docs/api/doc/kibana/v9.yaml

This example shows how to install a package using the EPM API.

```json
{
  "message": "An error message describing what went wrong",
  "statusCode": 400
}
schema:
  additionalProperties: false
  description: Generic Error
  type: object
  properties:
    attributes: {}
    error:
      type: string
    errorType:
      type: string
    message:
      type: string
    statusCode:
      type: number
  required:
    - message
    - attributes

```

--------------------------------

### Security Lists API - Get Privileges Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example of a successful response for getting value list privileges.

```json
{
  "manage_ml": true,
  "manage_own_api_key": true,
  "manage_pipeline": true,
  "manage_security": true,
  "manage_transform": true,
  "monitor": true,
  "monitor_ml": true,
  "monitor_transform": true
}

```

--------------------------------

### Example script execution

Source: https://www.elastic.co/docs/api/doc/kibana.json

This example shows how to execute a script on an endpoint.

```bash
./bin/script.sh
```

--------------------------------

### Batch Start Upgrade Reindex Response Example

Source: https://www.elastic.co/docs/api/doc/kibana/v8.json

Example response for batch starting or resuming reindexing tasks.

```json
{
  "enqueued": [
    {
      "indexName": "index1",
      "newIndexName": "reindexed-v8-index1",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": {
        "queueSettings": {
          "queuedAt": 1583406985489
        }
      }
    }
  ],
  "errors": [
    {
      "indexName": "index2",
      "message": "Something went wrong!"
    }
  ]
}
```

--------------------------------

### Get Packages Example

Source: https://www.elastic.co/docs/api/doc/kibana.yaml

Example response for listing available integration packages.

```json
{
  "items": [
    {
      "categories": [
        "cloud"
      ],
      "description": "Collect logs and metrics from Amazon Web Services",
      "id": "aws",
      "name": "aws",
      "status": "not_installed",
      "title": "AWS",
      "version": "2.10.0"
    }
  ],
  "searchExcluded": 0,
  "total": 1
}
```

--------------------------------

### Get Shareable References Request Example

Source: https://www.elastic.co/docs/api/doc/kibana/v8.json

Example request body for getting shareable references for saved objects.

```json
{
  "objects": [
    {
      "type": "visualization",
      "id": "my-visualization"
    }
  ]
}
```