Get package policy by ID

Base URL: https://{kibana_url}

GET /api/fleet/package_policies/{packagePolicyId}
GET /s/{space_id}/api/fleet/package_policies/{packagePolicyId}

Auth

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
packagePolicyId string required

Query parameters

format enum: Simplified or legacy format for package inputs; Values: simplified legacy

Responses

application/json

item object required

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/package_policies/PACKAGE_POLICY_ID

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/package_policies/${PACKAGE_POLICY_ID}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "item": {
    "id": "string",
    "inputs": [],
    "revision": 0,
    "description": "string",
    "enabled": false,
    "name": "string",
    "namespace": "string",
    "output_id": "string",
    "overrides": {},
    "package": {
      "name": "string",
      "requires_root": false,
      "title": "string",
      "version": "string"
    },
    "policy_id": "string",
    "policy_ids": [
      "string"
    ]
  }
}

Generated from the API spec

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

Generated from the API spec