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 Satellite Subscriptions API

Manage Red Hat subscriptions and entitlements for organizations and hosts.

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

4 operations 4 paths 2 schemas 1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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 Subscriptions 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 4

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

Subscriptions 4

Manage Red Hat subscriptions and entitlements for organizations and hosts.

GET
/katello/api/v2/organizations/{organization_id}/subscriptions
List Organization Subscriptions
listSubscriptions 12 params → 200401
POST
/katello/api/v2/organizations/{organization_id}/subscriptions/upload
Upload a Subscription Manifest
uploadSubscriptionManifest 1 param body → 202400401
POST
/katello/api/v2/organizations/{organization_id}/subscriptions/delete_manifest
Delete a Subscription Manifest
deleteSubscriptionManifest 1 param → 202401
PUT
/katello/api/v2/organizations/{organization_id}/subscriptions/refresh_manifest
Refresh a Subscription Manifest
refreshSubscriptionManifest 1 param → 202401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Subscription (25 properties), ForemanTask (11 properties). Each schema is shown below with its type and property counts.

Subscription
object
A Red Hat subscription providing product entitlements for an organization.
25 properties
ForemanTask
object
An asynchronous task object returned for long-running operations such as publishing content views or uploading manifests.
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-satellite-subscriptions-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 Hosts API
Red Hat Satellite Lifecycle Environments API
Red Hat Satellite Organizations API