Skip to content

Catalog and packages

Read and change your catalog, add community packages, upload installers, and search.

The permission column lists what the route checks. An API token needs one of them as a scope. Where a route lists several, the route checks them for different parts of the request.

Method Path Permission
GET /api/catalog packages:read, packages:write
POST /api/catalog packages:write
GET /api/catalog/:packageId packages:read, packages:write
DELETE /api/catalog/:packageId packages:write
GET /api/catalog/:packageId/assignments devices:read
POST /api/catalog/:packageId/assignments devices:assign, devices:write
GET /api/catalog/:packageId/cpe security:read, security:write
PUT /api/catalog/:packageId/cpe security:write
GET /api/catalog/:packageId/delivery-owner packages:read, devices:assign
PUT /api/catalog/:packageId/delivery-owner devices:assign
GET /api/catalog/:packageId/devices devices:read
PATCH /api/catalog/:packageId/policy packages:write
GET /api/catalog/:packageId/versions/:versionId/installer packages:read
POST /api/catalog/:packageId/versions/:versionId/verify packages:write
GET /api/catalog/:packageId/versions/:versionId/vulnerabilities packages:read
POST /api/catalog/uploads packages:write
POST /api/package-engine/create packages:write
GET /api/package-engine/findings security:read
POST /api/package-engine/import packages:write
GET /api/package-engine/jobs packages:read
POST /api/package-engine/jobs/process-next packages:write
GET /api/package-engine/overview packages:read
GET /api/package-engine/quarantine packages:read
GET /api/package-engine/retention settings:read
PATCH /api/package-engine/retention/:policyType settings:write
GET /api/package-engine/sources packages:read
POST /api/package-engine/sources packages:write
PATCH /api/package-engine/sources/:id packages:write
DELETE /api/package-engine/sources/:id packages:write
POST /api/package-engine/sources/:id/sync packages:write
GET /api/package-engine/sync-runs packages:read
GET /api/package-engine/versions/:packageId packages:read
GET /api/packages packages:read
POST /api/packages/:packageId/add packages:write, packages:read
DELETE /api/packages/:packageId/remove packages:write, packages:read
GET /api/packages/catalog packages:read
GET /api/packages/discover packages:read
GET /api/packages/discover/:identifier packages:read
GET /api/search packages:read
GET /api/search/exports packages:read
POST /api/search/exports packages:read
GET /api/search/exports/:id/download packages:read
POST /api/search/exports/:id/process packages:read
POST /api/search/reindex packages:write
POST /api/search/saved packages:read
DELETE /api/search/saved/:id packages:read
GET /api/search/telemetry security:read

This page is generated from the API route inventory. 47 endpoints.