Red Hat Satellite website screenshot

Red Hat Satellite

Red Hat Satellite is a systems management product that helps deploy, configure, and maintain systems across physical, virtual, and cloud environments.

Red Hat Satellite publishes 5 APIs on the APIs.io network, including Content Views API, Hosts API, Lifecycle Environments API, and 2 more. Tagged areas include Configuration Management, Lifecycle Management, Patch Management, Subscription Management, and Systems Management.

The Red Hat Satellite catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Red Hat Satellite’s developer surface includes authentication, developer portal, documentation, support, engineering blog, release notes, API reference, and 19 more developer resources.

57.3/100 strong ▬ flat Agent 37/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessEnterpriseSelf serve
9 APIs 7 Features 5 Use Cases
Configuration ManagementLifecycle ManagementPatch ManagementSubscription ManagementSystems Management

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 57.3/100 · strong
Contract Quality 18.2 / 25
Developer Ergonomics 10.4 / 20
Commercial Clarity 7.4 / 20
Operational Transparency 7.5 / 13
Governance 8.3 / 12
Discoverability 5.6 / 10
Agent readiness — 37/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/red-hat-satellite: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 9

Individual APIs this provider publishes, each with its own machine-readable definition.

Red Hat Satellite Hammer CLI

Command-line interface tool for Red Hat Satellite that provides scriptable access to Satellite functions including host management, content views, and provisioning.

Red Hat Satellite Foreman API

Core Foreman API integrated into Red Hat Satellite for host lifecycle management, provisioning, and configuration management. This is the upstream project API that powers Satell...

Red Hat Satellite Katello API

Content management API for Red Hat Satellite handling repositories, content views, lifecycle environments, subscriptions, and errata. Katello is the upstream plugin that provide...

Red Hat Satellite Ansible Collection

The redhat.satellite Ansible collection provides modules, roles, and plugins for automating Red Hat Satellite configuration and management through the Satellite API. Based on th...

Red Hat Satellite Content Views API

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

Red Hat Satellite Hosts API

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

Red Hat Satellite Lifecycle Environments API

Manage lifecycle environments that define promotion paths for content views from development through production.

Red Hat Satellite Organizations API

Manage organizations which provide multi-tenancy isolation for hosts, content, and subscriptions.

Red Hat Satellite Subscriptions API

Manage Red Hat subscriptions and entitlements for organizations and hosts.

Scroll for all 9

Postman Collections 5

Ready-to-run Postman collections for exercising this provider's APIs.

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Red Hat Satellite Rate Limits

1 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Features 7

Notable capabilities this provider offers.

Host Management

Manage physical, virtual, and cloud hosts across the entire lifecycle from provisioning to decommissioning.

Content Management

Curate and distribute RPM packages, errata, and container images through content views and lifecycle environments.

Patch Management

Apply security patches and errata across managed systems with controlled rollouts through lifecycle stages.

Subscription Management

Track and manage Red Hat subscriptions and entitlements across organizations and hosts.

Provisioning

Automate bare-metal and virtual machine provisioning with kickstart templates, PXE boot, and compute resources.

Configuration Management

Enforce desired-state configuration using Puppet classes and Ansible roles across managed hosts.

Multi-Tenancy

Organize hosts, content, and subscriptions into isolated organizations and locations.

Scroll for all 7

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Red Hat Satellite Context

0 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Red Hat Satellite API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Red Hat Satellite API Rules

16 rules · 8 errors 8 warnings

SPECTRAL

JSON Schema 21

Standalone JSON Schema definitions for this provider's data models.

ContentViewCreate

12 properties

JSON SCHEMA

ContentView

25 properties

JSON SCHEMA

ContentViewUpdate

7 properties

JSON SCHEMA

ContentView

25 properties

JSON SCHEMA

ContentViewCreate

12 properties

JSON SCHEMA

ContentViewUpdate

7 properties

JSON SCHEMA

ForemanTask

11 properties

JSON SCHEMA

ForemanTask

11 properties

JSON SCHEMA

HostCreate

22 properties

JSON SCHEMA

HostInterfaceCreate

23 properties

JSON SCHEMA

HostInterface

17 properties

JSON SCHEMA

Host

47 properties

JSON SCHEMA

HostUpdate

17 properties

JSON SCHEMA

HostCreate

22 properties

JSON SCHEMA

HostInterface

17 properties

JSON SCHEMA

HostInterfaceCreate

23 properties

JSON SCHEMA

HostUpdate

17 properties

JSON SCHEMA

LifecycleEnvironment

12 properties

JSON SCHEMA

LifecycleEnvironment

12 properties

JSON SCHEMA

Organization

7 properties

JSON SCHEMA

Subscription

25 properties

JSON SCHEMA

Scroll for all 21

JSON Structure 13

JSON Structure definitions describing this provider's data shapes.

Red Hat Satellite Content View Structure

25 properties

JSON STRUCTURE

Red Hat Satellite Foreman Task Structure

11 properties

JSON STRUCTURE

Red Hat Satellite Host Create Structure

22 properties

JSON STRUCTURE

Red Hat Satellite Host Interface Structure

17 properties

JSON STRUCTURE

Red Hat Satellite Host Structure

47 properties

JSON STRUCTURE

Red Hat Satellite Host Update Structure

17 properties

JSON STRUCTURE

Red Hat Satellite Organization Structure

7 properties

JSON STRUCTURE

Red Hat Satellite Structure

0 properties

JSON STRUCTURE

Red Hat Satellite Subscription Structure

25 properties

JSON STRUCTURE

Scroll for all 13

Examples 32

Example request and response payloads for these APIs.

Scroll for all 32

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Red Hat Satellite Authentication

http/oauth2 · 2 schemes

SECURITY

Red Hat Satellite Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Red Hat Satellite Vulnerability Disclosure

security.txt · contact published

SECURITY

Red Hat Satellite Trust Center

ISO 27001, ISO 27018, HIPAA

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Red Hat Satellite Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Red Hat Satellite Agentic Access

22 operations · 13 acting

22 operations · 13 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Automated Server Provisioning

Provision new servers automatically using compute resources, host groups, and kickstart templates.

Security Patching at Scale

Identify, test, and deploy security errata across thousands of hosts using content views and promotion workflows.

Hybrid Cloud Management

Manage hosts across on-premises data centers and cloud providers from a single console.

Compliance Reporting

Generate compliance reports using OpenSCAP integration to verify hosts meet security baselines.

Air-Gapped Environment Management

Manage systems in disconnected environments using content synchronization and inter-satellite sync.

Integrations 8

Pre-built integrations with other platforms and tools.

Ansible

Automate Satellite operations and host configuration using the redhat.satellite Ansible collection.

Red Hat Insights

Proactive risk analysis and remediation recommendations for managed hosts.

Puppet

Apply and enforce configuration management policies using Puppet modules and classes.

OpenSCAP

Security compliance scanning and reporting using SCAP content and policies.

VMware vSphere

Provision and manage virtual machines on VMware infrastructure as compute resources.

Red Hat OpenStack

Provision and manage instances on OpenStack as compute resources.

Amazon EC2

Provision and manage cloud instances on AWS as compute resources.

Google GCE

Provision and manage cloud instances on Google Cloud as compute resources.

Scroll for all 8

Resources

Get Started 1

Portal, sign-up, and the first successful call

Documentation 6

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

Build 4

SDKs, sample code, and the tooling you integrate with

Access & Security 5

Authentication, authorization, and security posture

Operate 5

Status, limits, changes, and where to get help

Company 1

The organization behind the API

Other 1

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: red-hat-satellite
name: Red Hat Satellite
description: Red Hat Satellite is a systems management product that helps deploy, configure, and maintain systems across physical,
  virtual, and cloud environments.
type: Index
accessModel:
  pricing: enterprise
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Enterprise · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
url: https://raw.githubusercontent.com/api-evangelist/red-hat-satellite/refs/heads/main/apis.yml
tags:
- Configuration Management
- Lifecycle Management
- Patch Management
- Subscription Management
- Systems Management
created: '2024-01-01'
modified: '2026-05-19'
specificationVersion: '0.19'
apis:
- name: Red Hat Satellite Hammer CLI
  description: Command-line interface tool for Red Hat Satellite that provides scriptable access to Satellite functions including
    host management, content views, and provisioning.
  image: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
  humanURL: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_hammer_cli_tool/index
  tags:
  - Automation
  - CLI
  - Command Line
  properties:
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_hammer_cli_tool/index
  - type: CodeExamples
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html/using_the_hammer_cli_tool/hammer-cheat-sheet
  - type: Authentication
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html/using_the_hammer_cli_tool/hammer-authentication
  contact:
  - type: Support
    url: https://access.redhat.com/support
- name: Red Hat Satellite Foreman API
  description: Core Foreman API integrated into Red Hat Satellite for host lifecycle management, provisioning, and configuration
    management. This is the upstream project API that powers Satellite's core functionality including the web UI, users, organizations,
    and security.
  image: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
  baseURL: https://satellite.example.com/api
  humanURL: https://theforeman.org/api.html
  tags:
  - Foreman
  - Host Management
  - Provisioning
  - REST API
  properties:
  - type: Documentation
    url: https://apidocs.theforeman.org/
  - type: APIReference
    url: https://apidocs.theforeman.org/foreman/latest/apidoc/v2.html
  - type: GitHubOrganization
    url: https://github.com/theforeman
  - type: GitHubRepository
    url: https://github.com/theforeman/foreman
  - type: GitHubRepository
    url: https://github.com/theforeman/apidocs
    title: API Docs Repository
  contact:
  - type: Support
    url: https://access.redhat.com/support
  - type: Support
    url: https://community.theforeman.org/
- name: Red Hat Satellite Katello API
  description: Content management API for Red Hat Satellite handling repositories, content views, lifecycle environments,
    subscriptions, and errata. Katello is the upstream plugin that provides Satellite's content and subscription management
    capabilities.
  image: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
  baseURL: https://satellite.example.com/katello/api
  humanURL: https://theforeman.org/plugins/katello/
  tags:
  - Content Management
  - Lifecycle Environments
  - Repositories
  - REST API
  - Subscriptions
  properties:
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: APIReference
    url: https://apidocs.theforeman.org/katello/latest/apidoc/v2.html
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/managing_content/index
    title: Content Management Guide
  - type: GitHubRepository
    url: https://github.com/Katello/katello
  - type: GitHubOrganization
    url: https://github.com/Katello
  contact:
  - type: Support
    url: https://access.redhat.com/support
- name: Red Hat Satellite Ansible Collection
  description: The redhat.satellite Ansible collection provides modules, roles, and plugins for automating Red Hat Satellite
    configuration and management through the Satellite API. Based on the theforeman.foreman community collection.
  image: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
  humanURL: https://catalog.redhat.com/en/software/collection/redhat/satellite
  tags:
  - Ansible
  - Automation
  - Configuration Management
  - Infrastructure as Code
  properties:
  - type: Documentation
    url: https://redhatsatellite.github.io/satellite-ansible-collection/develop/README.html
  - type: GitHubRepository
    url: https://github.com/RedHatSatellite/satellite-ansible-collection
  - type: Marketplace
    url: https://catalog.redhat.com/en/software/collection/redhat/satellite
  - type: GitHubRepository
    url: https://github.com/theforeman/foreman-ansible-modules
    title: Community Upstream
  - type: Blog
    url: https://www.redhat.com/en/blog/automating-red-hat-satellite-with-ansible
  contact:
  - type: Support
    url: https://access.redhat.com/support
- aid: red-hat-satellite:red-hat-satellite-content-views-api
  name: Red Hat Satellite Content Views API
  description: Manage content views which define curated sets of repositories and packages available to hosts.
  humanURL: https://access.redhat.com/documentation/en-us/red_hat_satellite/
  baseURL: https://satellite.example.com/api/v2
  tags:
  - Content Views
  properties:
  - type: OpenAPI
    url: openapi/red-hat-satellite-content-views-api-openapi.yml
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-subscription-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-lifecycle-environment-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-organization-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-foreman-task-schema.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-subscription-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-lifecycle-environment-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-organization-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-foreman-task-structure.json
  - type: Examples
    url: examples/red-hat-satellite-host-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-subscription-example.json
  - type: Examples
    url: examples/red-hat-satellite-lifecycle-environment-example.json
  - type: Examples
    url: examples/red-hat-satellite-organization-example.json
  - type: Examples
    url: examples/red-hat-satellite-foreman-task-example.json
  - type: JSONLD
    url: json-ld/red-hat-satellite-context.jsonld
  - type: Authentication
    url: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/api_guide/chap-api_guide-authentication
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/introduction-to-satellite-api
  - type: APIReference
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index
- aid: red-hat-satellite:red-hat-satellite-hosts-api
  name: Red Hat Satellite Hosts API
  description: Manage hosts registered with Red Hat Satellite including physical, virtual, and cloud instances.
  humanURL: https://access.redhat.com/documentation/en-us/red_hat_satellite/
  baseURL: https://satellite.example.com/api/v2
  tags:
  - Hosts
  properties:
  - type: OpenAPI
    url: openapi/red-hat-satellite-hosts-api-openapi.yml
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-subscription-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-lifecycle-environment-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-organization-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-foreman-task-schema.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-subscription-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-lifecycle-environment-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-organization-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-foreman-task-structure.json
  - type: Examples
    url: examples/red-hat-satellite-host-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-subscription-example.json
  - type: Examples
    url: examples/red-hat-satellite-lifecycle-environment-example.json
  - type: Examples
    url: examples/red-hat-satellite-organization-example.json
  - type: Examples
    url: examples/red-hat-satellite-foreman-task-example.json
  - type: JSONLD
    url: json-ld/red-hat-satellite-context.jsonld
  - type: Authentication
    url: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/api_guide/chap-api_guide-authentication
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/introduction-to-satellite-api
  - type: APIReference
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index
- aid: red-hat-satellite:red-hat-satellite-lifecycle-environments-api
  name: Red Hat Satellite Lifecycle Environments API
  description: Manage lifecycle environments that define promotion paths for content views from development through production.
  humanURL: https://access.redhat.com/documentation/en-us/red_hat_satellite/
  baseURL: https://satellite.example.com/api/v2
  tags:
  - Lifecycle Environments
  properties:
  - type: OpenAPI
    url: openapi/red-hat-satellite-lifecycle-environments-api-openapi.yml
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-subscription-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-lifecycle-environment-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-organization-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-foreman-task-schema.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-subscription-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-lifecycle-environment-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-organization-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-foreman-task-structure.json
  - type: Examples
    url: examples/red-hat-satellite-host-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-subscription-example.json
  - type: Examples
    url: examples/red-hat-satellite-lifecycle-environment-example.json
  - type: Examples
    url: examples/red-hat-satellite-organization-example.json
  - type: Examples
    url: examples/red-hat-satellite-foreman-task-example.json
  - type: JSONLD
    url: json-ld/red-hat-satellite-context.jsonld
  - type: Authentication
    url: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/api_guide/chap-api_guide-authentication
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/introduction-to-satellite-api
  - type: APIReference
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index
- aid: red-hat-satellite:red-hat-satellite-organizations-api
  name: Red Hat Satellite Organizations API
  description: Manage organizations which provide multi-tenancy isolation for hosts, content, and subscriptions.
  humanURL: https://access.redhat.com/documentation/en-us/red_hat_satellite/
  baseURL: https://satellite.example.com/api/v2
  tags:
  - Organizations
  properties:
  - type: OpenAPI
    url: openapi/red-hat-satellite-organizations-api-openapi.yml
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-subscription-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-lifecycle-environment-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-organization-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-foreman-task-schema.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-subscription-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-lifecycle-environment-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-organization-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-foreman-task-structure.json
  - type: Examples
    url: examples/red-hat-satellite-host-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-subscription-example.json
  - type: Examples
    url: examples/red-hat-satellite-lifecycle-environment-example.json
  - type: Examples
    url: examples/red-hat-satellite-organization-example.json
  - type: Examples
    url: examples/red-hat-satellite-foreman-task-example.json
  - type: JSONLD
    url: json-ld/red-hat-satellite-context.jsonld
  - type: Authentication
    url: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/api_guide/chap-api_guide-authentication
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/introduction-to-satellite-api
  - type: APIReference
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index
- aid: red-hat-satellite:red-hat-satellite-subscriptions-api
  name: Red Hat Satellite Subscriptions API
  description: Manage Red Hat subscriptions and entitlements for organizations and hosts.
  humanURL: https://access.redhat.com/documentation/en-us/red_hat_satellite/
  baseURL: https://satellite.example.com/api/v2
  tags:
  - Subscriptions
  properties:
  - type: OpenAPI
    url: openapi/red-hat-satellite-subscriptions-api-openapi.yml
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-host-interface-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-create-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-content-view-update-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-subscription-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-lifecycle-environment-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-organization-schema.json
  - type: JSONSchema
    url: json-schema/red-hat-satellite-foreman-task-schema.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-host-interface-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-create-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-content-view-update-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-subscription-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-lifecycle-environment-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-organization-structure.json
  - type: JSONStructure
    url: json-structure/red-hat-satellite-foreman-task-structure.json
  - type: Examples
    url: examples/red-hat-satellite-host-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-example.json
  - type: Examples
    url: examples/red-hat-satellite-host-interface-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-create-example.json
  - type: Examples
    url: examples/red-hat-satellite-content-view-update-example.json
  - type: Examples
    url: examples/red-hat-satellite-subscription-example.json
  - type: Examples
    url: examples/red-hat-satellite-lifecycle-environment-example.json
  - type: Examples
    url: examples/red-hat-satellite-organization-example.json
  - type: Examples
    url: examples/red-hat-satellite-foreman-task-example.json
  - type: JSONLD
    url: json-ld/red-hat-satellite-context.jsonld
  - type: Authentication
    url: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/api_guide/chap-api_guide-authentication
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/introduction-to-satellite-api
  - type: APIReference
    url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/red-hat-satellite/overview
- type: AgenticAccess
  url: agentic-access/red-hat-satellite-agentic-access.yml
- type: TrustCenter
  url: security/red-hat-satellite-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/red-hat-satellite-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/red-hat-satellite-domain-security.yml
- type: Authentication
  url: authentication/red-hat-satellite-authentication.yml
- type: OAuthScopes
  url: scopes/red-hat-satellite-scopes.yml
- type: Portal
  url: https://access.redhat.com/
- type: Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16
- type: Support
  url: https://access.redhat.com/support/
- type: StatusPage
  url: https://status.redhat.com/
- type: Blog
  url: https://www.redhat.com/en/blog/channel/red-hat-satellite
- type: GitHubOrganization
  url: https://github.com/theforeman
- type: KnowledgeCenter
  url: https://access.redhat.com/solutions/
- type: Support
  url: https://access.redhat.com/community/
  title: Community
- type: Support
  url: https://community.theforeman.org/
  title: Foreman Community
- type: ReleaseNotes
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html-single/release_notes/index
- type: Documentation
  url: https://access.redhat.com/support/policy/updates/satellite
  title: Product Lifecycle
- type: Documentation
  url: https://access.redhat.com/articles/1365633
  title: Release Dates
- type: Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html/provisioning_hosts/index
  title: Provisioning Guide
- type: Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/managing_content/index
  title: Managing Hosts Guide
- type: APIReference
  url: https://apidocs.theforeman.org/
- type: CLI
  url: https://github.com/theforeman/hammer-cli-foreman
  title: Hammer CLI
- type: GitHubRepository
  url: https://github.com/theforeman/foreman-ansible-modules
  title: Ansible Modules
- type: SpectralRules
  url: rules/red-hat-satellite-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/red-hat-satellite-vocabulary.yaml
- type: Features
  data:
  - name: Host Management
    description: Manage physical, virtual, and cloud hosts across the entire lifecycle from provisioning to decommissioning.
  - name: Content Management
    description: Curate and distribute RPM packages, errata, and container images through content views and lifecycle environments.
  - name: Patch Management
    description: Apply security patches and errata across managed systems with controlled rollouts through lifecycle stages.
  - name: Subscription Management
    description: Track and manage Red Hat subscriptions and entitlements across organizations and hosts.
  - name: Provisioning
    description: Automate bare-metal and virtual machine provisioning with kickstart templates, PXE boot, and compute resources.
  - name: Configuration Management
    description: Enforce desired-state configuration using Puppet classes and Ansible roles across managed hosts.
  - name: Multi-Tenancy
    description: Organize hosts, content, and subscriptions into isolated organizations and locations.
- type: UseCases
  data:
  - name: Automated Server Provisioning
    description: Provision new servers automatically using compute resources, host groups, and kickstart templates.
  - name: Security Patching at Scale
    description: Identify, test, and deploy security errata across thousands of hosts using content views and promotion workflows.
  - name: Hybrid Cloud Management
    description: Manage hosts across on-premises data centers and cloud providers from a single console.
  - name: Compliance Reporting
    description: Generate compliance reports using OpenSCAP integration to verify hosts meet security baselines.
  - name: Air-Gapped Environment Management
    description: Manage systems in disconnected environments using content synchronization and inter-satellite sync.
- type: Integrations
  data:
  - name: Ansible
    description: Automate Satellite operations and host configuration using the redhat.satellite Ansible collection.
  - name: Red Hat Insights
    description: Proactive risk analysis and remediation recommendations for managed hosts.
  - name: Puppet
    description: Apply and enforce configuration management policies using Puppet modules and classes.
  - name: OpenSCAP
    description: Security compliance scanning and reporting using SCAP content and policies.
  - name: VMware vSphere
    description: Provision and manage virtual machines on VMware infrastructure as compute resources.
  - name: Red Hat OpenStack
    description: Provision and manage instances on OpenStack as compute resources.
  - name: Amazon EC2
    description: Provision and manage cloud instances on AWS as compute resources.
  - name: Google GCE
    description: Provision and manage cloud instances on Google Cloud as compute resources.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com