Red Hat Satellite Hosts API
Manage hosts registered with Red Hat Satellite including physical, virtual, and cloud instances.
Red Hat Satellite Hosts API is one of 9 APIs that Red Hat Satellite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 24 JSON Schema definitions.
Tagged areas include Hosts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a getting-started guide, an API reference, and 24 JSON Schemas.
This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 6.18.0.
Requests are made against a single base URL, https://satellite.example.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Red Hat Satellite Hosts API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
It supports OAuth 2.0 (oAuth2) using the implicit flow.
By default, every request must be authenticated.
basicAuth— HTTP Basic authentication using Satellite username and password.oAuth2— OAuth 2.0 Personal Access Token authentication for Satellite users.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage hosts registered with Red Hat Satellite including physical, virtual, and cloud instances.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Host (47 properties), HostInterfaceCreate (23 properties), HostCreate (22 properties), HostUpdate (17 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Red Hat Satellite 8
Other APIs Red Hat Satellite publishes across the network.