Get package policy by ID

GET /api/fleet/package_policies/{packagePolicyId}

Api key auth Basic auth

Path parameters

packagePolicyId string Required

Query parameters

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 attribute Show response attribute object
- item object Required
  
  Hide item attributes Show item attributes object
  
  id string Required
  
  inputs array Required
  
  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

GET /api/fleet/package_policies/{packagePolicyId}

curl \
 --request GET http://localhost:5622/api/fleet/package_policies/{packagePolicyId} \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "item": {
    "id": "string",
    "inputs": [],
    "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
}