{ "opencollection": "1.0.0", "info": { "name": "Kibana APIs Actions Fleet package policies API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Fleet package policies", "type": "folder" }, "items": [ { "info": { "name": "Get package policies", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/fleet/package_policies", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "sortField", "value": "", "type": "query", "description": "Field to sort results by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order, ascending or descending" }, { "name": "showUpgradeable", "value": "", "type": "query", "description": "When true, only show policies with available upgrades" }, { "name": "kuery", "value": "", "type": "query", "description": "A KQL query string to filter results" }, { "name": "format", "value": "", "type": "query", "description": "Format for the response: simplified or legacy" }, { "name": "withAgentCount", "value": "", "type": "query", "description": "When true, include the agent count per package policy" } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/fleet/package_policies
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nList all package policies." }, { "info": { "name": "Create a package policy", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/package_policies", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "format", "value": "", "type": "query", "description": "Format for the response: simplified or legacy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/package_policies
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nCreate a new package policy and assign it to an agent policy." }, { "info": { "name": "Bulk get package policies", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/package_policies/_bulk_get", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "format", "value": "", "type": "query", "description": "Format for the response: simplified or legacy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/package_policies/_bulk_get
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nGet multiple package policies by ID." }, { "info": { "name": "Get a package policy", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/fleet/package_policies/:packagePolicyId", "params": [ { "name": "packagePolicyId", "value": "", "type": "path", "description": "The ID of the package policy" }, { "name": "format", "value": "", "type": "query", "description": "Format for the response: simplified or legacy" } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nGet a package policy by ID." }, { "info": { "name": "Update a package policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/fleet/package_policies/:packagePolicyId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "packagePolicyId", "value": "", "type": "path", "description": "The ID of the package policy" }, { "name": "format", "value": "", "type": "query", "description": "Format for the response: simplified or legacy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpdate a package policy by ID." }, { "info": { "name": "Delete a package policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/fleet/package_policies/:packagePolicyId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "packagePolicyId", "value": "", "type": "path", "description": "The ID of the package policy" }, { "name": "force", "value": "", "type": "query", "description": "When true, delete the package policy even if it is managed" } ] }, "docs": "**Spaces method and path for this operation:**\n\n
delete /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nDelete a package policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all." }, { "info": { "name": "Bulk delete package policies", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/package_policies/delete", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/package_policies/delete
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nDelete multiple package policies by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all." }, { "info": { "name": "Upgrade a package policy", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/package_policies/upgrade", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/package_policies/upgrade
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpgrade a package policy to a newer package version.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all." }, { "info": { "name": "Dry run a package policy upgrade", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/fleet/package_policies/upgrade/dryrun", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/fleet/package_policies/upgrade/dryrun
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nPreview the changes that would be applied by upgrading a package policy to a newer package version.

[Required authorization] Route required privileges: fleet-agent-policies-read AND integrat" } ] } ], "bundled": true }