Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Rules API

Operations for listing and retrieving Advisor rules that define the detection logic for system issues.

Red Hat Rules API is one of 75 APIs that Red Hat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.6.

Requests are made against a single base URL, https://ansible-platform.example.com.

3 operations 3 paths 6 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.6
Server
https://ansible-platform.example.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat Rules API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token for authenticating API requests to the automation controller.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Rules 3

Operations for listing and retrieving Advisor rules that define the detection logic for system issues.

GET
/insights/v1/rule/
Red Hat List Advisor Rules
listRules 7 params → 200401
GET
/insights/v1/rule/{rule_id}/
Red Hat Get an Advisor Rule
getRule 1 param → 200401404
GET
/insights/v1/rule/{rule_id}/systems/
Red Hat List Systems Affected by a Rule
listRuleSystems 3 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Rule (12 properties), System (10 properties), PaginationLinks (4 properties), PaginatedSystemList (3 properties). Each schema is shown below with its type and property counts.

PaginatedRuleList
object
A paginated list of rules.
3 properties
PaginationMeta
object
Pagination metadata for list responses.
1 property
System
object
A RHEL system registered with Red Hat Insights for monitoring and recommendations.
10 properties
PaginatedSystemList
object
A paginated list of systems.
3 properties
Rule
object
An Advisor rule that defines detection logic for a specific system issue, along with resolution steps and remediation guidance.
12 properties
PaginationLinks
object
Pagination links for navigating result sets.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-rules-api-openapi.yml Raw ↑

Other APIs Red Hat publishes across the network.

Red Hat Subscription Management API
Red Hat Advanced Cluster Management API
Red Hat Advanced Cluster Security API
Red Hat 3scale API Management
Red Hat Cost Management API
Red Hat Image Builder API
Red Hat Vulnerability Management API
Red Hat Patch API
Red Hat Compliance API
Red Hat Build of Apicurio Registry API
Red Hat Streams for Apache Kafka Bridge API
Red Hat Ansible Lightspeed API