Chapter 1. Introduction to Satellite API

Integrate with enterprise systems, automate repetitive tasks, and manage your infrastructure programmatically using the resource-based REST model of the Satellite API. You can use any HTTP client to interact with Satellite.

The benefits of using the REST API are:

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

Hammer serves as a human-friendly interface to Satellite API. Use Hammer for interactive tasks and testing API calls, but use the API directly for better performance when executing many commands in scripts.

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.