Patchman-engine API
API of the Patch application on [cloud.redhat.com](cloud.redhat.com) Syntax of the filter[name] query parameters is described in [Filters…
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API of the Patch application on [cloud.redhat.com](cloud.redhat.com)
Syntax of the filter[name] query parameters is described in Filters documentation
Endpoints 21
- GETShow me all applicable advisories for all my systems
/api/patch/v1/advisories?limit=0&offset=0&sort=id&search=string&filter[id]=string&filter[description]=string&filter[public_date]=string&filter[synopsis]=string&filter[advisory_type]=string&filter[severity]=string&filter[applicable_systems]=string&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=stringShow me all applicable advisories for all my systems - GETShow me details an advisory by given advisory name
/api/patch/v1/advisories/:advisory_idShow me details an advisory by given advisory name - GETShow me systems on which the given advisory is applicable
/api/patch/v1/advisories/:advisory_id/systems?limit=0&offset=0&sort=id&search=string&filter[id]=string&filter[insights_id]=string&filter[display_name]=string&filter[last_evaluation]=string&filter[last_upload]=string&filter[rhsa_count]=string&filter[rhba_count]=string&filter[rhea_count]=string&filter[other_count]=string&filter[stale]=string&filter[stale_timestamp]=string&filter[stale_warning_timestamp]=string&filter[culled_timestamp]=string&filter[created]=string&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=stringShow me systems on which the given advisory is applicable - GETExport applicable advisories for all my systems
/api/patch/v1/export/advisories?search=string&filter[id]=string&filter[description]=string&filter[public_date]=string&filter[synopsis]=string&filter[advisory_type]=string&filter[severity]=string&filter[applicable_systems]=stringExport applicable advisories for all my systems - GETExport systems for my account
/api/patch/v1/export/advisories/:advisory_id/systems?search=string&filter[id]=string&filter[display_name]=string&filter[last_evaluation]=string&filter[last_upload]=string&filter[rhsa_count]=string&filter[rhba_count]=string&filter[rhea_count]=string&filter[other_count]=string&filter[stale]=string&filter[packages_installed]=string&filter[packages_updatable]=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=string&tags=stringExport systems for my account - GETShow me all installed packages across my systems
/api/patch/v1/export/packages?sort=id&search=string&filter[name]=string&filter[systems_installed]=string&filter[systems_updatable]=string&filter[summary]=stringShow me all installed packages across my systems - GETShow me all my systems which have a package installed
/api/patch/v1/export/packages/:package_name/systems?filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=string&tags=stringShow me all my systems which have a package installed - GETExport systems for my account
/api/patch/v1/export/systems?search=string&filter[id]=string&filter[display_name]=string&filter[last_evaluation]=string&filter[last_upload]=string&filter[rhsa_count]=string&filter[rhba_count]=string&filter[rhea_count]=string&filter[other_count]=string&filter[stale]=string&filter[packages_installed]=string&filter[packages_updatable]=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=string&tags=stringExport systems for my account - GETExport applicable advisories for all my systems
/api/patch/v1/export/systems/:inventory_id/advisories?search=string&filter[id]=string&filter[description]=string&filter[public_date]=string&filter[synopsis]=string&filter[advisory_type]=string&filter[severity]=stringExport applicable advisories for all my systems - GETShow me details about a system packages by given inventory id
/api/patch/v1/export/systems/:inventory_id/packages?search=string&filter[name]=string&filter[description]=string&filter[evra]=string&filter[summary]=string&filter[updatable]=trueShow me details about a system packages by given inventory id - GETShow me all installed packages across my systems
/api/patch/v1/packages/?limit=0&offset=0&sort=id&search=string&filter[name]=string&filter[systems_installed]=string&filter[systems_updatable]=string&filter[summary]=string&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=stringShow me all installed packages across my systems - GETShow me metadata of selected package
/api/patch/v1/packages/:package_nameShow me metadata of selected package - GETShow me all my systems which have a package installed
/api/patch/v1/packages/:package_name/systems?limit=0&offset=0&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=stringShow me all my systems which have a package installed - GETShow me all package versions installed on some system
/api/patch/v1/packages/:package_name/versions?limit=0&offset=0Show me all package versions installed on some system - GETShow me all my systems
/api/patch/v1/systems?limit=0&offset=0&sort=id&search=string&filter[insights_id]=string&filter[id]=string&filter[display_name]=string&filter[last_evaluation]=string&filter[last_upload]=string&filter[rhsa_count]=string&filter[rhba_count]=string&filter[rhea_count]=string&filter[other_count]=string&filter[stale]=string&filter[packages_installed]=string&filter[packages_updatable]=string&filter[stale_timestamp]=string&filter[stale_warning_timestamp]=string&filter[culled_timestamp]=string&filter[created]=string&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=stringShow me all my systems - GETShow me details about a system by given inventory id
/api/patch/v1/systems/:inventory_idShow me details about a system by given inventory id - DELETEDelete system by inventory id
/api/patch/v1/systems/:inventory_idDelete system by inventory id - GETShow me advisories for a system by given inventory id
/api/patch/v1/systems/:inventory_id/advisories?limit=0&offset=0&sort=id&search=string&filter[id]=string&filter[description]=string&filter[public_date]=string&filter[synopsis]=string&filter[advisory_type]=string&filter[severity]=stringShow me advisories for a system by given inventory id - GETShow me details about a system packages by given inventory id
/api/patch/v1/systems/:inventory_id/packages?limit=0&offset=0&search=string&filter[name]=string&filter[description]=string&filter[evra]=string&filter[summary]=string&filter[updatable]=trueShow me details about a system packages by given inventory id - POSTView advisory-system pairs for selected systems and advisories
/api/patch/v1/views/advisories/systemsView advisory-system pairs for selected systems and advisories - POSTView system-advisory pairs for selected systems and advisories
/api/patch/v1/views/systems/advisoriesView system-advisory pairs for selected systems and advisories
API details
- Base URL
http://redhat.local- Authentication
- An API key in the x-rh-identity header
- Operations
- 21 operations on 20 pathsGET 18POST 2DELETE 1
- Response formats
application/jsontext/csv- Description format
- OpenAPI 3.0.1, API version
v1.15.3 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Patchman-engine API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Patchman-engine API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-rh-identity header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Show me all applicable advisories for all my systems” (GET /api/patch/v1/advisories?limit=0&offset=0&sort=id&search=string&filter[id]=string&filter[description]=string&filter[public_date]=string&filter[synopsis]=string&filter[advisory_type]=string&filter[severity]=string&filter[applicable_systems]=string&tags=string&filter[system_profile][sap_system]=string&filter[system_profile][sap_sids][in]=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Patchman-engine API?
API of the Patch application on [cloud.redhat.com](cloud.redhat.com) Syntax of the filter[name] query parameters is described in [Filters… It is listed under Developer tools and has 21 endpoints.
Who publishes the Patchman-engine API?
It is listed from Red Hat's public API description (an OpenAPI document), not published by Red Hat on Swastik Codes. Anyone who controls redhat.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Patchman-engine API?
Requests go to http://redhat.local. Endpoint paths are added to this base URL.
How do I authenticate with the Patchman-engine API?
With an API key in the x-rh-identity header.
How many endpoints does the Patchman-engine API have?
21 operations on 20 paths (18 GET, 2 POST, 1 DELETE).
Is forking the Patchman-engine API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.