How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 6.18.0.

Requests are made against a single base URL, https://satellite.example.com.

6 operations 3 paths 5 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
6.18.0
Base URL
https://satellite.example.com/api/v2
Authentication
HTTP Basic, OAuth 2.0
License
Resource Areas
1

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.

Hosts 6

Manage hosts registered with Red Hat Satellite including physical, virtual, and cloud instances.

GET
/api/v2/hosts
List All Hosts
listHosts 9 params → 200401
POST
/api/v2/hosts
Create a Host
createHost 2 params body → 201422401
GET
/api/v2/hosts/{id}
Show a Host
showHost 1 param → 200404401
PUT
/api/v2/hosts/{id}
Update a Host
updateHost 3 params body → 200404422401
DELETE
/api/v2/hosts/{id}
Delete a Host
deleteHost 1 param → 200404401
PUT
/api/v2/hosts/{id}/power
Execute a Power Operation on a Host
hostPowerAction 1 param body → 200404422

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), HostInterface (17 properties). Each schema is shown below with its type and property counts.

HostCreate
object
Parameters for creating a new host.
22 properties 3 required
HostInterfaceCreate
object
Parameters for creating or updating a host network interface.
23 properties
HostUpdate
object
Parameters for updating an existing host.
17 properties
HostInterface
object
A network interface associated with a host.
17 properties
Host
object
A host registered with Red Hat Satellite representing a physical, virtual, or cloud system.
47 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-satellite-hosts-api-openapi.yml Raw ↑

Other APIs Red Hat Satellite publishes across the network.

Red Hat Satellite Hammer CLI
Red Hat Satellite Foreman API
Red Hat Satellite Katello API
Red Hat Satellite Ansible Collection
Red Hat Satellite Content Views API
Red Hat Satellite Lifecycle Environments API
Red Hat Satellite Organizations API
Red Hat Satellite Subscriptions API
Where this information came from

This is an independent, third-party profile of Red Hat Satellite Hosts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.