Chapter 1. Introduction to Red Hat Satellite API

Red Hat Satellite is a system management solution that allows organizations to deploy, configure, and maintain their systems across physical, virtual, and cloud environments. It allows for provisioning, remote management and monitoring of multiple Red Hat Enterprise Linux deployments with a single, centralized tool. Red Hat Satellite Server synchronizes the content from Red Hat Customer Portal, and provides functionality including fine-grained life cycle management, user and group role-based access control, integrated subscription management, as well as advanced GUI, CLI, or API access.

1.1. The Red Hat Satellite API

Red Hat Satellite provides a Representational State Transfer (REST) API. The API provides software developers and system administrators with control over their Red Hat Satellite environment outside of the standard web interface. The REST API is useful for developers and administrators who aim to integrate the functionality of Red Hat Satellite with custom scripts or external applications that access the API over HTTP.

Note

The full API reference is available on your Satellite Server at https://satellite6.example.com/apidoc/v2.html (replace satellite6.example.com with the host name of your Satellite Server). Be aware that even though versions 1 and 2 of the Satellite 6 API are available, Red Hat only supports version 2.
The benefits of the REST API are:
  • Broad client support: Any programming language, framework, or system with support for HTTP protocol can use the API;
  • Self descriptive: Client applications require minimal knowledge of the Red Hat Satellite infrastructure as many details are discovered at runtime;
  • Resource based model: The resource based REST model provides a natural way to manage a virtualization platform.
This provides developers and administrators the ability to:
  • integrate with enterprise IT systems;
  • integrate with third-party applications;
  • perform automated maintenance or error checking tasks;
  • automate repetitive tasks with scripts.