Bulk get package policies | Kibana Serverless API

Bulk get package policies Beta

POST /api/fleet/package_policies/_bulk_get

Query parameters

format string

Simplified or legacy format for package inputs

Values are simplified or legacy.

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

Body

ids array[string] Required

list of package policy ids
ignoreMissing boolean

Responses

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

OK
Hide response attribute Show response attribute object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  id string Required
  
  inputs array[object] Required
  
  Hide inputs attributes Show inputs attributes object
  
  config object
  
  enabled boolean Required
  
  processors array[string]
  
  streams array
  
  type string Required
  
  vars object
  
  revision number Required
  
  description string
  
  enabled boolean
  
  name string Required
  
  namespace string
  
  output_id string
  
  overrides object
  
  package object
  
  Hide package attributes Show package attributes object
  
  name string Required
  
  requires_root boolean
  
  title string
  
  version string Required
  
  policy_id string | null Deprecated
  
  policy_ids array[string]
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

POST /api/fleet/package_policies/_bulk_get

curl \
 -X POST https://localhost:5601/api/fleet/package_policies/_bulk_get \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "ids": [
    "string"
  ],
  "ignoreMissing": true
}

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "inputs": [
        {
          "config": {},
          "enabled": true,
          "processors": [
            "string"
          ],
          "streams": [],
          "type": "string",
          "vars": {}
        }
      ],
      "revision": 42.0,
      "description": "string",
      "enabled": true,
      "name": "string",
      "namespace": "string",
      "output_id": "string",
      "overrides": {},
      "package": {
        "name": "string",
        "requires_root": true,
        "title": "string",
        "version": "string"
      },
      "policy_id": "string",
      "policy_ids": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}