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 Systems API

Operations for retrieving registered systems and their Insights status.

Red Hat Systems 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 Systems. 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 2 operations across 2 paths, and defines 4 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.

2 operations 2 paths 4 schemas 2 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 Systems 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 2

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

Systems 2

Operations for retrieving registered systems and their Insights status.

GET
/insights/v1/system/
Red Hat List Systems
listSystems 4 params → 200401
GET
/insights/v1/system/{system_id}/
Red Hat Get a System
getSystem 1 param → 200401404

Schemas 4

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

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
PaginationLinks
object
Pagination links for navigating result sets.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-systems-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