Get a package policy

Server: https://{kibana_url}

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

Api key auth Basic auth

Refer to Spaces for more information.

Get a package policy by ID.

Path Parameters

packagePolicyId string required: The ID of the package policy

Query Parameters

format enum: Format for the response: simplified or legacy; Values: simplified legacy

Responses

Successful response

application/json

Bad Request

application/json

Not Found

application/json

Examples

A package policy

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/package_policies/{packagePolicyId}

curl Shell

curl -X GET "https://{kibana_url}/api/fleet/package_policies/{packagePolicyId}"

Response

{
  "item": {
    "created_at": "2024-01-15T10:00:00.000Z",
    "enabled": true,
    "id": "package-policy-id-1",
    "inputs": [],
    "name": "nginx-1",
    "namespace": "default",
    "package": {
      "name": "nginx",
      "title": "Nginx",
      "version": "1.20.0"
    },
    "policy_ids": [
      "agent-policy-id-1"
    ],
    "updated_at": "2024-01-15T10:00:00.000Z"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Package policy package-policy-id-1 not found",
  "statusCode": 404
}