Chapter 1. Introduction to Satellite API

The Satellite API offers several benefits and supports various use cases for integrating the API into your workflows.

The benefits of using the REST API are:

You can use the REST API to perform the following tasks:

For many tasks, you can use both Hammer and Satellite API. In these situations, you can choose whether Hammer or Satellite API is the more suitable tool for your use case.

You can use Hammer as a human-friendly interface to Satellite API. For example, to test responses to API calls before applying them in a script, use the --debug option to inspect API calls that Hammer issues: hammer --debug organization list.

In the background, each Hammer command first establishes a binding to the API, then sends a request. This can have performance implications when executing a large number of Hammer commands in sequence. In contrast, a script communicating directly with the API establishes the binding only once.

You can use the API reference on your Satellite Server to view information about API endpoints supported for Satellite API integrations.

View the full API reference on your Satellite Server at the following URL:

https://satellite.example.com/apidoc/

Replace satellite.example.com with the FQDN of your Satellite Server.