List package policies

GET /api/fleet/package_policies

Query parameters

perPage integer

The number of items to return

Default value is 20.
page integer

Default value is 1.
kuery string
format string

Simplified or legacy format for package inputs

Values are simplified or legacy.

Responses

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

OK
Hide response attributes Show response attributes 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
  
  Additional properties are allowed.
  
  enabled boolean Required
  
  processors array[string]
  
  streams array
  
  type string Required
  
  vars object
  
  Additional properties are allowed.
  
  revision number Required
  
  description string
  
  enabled boolean
  
  name string Required
  
  namespace string
  
  output_id string
  
  overrides object
  
  Additional properties are allowed.
  
  package object
  
  Additional properties are allowed.
  
  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]
- page number
- perPage number
- total number
400 application/json; Elastic-Api-Version=2023-10-31

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

GET /api/fleet/package_policies

curl \
 -X GET https://localhost:5601/api/fleet/package_policies

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"
      ]
    }
  ],
  "page": 42.0,
  "perPage": 42.0,
  "total": 42.0
}

Response examples (400)

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