{"@context": "https://schema.org", "@type": "WebAPI", "name": "Patchman-engine API API", "description": "API of the Patch application on [cloud.redhat.com](cloud.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters)", "provider": {"@type": "Organization", "name": "redhat.local"}, "documentation": "https://raw.githubusercontent.com/RedHatInsights/patchman-engine/master/docs/openapi.json"}
API of the Patch application on [cloud.redhat.com](cloud.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters)
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://redhat.local
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
API of the Patch application on [cloud.redhat.com](cloud.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters)
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/patch/v1/advisories | Show me all applicable advisories for all my systems Show me all applicable advisories for all my systems |
GET | /api/patch/v1/advisories/{advisory_id} | Show me details an advisory by given advisory name Show me details an advisory by given advisory name |
GET | /api/patch/v1/advisories/{advisory_id}/systems | Show me systems on which the given advisory is applicable Show me systems on which the given advisory is appli |
GET | /api/patch/v1/export/advisories | Export applicable advisories for all my systems Export applicable advisories for all my systems |
GET | /api/patch/v1/export/advisories/{advisory_id}/systems | Export systems for my account Export systems for my account |
GET | /api/patch/v1/export/packages | Show me all installed packages across my systems Show me all installed packages across my systems |
GET | /api/patch/v1/export/packages/{package_name}/systems | Show me all my systems which have a package installed Show me all my systems which have a package installed |
GET | /api/patch/v1/export/systems | Export systems for my account Export systems for my account |
GET | /api/patch/v1/export/systems/{inventory_id}/advisories | Export applicable advisories for all my systems Export applicable advisories for all my systems |
GET | /api/patch/v1/export/systems/{inventory_id}/packages | Show me details about a system packages by given inventory id Show me details about a system packages by given |
GET | /api/patch/v1/packages/ | Show me all installed packages across my systems Show me all installed packages across my systems |
GET | /api/patch/v1/packages/{package_name} | Show me metadata of selected package Show me metadata of selected package |
GET | /api/patch/v1/packages/{package_name}/systems | Show me all my systems which have a package installed Show me all my systems which have a package installed |
GET | /api/patch/v1/packages/{package_name}/versions | Show me all package versions installed on some system Show me all package versions installed on some system |
GET | /api/patch/v1/systems | Show me all my systems Show me all my systems |
GET | /api/patch/v1/systems/{inventory_id} | Show me details about a system by given inventory id Show me details about a system by given inventory id |
DELETE | /api/patch/v1/systems/{inventory_id} | Delete system by inventory id Delete system by inventory id |
GET | /api/patch/v1/systems/{inventory_id}/advisories | Show me advisories for a system by given inventory id Show me advisories for a system by given inventory id |
GET | /api/patch/v1/systems/{inventory_id}/packages | Show me details about a system packages by given inventory id Show me details about a system packages by given |
POST | /api/patch/v1/views/advisories/systems | View advisory-system pairs for selected systems and advisories View advisory-system pairs for selected systems |
POST | /api/patch/v1/views/systems/advisories | View system-advisory pairs for selected systems and advisories View system-advisory pairs for selected systems |
specification origin: https://raw.githubusercontent.com/RedHatInsights/patchman-engine/master/docs/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.