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 Content Views API

Manage content views which define curated sets of repositories and packages available to hosts.

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

7 operations 4 paths 4 schemas 1 DELETE2 GET3 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 Content Views 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 7

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

Content Views 7

Manage content views which define curated sets of repositories and packages available to hosts.

GET
/katello/api/v2/content_views
List Content Views
listContentViews 12 params → 200401
POST
/katello/api/v2/content_views
Create a Content View
createContentView body → 201422401
GET
/katello/api/v2/content_views/{id}
Show a Content View
showContentView 1 param → 200404401
PUT
/katello/api/v2/content_views/{id}
Update a Content View
updateContentView 1 param body → 200404422401
DELETE
/katello/api/v2/content_views/{id}
Delete a Content View
deleteContentView 1 param → 200404401
POST
/katello/api/v2/content_views/{id}/publish
Publish a Content View
publishContentView 1 param body → 202404401
POST
/katello/api/v2/content_view_versions/{id}/promote
Promote a Content View Version
promoteContentViewVersion 1 param body → 202404422

Schemas 4

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

ContentViewCreate
object
Parameters for creating a new content view.
12 properties 2 required
ForemanTask
object
An asynchronous task object returned for long-running operations such as publishing content views or uploading manifests.
11 properties
ContentView
object
A content view defining a curated set of repositories and content available to hosts.
25 properties
ContentViewUpdate
object
Parameters for updating a content view.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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