API Guide

Red Hat Satellite 6.0

Reference documentation for using Satellite's Representational State Transfer (REST) APIs

Red Hat Satellite Documentation Team

Abstract

This guide explains the usage of the Representational State Transfer (REST) APIs for Satellite.

Part I. Using Red Hat Satellite API

Chapter 1. About Red Hat Satellite

Red Hat Satellite is an Infrastructure-as-a-Service (IaaS) application that provides tools to update systems within hybrid clouds. Satellite is a systems management server that can be used to configure new systems, subscribe to updates, and maintain installations in distributed environments. It provides content, manages Red Hat entitlements, performs provisioning and configuration management of pre-defined standard operating environments.

1.1. About 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 via the standard Hypertext Transfer Protocol (HTTP).
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 with the ability to:
  • Integrate with enterprise IT systems;
  • Integrate with third-party applications;
  • Perform automated maintenance or error checking tasks; and
  • Automate repetitive tasks with scripts.
This documentation aims to provide developers and administrators with instructions and examples to help harness the functionality of Red Hat Satellite through the REST APIs.

1.2. Representational State Transfer

Representational State Transfer (REST) is a design architecture that focuses on resources for a specific service and their representations. A resource representation is a key abstraction of information that corresponds to one specific managed element on a server. A client sends a request to a server element located at a Uniform Resource Identifier (URI) and performs operations with standard HTTP methods, such as GET, POST, PUT, and DELETE. This provides a stateless communication between the client and server where each request acts independent of any other request and contains all necessary information to complete the request.

Chapter 2. Authentication

2.1. SSL Certification

Red Hat Satellite uses Hypertext Transfer Protocol Secure (HTTPS) [1] over the Secure Socket Layer (SSL), which provides users with a degree of encryption and identity verification when communicating with a Red Hat Satellite host.
Each Red Hat Satellite host uses a self-signed certificate. This certificate acts as both the server certificate to verify the encryption key and the certificate authority (CA) to trust the identity of the Red Hat Satellite server.

Procedure 2.1. Attaining a certificate

This method uses SSH to copy the server's self-signed certificate.
  1. Login to your host with ssh as the root user:
    # ssh root@[host]
    
  2. Search your server's configuration directory for the certificate location:
    # grep -r "SSLCertificateFile" /etc/httpd/conf.d
    

    Note

    The default location of self-signed certificates is usually /etc/candlepin/certs/candlepin-ca.crt.
  3. Secure copy this certificate to your client.
    # scp [cert-file] [username]@[client]:~/.
    
Use this certificate on your client as a certificate authority (CA) to verify the identity of the host server.

Important

cURL examples in his guide use the CA with the --cacert option.
# curl -X GET -u cfadmin:123456 \
    -H "Accept:application/json" \
    --cacert [FILE] \
    https://satellite.example.com/katello/api/organizations
To permanently include the certificate with cURL's CA store, use the following command for the Red Hat Satellite CA:
# certutil -d sql:$HOME/.pki/nssdb -A -t TC -n "Red Hat Satellite" -i [SATELLITE CERT FILE]
This imports the certificate into the Network Security Services (NSS) Database, which allows cURL users to omit the --cacert option for each request.

2.2. HTTP Authentication

An API user submits a mandatory Red Hat Satellite username and password with all requests to the APIs and uses HTTP Basic Authentication [2] to encode these credentials. If a request does not include an appropriate Authorization header, the API returns a 401 Authorization Required as a result:

Example 2.1. Access to a REST API without appropriate credentials

HEAD [base] HTTP/1.1
Host: [host]

HTTP/1.1 401 Authorization Required
Request are issued with an Authorization header for the specified server. An API user encodes an appropriate username in the supplied credentials with the username:password convention.

Table 2.1. Encoding credentials for access to an API

Item Value
username admin
password 123456
unencoded credentials admin:123456
base64 encoded credentials YWRtaW46MTIzNDU2
This table shows the process for encoding credentials in base64.
An API user provides the base64 encoded credentials as shown:

Example 2.2. Access to a REST API with appropriate credentials

HEAD [base] HTTP/1.1
Host: [host]
Authorization: Basic YWRtaW46MTIzNDU2

HTTP/1.1 200 OK
...

Important

Basic authentication involves potentially sensitive information, such as passwords, sent as plain text. The REST APIs require Hypertext Transfer Protocol Secure (HTTPS) for transport-level encryption of plain-text requests.

Important

Some base64 libraries break the result into multiple lines and terminate each line with a newline character. This breaks the header and causes a faulty request. The Authorization header requires the encoded credentials on a single line within the header.

Chapter 3. Common REST API Functions

3.1. Listing All Resources in a Collection

Obtain a listing of resources in a collection with a GET request on the collection URI obtained from the entry point.
Include an Accept HTTP header to define the MIME type for the response format.
GET /api/[collection] HTTP/1.1
Accept: [MIME type]

3.2. Retrieving a Resource

Obtain the state of a resource with a GET request on a URI obtained from a collection listing.
Include an Accept HTTP header to define the MIME type for the response format.
GET /api/[collection]/[resource_id] HTTP/1.1
Accept: [MIME type]

3.3. Creating a Resource in a Collection

Create a new resource with a POST request to the collection URI containing a representation of the new resource.
A POST request requires a Content-Type header. This informs the API of the representation MIME type in the body content as part of the request.
Include an Accept HTTP header to define the MIME type for the response format.
Each resource type has its own specific required properties. The client supplies these properties when creating a new resource. Refer to the individual resource type documentation for more details.
If a required property is absent, the creation fails with a representation indicating the missing elements.
POST /api/[collection] HTTP/1.1
Accept: [MIME type]
Content-Type: [MIME type]

[body]

3.4. Updating a Resource

Modify resource properties with a PUT request containing an updated description from a previous GET request for the resource URI. Details on modifiable properties are found in the individual resource type documentation.
A PUT request requires a Content-Type header. This informs the API of the representation MIME type in the body content as part of the request.
Include an Accept HTTP header to define the MIME type for the response format.
PUT /api/collection/resource_id HTTP/1.1
Accept: [MIME type]
Content-Type: [MIME type]

[body]
This does not include immutable resource properties that an API user has attempted to modify. If an attempt is made to modify a strictly immutable resource property, the API reports a conflict with an error message representation in the response body.
Properties omitted from the representation are ignored and not changed.

3.5. Deleting a Resource

Delete a resource with a DELETE request sent to its URI.
Include an Accept HTTP header to define the MIME type for the response format.
DELETE /api/[collection]/[resource_id] HTTP/1.1
Accept: [MIME type]
Some cases require optional body content in the DELETE request to specify additional properties. A DELETE request with optional body content requires a Content-Type header to inform the API of the representation MIME type in the body content. If a DELETE request contains no body content, omit the Content-Type header.

Chapter 4. Examples

4.1. Satellite 6 API Python Example

The following script connects to the Red Hat Satellite 6 API and creates a new organization, then creates three environments in the new organization. If the organization already exists, the script uses that organization. If any of the environments already exist in the organization, the script raises an error and quits.

Important

This script requires the requests and json modules.
#!/usr/bin/python

import json
import sys


try:
    import requests
except ImportError:
    print "Please install the python-requests module."
    sys.exit(-1)

# URL to your Satellite 6 server
URL = "https://satellite6.example.com"
# URL for the API to your deployed Satellite 6 server
SAT_API = "%s/katello/api/v2/" % URL
# Katello-specific API
KATELLO_API = "%s/katello/api/" % URL
POST_HEADERS = {'content-type': 'application/json'}
# Default credentials to login to Satellite 6
USERNAME = "admin"
PASSWORD = "changeme"
# Ignore SSL for now
SSL_VERIFY = False

# Name of the organization to be either created or used
ORG_NAME = "MyOrg"
# Name for lifecycle environments to be either created or used
ENVIRONMENTS = ["Development", "Testing", "Production"]


def get_json(location):
    """
    Performs a GET using the passed URL location
    """

    r = requests.get(location, auth=(USERNAME, PASSWORD), verify=SSL_VERIFY)

    return r.json()


def post_json(location, json_data):
    """
    Performs a POST and passes the data to the URL location
    """

    result = requests.post(
        location,
        data=json_data,
        auth=(USERNAME, PASSWORD),
        verify=SSL_VERIFY,
        headers=POST_HEADERS)

    return result.json()


def main():
    """
    Main routine that creates or re-uses an organization and
    lifecycle environments. If lifecycle environments already
    exist, exit out.
    """

    # Check if our organization already exists
    org = get_json(SAT_API + "organizations/" + ORG_NAME)

    # If our organization is not found, create it
    if org.get('error', None):
        org_id = post_json(
            SAT_API + "organizations/",
            json.dumps({"name": ORG_NAME}))["organization"]["id"]
        print "Creating organization: \t" + ORG_NAME
    else:
        # Our organization exists, so let's grab it
        org_id = org['id']
        print "Organization '%s' exists." % ORG_NAME

    # Now, let's fetch all available lifecycle environments for this org...
    envs = get_json(
        SAT_API + "organizations/" + str(org_id) + "/environments/")

    # ... and add them to a dictionary, with respective 'Prior' environment
    prior_env_id = 0
    env_list = {}
    for env in envs['results']:
        env_list[env['id']] = env['name']
        prior_env_id = env['id'] if env['name'] == "Library" else prior_env_id

    # Exit the script if at least one lifecycle environment already exists
    if all(environment in env_list.values() for environment in ENVIRONMENTS):
        print "ERROR: One of the Environments is not unique to organization"
        sys.exit(-1)

    # Create lifecycle environments
    for environment in ENVIRONMENTS:
        new_env_id = post_json(
            SAT_API + "organizations/" + str(org_id) + "/environments/",
            json.dumps(
                {
                    "name": environment,
                    "organization_id": org_id,
                    "prior": prior_env_id}
            ))["id"]

        print "Creating environment: \t" + environment
        prior_env_id = new_env_id


if __name__ == "__main__":
    main()

Warning

This script does not use SSL verification for interacting with the REST API and is provided here only as a demonstration.

4.2. Satellite 6 API Ruby Example

The following script connects to the Red Hat Satellite 6 API and creates a new organization, then creates three environments in the new organization. If the organization already exists, the script uses that organization. If any of the environments already exist in the organization, the script raises an error and quits.

Important

This script requires the rest-client and json Ruby gems.
#!/usr/bin/ruby

require 'rest-client'
require 'json'

url = 'https://satellite6.example.com/api/v2/'
katello_url = 'https://satellite6.example.com/katello/api/v2/'
$username = 'admin'
$password = 'changeme'

org_name = "MyOrg"
environments = ["Development","Testing","Production"]

def get_json(location)
    response = RestClient::Request.new(
        :method => :get,
        :url => location,
        :user => $username,
        :password => $password,
        :headers => { :accept => :json,
        :content_type => :json }
    ).execute
    results = JSON.parse(response.to_str)
end

def post_json(location, json_data)
    response = RestClient::Request.new(
        :method => :post,
        :url => location,
        :user => $username,
        :password => $password,
        :headers => { :accept => :json,
        :content_type => :json},
        :payload => json_data
    ).execute
    results = JSON.parse(response.to_str)
end

orgs = get_json(url+"organizations")
org_list = {}
orgs['results'].each do |org|
    org_list[org['id']] = org['name']
end

if !org_list.has_value?(org_name)
    org_id = post_json(url+"organizations", JSON.generate({"name"=> org_name}))["organization"]["id"]
    puts "Creating organization: \t" + org_name
else
    org_id = org_list.key(org_name)
    puts "Organization \"" + org_name + "\" exists"
end

envs = get_json(katello_url+"organizations/" + org_id.to_s + "/environments")
env_list = {}
envs['results'].each do |env|
    env_list[env['id']] = env['name']
end
prior_env_id = env_list.key("Library")

environments.each do |e|
    if env_list.has_value?(e)
        puts "ERROR: One of the Environments is not unique to organization"
        exit()
    end
end

environments.each do |environment|
    new_env_id = post_json(katello_url+"organizations/" + org_id.to_s + "/environments", JSON.generate({"name" => environment, "organization_id" => org_id,"prior" => prior_env_id}))["id"]
    puts "Creating environment: \t" + environment
    prior_env_id = new_env_id
end
exit()

Warning

This script does not use SSL communication for interacting with the REST API and is provided here only as a demonstration.

Part II. Red Hat Satellite API

Chapter 5. API Entry Point

The Red Hat Satellite API uses a JavaScript Object Notation (JSON) format for representations. Use the application/json MIME type for Accept and Content-type HTTP headers.
A user begins interacting with the API through a GET request on the entry point URI consisting of a host and base.
GET [base] HTTP/1.1
Host: [host]
The base entry point is the location on the host to apply the request. The Red Hat Satellite 6 API has two base entry points:
  • /api/ - System provisioning and management functions
  • /katello/api/ - Subscription and content management functions
The base entry point also requires a version number in the following format: vN, when N represents the version number. For example:
https://satellite.example.com/api/v2/

Note

v2 is the current supported version for Red Hat Satellite 6.0. v1 is deprecated.

Example 5.1. Viewing a Representation of the Entry Point

If the host is satellite.example.com and the base is /katello/api/v2, the entry point appears using the following:
cURL command

# curl -u admin:123456 -H "Accept:application/json" \
    --cacert [FILE] \
    https://satellite.example.com/api/v2/

Request

GET /katello/api HTTP/1.1
Host: satellite.example.com
Authorization: Basic YWRtaW46MTIzNDU2
Accept: application/xml

Response

[
    {
        "href": "/api/systems/",
        "rel": "systems"
    },
    {
        "href": "/api/providers/",
        "rel": "providers"
    },
    {
        "href": "/api/templates/",
        "rel": "templates"
    },
    ...
]

Chapter 6. Activation Keys

6.1. List Activation Keys

  • GET /katello/api/v2/activation_keys
    List activation keys
  • GET /katello/api/v2/environments/:environment_id/activation_keys
    List activation keys for environment
  • GET /katello/api/v2/organizations/:organization_id/activation_keys
    List activation keys for organizations

Table 6.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name False String Activation key name to use as a filter
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

6.2. Create an Activation Key

  • POST /katello/api/v2/activation_keys
    Create an activation key

Table 6.2. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name True String Plain text name
description False String Plain text description
environment False Hash Environment subcollection
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
max_content_hosts False Number Maximum number of registered content hosts
unlimited_content_hosts False Boolean Set if the activation key can have unlimited content hosts

6.3. Update an Activation Key

  • PUT /katello/api/v2/activation_keys/:id
    Update an activation key

Table 6.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space ID of the activation key
organization_id True Number Organization identifier
name True String Plain text name
description False String Plain text description
environment_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
max_content_hosts False Number Maximum number of registered content hosts
unlimited_content_hosts False boolean Defines if the activation key can have unlimited content hosts
release_version False String Content release version
service_level False String Content service level

6.4. Destroy an Activation Key

  • DELETE /katello/api/v2/activation_keys/:id
    Destroy an activation key

Table 6.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space ID of the activation key

6.5. Show an Activation Key

  • GET /katello/api/v2/activation_keys/:id
    Show an activation key

Table 6.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space ID of the activation key
organization_id False Number Organization identifier

6.6. List Host Collections the System Does Not Belong To

  • GET /katello/api/v2/activation_keys/:id/host_collections/available
    List host collections the system does not belong to

Table 6.6. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.
name False String Host collection name to use as a filter

6.7. Show Release Versions Available for an Activation Key

  • GET /katello/api/v2/activation_keys/:id/releases
    Show release versions available for an activation key

Table 6.7. Parameters

Name Required Type Description
id True String ID of the activation key

6.8. Assign Activation Key to Host Collections

  • PUT /katello/api/v2/activation_keys/:id/host_collections
    Assign activation key to host collections

Table 6.8. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space ID of the activation key

Chapter 7. Architectures

7.1. List all Architectures

  • GET /api/v2/architectures
    List all architectures.

Table 7.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

7.2. Show an Architecture

  • GET /api/v2/architectures/:id
    Show an architecture.

Table 7.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Architecture identifier

7.3. Create an Architecture

  • POST /api/v2/architectures
    Create an architecture.

Table 7.3. Parameters

Name Required Type Description
architecture False Hash Architecture subcollection
architecture[name] True String Architecture name
architecture[operatingsystem_ids] False Array A list of operating system IDs

7.4. Update an Architecture

  • PUT /api/v2/architectures/:id
    Update an architecture.

Table 7.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Architecture identifier
architecture False Hash Architecture subcollection
architecture[name] False String Architecture name
architecture[operatingsystem_ids] False Array A list of operating system IDs

7.5. Delete an Architecture

  • DELETE /api/v2/architectures/:id
    Delete an architecture.

Table 7.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Architecture identifier

Chapter 8. Audits

8.1. List all Audits

  • GET /api/v2/audits
    List all audits.
  • GET /api/v2/hosts/:host_id/audits
    List all audits for a given host.

Table 8.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

8.2. Show an Audit

  • GET /api/v2/audits/:id
    Show an audit

Table 8.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Audit identifier

Chapter 9. Authentication Source (LDAPs)

9.1. List all LDAP Authentication Sources

  • GET /api/v2/auth_source_ldaps
    List all LDAP authentication sources

Table 9.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return

9.2. Show an LDAP Authentication Source

  • GET /api/v2/auth_source_ldaps/:id
    Show an LDAP authentication source.

Table 9.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Authentication source identifier

9.3. Create an LDAP Authentication Source

  • POST /api/v2/auth_source_ldaps
    Create an LDAP Authentication Source.

Table 9.3. Parameters

Name Required Type Description
auth_source_ldap False Hash Authentication source subcollection
auth_source_ldap[name] True String Authentication source name
auth_source_ldap[host] True String Authentication source hostname or IP address
auth_source_ldap[port] False Number Authentication source port. Defaults to 389.
auth_source_ldap[account] False String LDAP account to use for authentication.
auth_source_ldap[base_dn] False String Base DN to use for authentication.
auth_source_ldap[account_password] False String LDAP account password to use for authentication.
auth_source_ldap[attr_login] False String The LDAP attribute for the username. Required if onthefly_register is true.
auth_source_ldap[attr_firstname] False String The LDAP attribute for the user's first name. Required if onthefly_register is true.
auth_source_ldap[attr_lastname] False String The LDAP attribute for the user's last name. Required if onthefly_register is true.
auth_source_ldap[attr_mail] False String The LDAP attribute for the user's email address. Required if onthefly_register is true.
auth_source_ldap[attr_photo] False String The LDAP attribute for the user's photo or avatar. Required if onthefly_register is true.
auth_source_ldap[onthefly_register] False Boolean Register users from the LDAP authentication source in Satellite
auth_source_ldap[tls] False Boolean Set to true to use TLS for authentication.

9.4. Update an LDAP Authentication Source

  • PUT /api/v2/auth_source_ldaps/:id
    Update an LDAP Authentication Source.

Table 9.4. Parameters

Name Required Type Description
id True String Authentication identifier
auth_source_ldap False Hash Authentication source subcollection
auth_source_ldap[name] True String Authentication source name
auth_source_ldap[host] True String Authentication source hostname or IP address
auth_source_ldap[port] False Number Authentication source port. Defaults to 389.
auth_source_ldap[account] False String LDAP account to use for authentication.
auth_source_ldap[base_dn] False String Base DN to use for authentication.
auth_source_ldap[account_password] False String LDAP account password to use for authentication.
auth_source_ldap[attr_login] False String The LDAP attribute for the username. Required if onthefly_register is true.
auth_source_ldap[attr_firstname] False String The LDAP attribute for the user's first name. Required if onthefly_register is true.
auth_source_ldap[attr_lastname] False String The LDAP attribute for the user's last name. Required if onthefly_register is true.
auth_source_ldap[attr_mail] False String The LDAP attribute for the user's email address. Required if onthefly_register is true.
auth_source_ldap[attr_photo] False String The LDAP attribute for the user's photo or avatar. Required if onthefly_register is true.
auth_source_ldap[onthefly_register] False Boolean Register users from the LDAP authentication source in Satellite
auth_source_ldap[tls] False Boolean Set to true to use TLS for authentication.

9.5. Delete an LDAP Authentication Source

  • DELETE /api/v2/auth_source_ldaps/:id
    Delete an LDAP Authentication Source.

Table 9.5. Parameters

Name Required Type Description
id True String Authentication source identifier

Chapter 10. Autosign

10.1. List all Autosign

  • GET /api/v2/smart_proxies/:id/autosign
    List all autosign

Table 10.1. Parameters

Name Required Type Description
id True String Smart Proxy identifier

Chapter 11. Bookmarks

11.1. List all Bookmarks

  • GET /api/v2/bookmarks
    List all bookmarks.

Table 11.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return

11.2. Show a Bookmark

  • GET /api/v2/bookmarks/:id
    Show a bookmark.

Table 11.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Object identifier

11.3. Create a Bookmark

  • POST /api/v2/bookmarks
    Create a bookmark.

Table 11.3. Parameters

Name Required Type Description
bookmark False Hash Bookmark subcollection
bookmark[name] True String Bookmark name
bookmark[controller] True String Bookmark controller
bookmark[query] True String Bookmark query
bookmark[public] False Boolean Set to true if everyone can access this bookmark. Set to false if a private bookmark.

11.4. Update a Bookmark

  • PUT /api/v2/bookmarks/:id
    Update a bookmark.

Table 11.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Bookmark identifier
bookmark False Hash Bookmark subcollection
bookmark[name] False String Bookmark name
bookmark[controller] False String Bookmark controller
bookmark[query] False String Bookmark query
bookmark[public] False Boolean Set to true if everyone can access this bookmark. Set to false if a private bookmark.

11.5. Delete a Bookmark

  • DELETE /api/v2/bookmarks/:id
    Delete a bookmark.

Table 11.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Bookmark identifier

Chapter 12. Capsule content

12.1. List Lifecycle Environments attached to Capsule

  • GET /katello/api/capsules/:id/content/lifecycle_environments
    List the lifecycle environments attached to a capsule

Table 12.1. Parameters

Name Required Type Description
id True Integer Identifier of the capsule
organization_id False Integer Identifier of the organization to limit environments

12.2. List Lifecycle Environments not Attached to Capsule

  • GET /katello/api/capsules/:id/content/available_lifecycle_environments
    List the lifecycle environments not attached to a capsule

Table 12.2. Parameters

Name Required Type Description
id True Integer Identifier of the capsule
organization_id False Integer Identifier of the organization to limit environments

12.3. Add Lifecycle Environments to Capsule

  • POST /katello/api/capsules/:id/content/lifecycle_environments
    Add lifecycle environments to the capsule

Table 12.3. Parameters

Name Required Type Description
id True Integer Identifier of the capsule
environment_id True Integer Identifier of the lifecycle environment

12.4. Remove Lifecycle Environments from Capsule

  • DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id
    Remove lifecycle environments from a capsule

Table 12.4. Parameters

Name Required Type Description
id True Integer Identifier of the capsule
environment_id True Integer Identifier of the lifecycle environment

12.5. Synchronize Content to Capsule

  • POST /katello/api/capsules/:id/content/sync
    Synchronize the content to the capsule

Table 12.5. Parameters

Name Required Type Description
id True Integer Identifier of the capsule
environment_id False Integer Identifier of the environment to limit the synchronization

Chapter 13. Capsules

13.1. List all Capsules

  • GET /katello/api/capsules
    List all capsules

Table 13.1. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False number. Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

13.2. Show Capsule Details

  • GET /katello/api/capsules/:id
    Show the capsule details

Table 13.2. Parameters

Name Required Type Description
id True Integer Identifier of the capsule

Chapter 14. Common Parameters

14.1. List all Common Parameters

  • GET /api/v2/common_parameters
    List all common parameters.

Table 14.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

14.2. Show a Common Parameter

  • GET /api/v2/common_parameters/:id
    Show a common parameter.

Table 14.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Common parameter identifier

14.3. Create a Common Parameter

  • POST /api/v2/common_parameters
    Create a common parameter

Table 14.3. Parameters

Name Required Type Description
common_parameter False Hash Common parameter subcollection
common_parameter[name] True String Common parameter name
common_parameter[value] True String Common parameter value

14.4. Update a Common Parameter

  • PUT /api/v2/common_parameters/:id
    Update a common parameter

Table 14.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Common parameter identifier
common_parameter False Hash Common parameter subcollection
common_parameter[name] False String Common parameter name
common_parameter[value] False String Common parameter value

14.5. Delete a Common Parameter

  • DELETE /api/v2/common_parameters/:id
    Delete a common parameter

Table 14.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Common parameter identifier

Chapter 15. Compute Attributes

15.1. Create a Compute Attribute

  • POST /api/v2/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes
    Create a compute attribute
  • POST /api/v2/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes
    Create a compute attribute
  • POST /api/v2/compute_resources/:compute_resource_id/compute_attributes
    Create a compute attribute
  • POST /api/v2/compute_profiles/:compute_profile_id/compute_attributes
    Create a compute attribute
  • POST /api/v2/compute_attributes
    Create a compute attribute.

Table 15.1. Parameters

Name Required Type Description
compute_profile_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute profile identifier
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
compute_attribute False Hash Compute attributes subcollection
compute_attribute[vm_attrs] True Hash Compute attributes

15.2. Update a Compute Attribute

  • PUT /api/v2/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id
    Update a compute attribute
  • PUT /api/v2/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id
    Update a compute attribute
  • PUT /api/v2/compute_resources/:compute_resource_id/compute_attributes/:id
    Update a compute attribute
  • PUT /api/v2/compute_profiles/:compute_profile_id/compute_attributes/:id
    Update a compute attribute
  • PUT /api/v2/compute_attributes/:id
    Update a compute attribute.

Table 15.2. Parameters

Name Required Type Description
id True String Compute attribute identifier
compute_profile_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute profile identifier
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
compute_attribute False Hash Compute attributes subcollection
compute_attribute[vm_attrs] True Hash Compute attributes

Chapter 16. Compute Profiles

16.1. List of Compute Profiles

  • GET /api/v2/compute_profiles
    List of compute profiles

Table 16.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

16.2. Show a Compute Profile

  • GET /api/v2/compute_profiles/:id
    Show a compute profile.

Table 16.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute profile identifier

16.3. Create a Compute Profile

  • POST /api/v2/compute_profiles
    Create a compute profile.

Table 16.3. Parameters

Name Required Type Description
compute_profile False Hash Compute profile subcollection
compute_profile[name] True String Compute profile name

16.4. Update a Compute Profile

  • PUT /api/v2/compute_profiles/:id
    Update a compute profile.

Table 16.4. Parameters

Name Required Type Description
id True String Compute profile identifier
compute_profile False Hash Compute profile subcollection
compute_profile[name] False String Compute profile name

16.5. Delete a Compute Profile

  • DELETE /api/v2/compute_profiles/:id
    Delete a compute profile.

Table 16.5. Parameters

Name Required Type Description
id True String Compute profile identifier

Chapter 17. Compute Resources

17.1. List all Compute Resources

  • GET /api/v2/compute_resources
    List all compute resources.

Table 17.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

17.2. Show an Compute Resource

  • GET /api/v2/compute_resources/:id
    Show an compute resource.

Table 17.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

17.3. Create a Compute Resource

  • POST /api/v2/compute_resources
    Create a compute resource.

Table 17.3. Parameters

Name Required Type Description
compute_resource False Hash Compute resource subcollection
compute_resource[name] False String Compute resource name
compute_resource[provider] False String Compute resource provider type. Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, and GCE.
compute_resource[url] True String URL for Libvirt, RHEV (Ovirt), and Openstack providers
compute_resource[description] False String Compute resource description
compute_resource[user] False String Username for RHEV, EC2, Vmware, and Openstack providers. Access Key for EC2.
compute_resource[password] False String Password for RHEV, EC2, Vmware, and Openstack providers. Secret key for EC2.
compute_resource[uuid] False String Unique ID for the desired RHEV and Vmware data center
compute_resource[region] False String The desired region for EC2 providers only
compute_resource[tenant] False String The desired tenant for Openstack providers only
compute_resource[server] False String The desired server for Vmware providers only

17.4. Update a Compute Resource

  • PUT /api/v2/compute_resources/:id
    Update a compute resource.

Table 17.4. Parameters

Name Required Type Description
id True String Compute resource identifier
compute_resource False Hash Compute resource subcollection
compute_resource[name] False String Compute resource name
compute_resource[provider] False String Compute resource provider type. Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, and GCE.
compute_resource[url] True String URL for Libvirt, RHEV (Ovirt), and Openstack providers
compute_resource[description] False String Compute resource description
compute_resource[user] False String Username for RHEV, EC2, Vmware, and Openstack providers. Access Key for EC2.
compute_resource[password] False String Password for RHEV, EC2, Vmware, and Openstack providers. Secret key for EC2.
compute_resource[uuid] False String Unique ID for the desired RHEV and Vmware data center
compute_resource[region] False String The desired region for EC2 providers only
compute_resource[tenant] False String The desired tenant for Openstack providers only
compute_resource[server] False String The desired server for Vmware providers only

17.5. Delete a Compute Resource

  • DELETE /api/v2/compute_resources/:id
    Delete a compute resource.

Table 17.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

17.6. List Available Images for a Compute Resource

  • GET /api/v2/compute_resources/:id/available_images
    List available images for a compute resource.

Table 17.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

17.7. List Available Clusters for a Compute Resource

  • GET /api/v2/compute_resources/:id/available_clusters
    List available clusters for a compute resource

Table 17.7. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

17.8. List Available Networks for a Compute Resource

  • GET /api/v2/compute_resources/:id/available_networks
    List available networks for a compute resource
  • GET /api/v2/compute_resources/:id/available_clusters/:cluster_id/available_networks
    List available networks for a compute resource cluster

Table 17.8. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
cluster_id False String Cluster identifier on the compute resource

17.9. List Storage Domains for a Compute Resource

  • GET /api/v2/compute_resources/:id/available_storage_domains
    List storage domains for a compute resource

Table 17.9. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

Chapter 18. Config Groups

18.1. List of Config Groups

  • GET /api/v2/config_groups
    List of config groups

Table 18.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.

18.2. Show a Config Group

  • GET /api/v2/config_groups/:id
    Show a config group.

Table 18.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Config group identifier

18.3. Create a Config Group

  • POST /api/v2/config_groups
    Create a config group.

Table 18.3. Parameters

Name Required Type Description
config_group False Hash Config group subcollection
config_group[name] True String Config group name

18.4. Update a Config Group

  • PUT /api/v2/config_groups/:id
    Update a config group.

Table 18.4. Parameters

Name Required Type Description
id True String Config group identifier
config_group False Hash Config group subcollection
config_group[name] False String Config group name

18.5. Delete a Config Group

  • DELETE /api/v2/config_groups/:id
    Delete a config group.

Table 18.5. Parameters

Name Required Type Description
id True String Config group identifier

Chapter 19. Config Templates

19.1. List Templates

  • GET /api/v2/config_templates
    List templates

Table 19.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

19.2. Show Template Details

  • GET /api/v2/config_templates/:id
    Show template details

Table 19.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Config template identifier

19.3. Create a Template

  • POST /api/v2/config_templates
    Create a template

Table 19.3. Parameters

Name Required Type Description
config_template False Hash Config template subcollection
config_template[name] True String Config template name
config_template[template] True String Config template content
config_template[snippet] False Boolean Set to true if the config template content is a snippet
config_template[audit_comment] False String Audit comment for the config template
config_template[template_kind_id] False Number The type of config template. Not required for snippets.
config_template[template_combinations_attributes] False Array A list of attributes for template combinations. For example, hostgroup_id, environment_id.
config_template[operatingsystem_ids] False Array List of operating system IDs associated with the template
config_template[locked] False Boolean Defines if the template is locked from editing

19.4. Update a Template

  • PUT /api/v2/config_templates/:id
    Update a template

Table 19.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Config template identifier
config_template False Hash Config template subcollection
config_template[name] False String Config template name
config_template[template] False String Config template content
config_template[snippet] False Boolean Set to true if the config template content is a snippet
config_template[audit_comment] False String Audit comment for the config template
config_template[template_kind_id] False Number The type of config template. Not required for snippets.
config_template[template_combinations_attributes] False Array A list of attributes for template combinations. For example, hostgroup_id, environment_id.
config_template[operatingsystem_ids] False Array List of operating system IDs associated with the template
config_template[locked] False Boolean Defines if the template is locked from editing

19.5. List Revisions for Config Templates

  • GET /api/v2/config_templates/revision
    List revisions for config templates

Table 19.5. Parameters

Name Required Type Description
version False String The config template version

19.6. Delete a Template

  • DELETE /api/v2/config_templates/:id
    Delete a template

Table 19.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Config template identifier

19.7. Change the Default PXE Menu on all Configured TFTP Servers

  • GET /api/v2/config_templates/build_pxe_default
    Change the default PXE menu on all configured TFTP servers

Chapter 20. Content Uploads

20.1. Create an Upload Request

  • POST /katello/api/v2/repositories/:repo_id/content_uploads
    Create an upload request

Table 20.1. Parameters

Name Required Type Description
repo_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

20.2. Upload Part of a File's Content

  • PUT /katello/api/v2/repositories/:repo_id/content_uploads/:id/upload_bits
    Upload bits

Table 20.2. Parameters

Name Required Type Description
repo_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Upload request identifier
offset True Number The offset at which Pulp stores the file contents
content True File File contents

20.3. Delete an Upload Request

  • DELETE /katello/api/v2/repositories/:repo_id/content_uploads/:id
    Delete an upload request

Table 20.3. Parameters

Name Required Type Description
repo_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Upload request identifier

Chapter 21. Content View Filter Rules

21.1. List Filter Rules

  • GET /katello/api/v2/content_view_filters/:content_view_filter_id/rules
    List filter rules

Table 21.1. Parameters

Name Required Type Description
content_view_filter_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier

21.2. Create a Filter Rule

  • POST /katello/api/v2/content_view_filters/:content_view_filter_id/rules
    Create a filter rule. The parameters included should be based upon the filter type.

Table 21.2. Parameters

Name Required Type Description
content_view_filter_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
name False String Name of the package or package group
version False String Version of the package
min_version False String Minimum version of the package
max_version False String Maximum version of the package
errata_id False String Erratum identifier
errata_ids False Array List of erratum identifiers or a select all object
start_date False String Erratum start date in YYYY-MM-DD format
end_date False String Erratum end date in YYYY-MM-DD format
types False Array Erratum types. Can be enhancement, bugfix, security.

21.3. Show Filter Rule Information

  • GET /katello/api/v2/content_view_filters/:content_view_filter_id/rules/:id
    Show filter rule information

Table 21.3. Parameters

Name Required Type Description
content_view_filter_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Rule identifier

21.4. Update a Filter Rule

  • PUT /katello/api/v2/content_view_filters/:content_view_filter_id/rules/:id
    Update a filter rule. The parameters included should be based upon the filter type.

Table 21.4. Parameters

Name Required Type Description
content_view_filter_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Rule identifier
name False String Name of package or package group
version False String Version of package
min_version False String Minimum version of package
max_version False String Maximum version of package
errata_id False String Erratum identifier
start_date False String Erratum start date in YYYY-MM-DD format
end_date False String Erratum end date in YYYY-MM-DD format
types False Array Erratum types. Can be enhancement, bugfix, security.

21.5. Delete a Filter Rule

  • DELETE /katello/api/v2/content_view_filters/:content_view_filter_id/rules/:id
    Delete a filter rule

Table 21.5. Parameters

Name Required Type Description
content_view_filter_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Rule identifier

Chapter 22. Content View Filters

22.1. List Filters

  • GET /katello/api/v2/content_views/:content_view_id/filters
    List filters
  • GET /katello/api/v2/content_view_filters
    List filters

Table 22.1. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name False String Filter content view filters by name

22.2. Create a Filter for a Content View

  • POST /katello/api/v2/content_views/:content_view_id/filters
    Create a filter for a content view
  • POST /katello/api/v2/content_view_filters
    Create a filter for a content view

Table 22.2. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name True String Name of the filter
type True String Type of filter. Can be rpm, package_group, erratum
original_packages False Boolean Add all packages without errata to the included/excluded list. (Package Filter only)
inclusion False Boolean Specifies if content should be included or excluded. The default is false.
repository_ids False Array List of Repository identifiers
description False String Description of the filter

22.3. Show Filter Information

  • GET /katello/api/v2/content_views/:content_view_id/filters/:id
    Show filter information
  • GET /katello/api/v2/content_view_filters/:id
    Show filter information

Table 22.3. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier

22.4. Update a Filter

  • PUT /katello/api/v2/content_views/:content_view_id/filters/:id
    Update a filter
  • PUT /katello/api/v2/content_view_filters/:id
    Update a filter

Table 22.4. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
name False String Name for the filter
original_packages False Boolean Add all packages without errata to the included/excluded list. (Package Filter only)
inclusion False Boolean Specifies if content should be included or excluded. The default is false.
repository_ids False Array List of Repository identifiers

22.5. Delete a Filter

  • DELETE /katello/api/v2/content_views/:content_view_id/filters/:id
    Delete a filter
  • DELETE /katello/api/v2/content_view_filters/:id
    Delete a filter

Table 22.5. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier

22.6. Get Errata Available to Add to Filter

  • GET /katello/api/v2/content_views/:content_view_id/filters/:id/available_errata
    Get errata that are available to be added to the filter
  • GET /katello/api/v2/content_view_filters/:id/available_errata
    Get errata that are available to be added to the filter

Table 22.6. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
types False Must be an array of any type Errata types array ['security', 'bugfix', 'enhancement']
start_date False Datetime Start date that errata was issued on to the filter
end_date False Datetime End date that Errata was issued on to the filter

22.7. Get Package Groups Available to Add to Filter

  • GET /katello/api/v2/content_views/:content_view_id/filters/:id/available_package_groups
    Get package groups that are available to be added to the filter
  • GET /katello/api/v2/content_view_filters/:id/available_package_groups
    Get package groups that are available to be added to the filter

Table 22.7. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier

Chapter 23. Content View Puppet Modules

23.1. List Content View Puppet Modules

  • GET /katello/api/v2/content_views/:content_view_id/content_view_puppet_modules
    List content view puppet modules

Table 23.1. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name False String Name of the Puppet module
author False String Author of the Puppet module
uuid False String The UUID of the Puppet module to associate

23.2. Add a Puppet Module to the Content View

  • POST /katello/api/v2/content_views/:content_view_id/content_view_puppet_modules
    Add a puppet module to the content view

Table 23.2. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name False String Name of the puppet module
author False String Author of the puppet module
uuid False String UUID of the puppet module to associate

23.3. Show a Content View Puppet Module

  • GET /katello/api/v2/content_views/:content_view_id/content_view_puppet_modules/:id
    Show a content view puppet module

Table 23.3. Parameters

Name Required Type Description
content_view_id True Number Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space. puppet module ID

23.4. Update a Puppet Module Associated with Content View

  • PUT /katello/api/v2/content_views/:content_view_id/content_view_puppet_modules/:id
    Update a puppet module associated with the content view

Table 23.4. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Puppet module identifier
name False String Name of the puppet module
author False String Author of the puppet module
uuid False String UUID of the puppet module to associate

23.5. Remove a Puppet Module From the Content View

  • DELETE /katello/api/v2/content_views/:content_view_id/content_view_puppet_modules/:id
    Remove a puppet module from the content view

Table 23.5. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Puppet module identifierr

Chapter 24. Content View Versions

24.1. List Content View Versions

  • GET /katello/api/v2/content_view_versions
    List content view versions
  • GET /katello/api/v2/content_views/:content_view_id/content_view_versions
    List content view versions

Table 24.1. Parameters

Name Required Type Description
content_view_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier

24.2. Show Content View Version

  • GET /katello/api/v2/content_view_versions/:id
    Show content view version

Table 24.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view version identifier

24.3. Promote a Content View Version

  • POST /katello/api/v2/content_view_versions/:id/promote
    Promote a content view version

Table 24.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view version identifier
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier

24.4. Remove Content View Version

  • DELETE /katello/api/v2/content_view_versions/:id
    Remove content view version

Table 24.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view version identifier

Chapter 25. Content Views

25.1. List Content Views

  • GET /katello/api/v2/organizations/:organization_id/content_views
    List content views
  • GET /katello/api/v2/content_views
    List content views

Table 25.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
nondefault False Boolean Filter out default content views
noncomposite False boolean Filter out composite content views
without False Must be an array of any type Do not include this array of content views
name False String Name of the content view

25.2. Create a Content View

  • POST /katello/api/v2/organizations/:organization_id/content_views
    Create a content view
  • POST /katello/api/v2/content_views
    Create a content view

Table 25.2. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name True String Name of the content view
label False String Content view label
composite False Boolean Set to true if a composite content view
description False String Description for the content view
repository_ids False Array List of Repository identifiers
component_ids False Array List of component content view version identifiers for composite views

25.3. Update a Content View

  • PUT /katello/api/v2/content_views/:id
    Update a content view

Table 25.3. Parameters

Name Required Type Description
id True Number Content view identifier
name False String Name for the content view
description False String Description for the content view
repository_ids False Array List of Repository identifiers
component_ids False Array List of component content view version identifiers for composite views

25.4. Publish a Content View

  • POST /katello/api/v2/content_views/:id/publish
    Publish a content view

Table 25.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier

25.5. Show a Content View

  • GET /katello/api/v2/content_views/:id
    Show a content view

Table 25.5. Parameters

Name Required Type Description
id True Number Content view identifier

25.6. Get Puppet Modules Available to Add to Content View

  • GET /katello/api/v2/content_views/:id/available_puppet_modules
    Get puppet modules that are available to be added to the content view

Table 25.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
name False String Module name to restrict modules

25.7. Get Puppet Modules Names Available to Add to Content View

  • GET /katello/api/v2/content_views/:id/available_puppet_module_names
    Get puppet modules names that are available to be added to the content view

Table 25.7. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier

25.8. Show a Content View's History

  • GET /katello/api/v2/content_views/:id/history
    Show a content view's history

Table 25.8. Parameters

Name Required Type Description
id True Number Content view identifier

25.9. Remove a Content View From an Environment

  • DELETE /katello/api/v2/content_views/:id/environments/:environment_id
    Remove a content view from an environment

Table 25.9. Parameters

Name Required Type Description
id True Number Content view identifier
environment_id True Number Environment identifier

25.10. Remove Versions and Environments from Content View and Reassign Systems and Keys

  • PUT /katello/api/v2/content_views/:id/remove
    Remove versions and/or environments from a content view and reassign systems and keys

Table 25.10. Parameters

Name Required Type Description
id True Number Content view identifier
environment_ids False Number Environment identifiers for removal
content_view_version_ids False Number Content view version identifiers for removal
system_content_view_id False Number Content view to reassign orphaned systems
system_environment_id False Number Environment to reassign orphaned systems
key_content_view_id False Number Content view to reassign orphaned activation keys
key_environment_id False Number Environment to reassign orphaned activation keys

25.11. Delete a Content View

  • DELETE /katello/api/v2/content_views/:id
    Delete a content view

Table 25.11. Parameters

Name Required Type Description
id True Number Ccontent view identifier

25.12. Copy a Content View

  • POST /katello/api/content_views/:id/copy
    Make copy of a content view

Table 25.12. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view numeric identifier
name True String New content view name

Chapter 26. Custom Information

26.1. Create Custom Information

  • POST /katello/api/v2/custom_info/:informable_type/:informable_id
    Create custom information

Table 26.1. Parameters

Name Required Type Description
informable_type True String Name of the resource
informable_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Resource identifier
custom_information True Hash Custom information subcollection
custom_info[keyname] True String Key to store custom information value
custom_info[value] True String Custom information value to store

26.2. Update Custom Information

  • PUT /katello/api/v2/custom_info/:informable_type/:informable_id/:keyname
    Update custom information

Table 26.2. Parameters

Name Required Type Description
informable_type True String Name of the resource
informable_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Resource identifier
keyname True String Key that stores custom information value
custom_information True Hash Custom information subcollection
custom_info[value] False String Custom information value to store

Chapter 27. Dashboard

27.1. Get Dashboard Results

  • GET /api/v2/dashboard
    Get Dashboard results

Table 27.1. Parameters

Name Required Type Description
search False String Search string

Chapter 28. Distributions

28.1. List Distributions

  • GET /katello/api/v2/repositories/:repository_id/distributions
    List distributions

Table 28.1. Parameters

Name Required Type Description
repository_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier to list packages
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

28.2. Show a Distribution

  • GET /katello/api/v2/repositories/:repository_id/distributions/:id
    Show a distribution

Table 28.2. Parameters

Name Required Type Description
repository_id False Number Repository identifier
id False String Distribution identifier

Chapter 29. Domains

29.1. List of Domains

  • GET /api/v2/domains
    List of domains

Table 29.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

29.2. Show a Domain

  • GET /api/v2/domains/:id
    Show a domain.

Table 29.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space The numerical identifier or domain name

29.3. Create a Domain

  • POST /api/v2/domains
    Create a domain.

Table 29.3. Parameters

Name Required Type Description
domain False Hash Domain subcollection
domain[name] True String Full DNS domain name
domain[fullname] False String Full name describing the domain
domain[dns_id] False Number DNS proxy to use within this domain
domain[domain_parameters_attributes] False Array list of parameters for the domain. Uses parameter name and value.

29.4. Update a Domain

  • PUT /api/v2/domains/:id
    Update a domain.

Table 29.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Domain identifier
domain False Hash Domain subcollection
domain[name] False String Full DNS domain name
domain[fullname] False String Full name describing the domain
domain[dns_id] False Number DNS proxy to use within this domain
domain[domain_parameters_attributes] False Array list of parameters for the domain. Uses parameter name and value.

29.5. Delete a Domain

  • DELETE /api/v2/domains/:id
    Delete a domain.

Table 29.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Domain identifier

Chapter 30. Environments

30.1. Import Puppet Classes from Puppet Proxy

  • POST /api/v2/smart_proxies/:smart_proxy_id/import_puppetclasses
    Import puppet classes from puppet proxy.
  • POST /api/v2/smart_proxies/:smart_proxy_id/environments/:environment_id/import_puppetclasses
    Import puppet classes from puppet proxy for particular environment.
  • POST /api/v2/environments/:environment_id/smart_proxies/:smart_proxy_id/import_puppetclasses
    Import puppet classes from puppet proxy for particular environment.

Table 30.1. Parameters

Name Required Type Description
smart_proxy_id False String Smart proxy identifier
environment_id False String Environment identifier
dryrun False Boolean Perform a test run of the import process without importing actual classes
except False String Optional comma-deliminated string containing either new, updated, obsolete used to limit the import_puppet classes actions

30.2. List all Environments

  • GET /api/v2/environments
    List all environments.

Table 30.2. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

30.3. Show an Environment

  • GET /api/v2/environments/:id
    Show an environment.

Table 30.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier

30.4. Create an Environment

  • POST /api/v2/environments
    Create an environment.

Table 30.4. Parameters

Name Required Type Description
environment False Hash environment subcollection
environment[name] True String Environment name

30.5. Update an Environment

  • PUT /api/v2/environments/:id
    Update an environment.

Table 30.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
environment False Hash Environment subcollection
environment[name] False String Environment name

30.6. Delete an Environment

  • DELETE /api/v2/environments/:id
    Delete an environment.

Table 30.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier

Chapter 31. Errata

31.1. List Errata

  • GET /katello/api/v2/errata
    List errata
  • GET /katello/api/v2/content_views/:content_view_id/filters/:filter_id/errata
    List errata
  • GET /katello/api/v2/content_view_filters/:content_view_filter_id/errata
    List errata
  • GET /katello/api/v2/repositories/:repository_id/errata
    List errata

Table 31.1. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
filter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view filter identifier
content_view_filter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view filter identifier
repository_id True Number Repository identifier

31.2. Show an Erratum

  • GET /katello/api/v2/errata/:id
    Show an erratum
  • GET /katello/api/v2/repositories/:repository_id/errata/:id
    Show an erratum

Table 31.2. Parameters

Name Required Type Description
repository_id False Number Repository identifier
id True String Erratum identifier

Chapter 32. Fact Values

32.1. List all Fact Values

  • GET /api/v2/fact_values
    List all fact values.
  • GET /api/v2/hosts/:host_id/facts
    List all fact values of a given host.

Table 32.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

Chapter 33. Filters

33.1. List all Filters

  • GET /api/v2/filters
    List all filters.

Table 33.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

33.2. Show a Filter

  • GET /api/v2/filters/:id
    Show a filter.

Table 33.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier

33.3. Create a Filter

  • POST /api/v2/filters
    Create a filter.

Table 33.3. Parameters

Name Required Type Description
filter True Hash Filter subcollection
filter[role_id] True String Role identifier
filter[search] False String Search string
filter[permission_ids] False Array List of permissions
filter[organization_ids] False Array List of organization identifiers
filter[location_ids] False Array List of location identifiers

33.4. Update a Filter

  • PUT /api/v2/filters/:id
    Update a filter.

Table 33.4. Parameters

Name Required Type Description
id True String Filter identifier
filter True Hash Filter subcollection
filter[role_id] False String Role identifier
filter[search] False String Search string
filter[permission_ids] False Array List of permissions
filter[organization_ids] False Array List of organization identifiers
filter[location_ids] False Array List of location identifiers

33.5. Delete a Filter

  • DELETE /api/v2/filters/:id
    Delete a filter.

Table 33.5. Parameters

Name Required Type Description
id True String Filter identifier

Chapter 34. Foreman Tasks

34.1. Show Task Details

  • GET /foreman_tasks/api/v2/tasks/:id
    Show task details

Table 34.1. Parameters

Name Required Type Description
id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space UUID of the task

34.2. List Dynflow Tasks for UUIDs

  • POST /foreman_tasks/api/v2/tasks/bulk_search
    List dynflow tasks for UUIDs

Table 34.2. Parameters

Name Required Type Description
searches False Array of nested elements List of UUIDs to search
searches[search_id] False String Arbitrary value for client to identify the request parts with results. It is passed in the results to be able to pair the requests and responses properly.
searches[type] False Must be one of user, resource, or task  
searches[task_id] False String In case :type = task, find the task by the UUID
searches[user_id] False String In case :type = user, find tasks for the user
searches[resource_type] False String In case :type = resource, find tasks for the resource type
searches[resource_type] False String In case :type = 'resource', what resource id we're searching the tasks for
searches[action_types] False String Return tasks of given action type, e.g. ["Actions::Katello::Repository::Synchronize"]
searches[active_only] False Boolean Search on for active tasks
searches[page] False String Paginate results
searches[per_page] False String Number of entries per request

Chapter 35. GPG Keys

35.1. List GPG Keys

  • GET /katello/api/v2/gpg_keys
    List GPG keys

Table 35.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name False String Name of the GPG key
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

35.2. Create a GPG Key

  • POST /katello/api/v2/gpg_keys
    Create a GPG key

Table 35.2. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space GPG key name
content True String Public key content in DER encoding

35.3. Show a GPG Key

  • GET /katello/api/v2/gpg_keys/:id
    Show a GPG key

Table 35.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space GPG key identifier

35.4. Update a GPG Key

  • PUT /katello/api/v2/gpg_keys/:id
    Update a GPG key

Table 35.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space GPG key identifier
name False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space GPG key name
content False String public key block in DER encoding

35.5. Destroy a GPG Key

  • DELETE /katello/api/v2/gpg_keys/:id
    Destroy a GPG key

Table 35.5. Parameters

Name Required Type Description
id True Number GPG key identifier

35.6. Upload GPG Key Contents

  • POST /katello/api/v2/gpg_keys/:id/content
    Upload GPG key contents

Table 35.6. Parameters

Name Required Type Description
id True Number GPG key identifier
content True File File contents

Chapter 36. Home

36.2. Show Status

  • GET /api/v2/status
    Show status.

Chapter 37. Host Classes

37.1. List all Puppet Class IDs for Host

  • GET /api/v2/hosts/:host_id/puppet class_ids
    List all puppet class IDs for host

37.2. Add a Puppet Class to Host

  • POST /api/v2/hosts/:host_id/puppet class_ids
    Add a puppet class to host

Table 37.1. Parameters

Name Required Type Description
host_id True String Host identifier
puppet class_id True String Puppet class identifier

37.3. Remove a Puppet Class From Host

  • DELETE /api/v2/hosts/:host_id/puppet class_ids/:id
    Remove a puppet class from host

Table 37.2. Parameters

Name Required Type Description
host_id True String Host identifier
id True String Puppet class identifier

Chapter 38. Host Collection Errata

38.1. List Errata Associated with Host Collection

  • GET /katello/api/v2/organizations/:organization_id/host_collections/:host_collection_id/errata
    Get list of errata associated with the host collection

Table 38.1. Parameters

Name Required Type Description
type False String Filter errata by type. Must be one of: bugfix, enhancement, or security.

38.2. Install Errata Remotely

  • POST /katello/api/v2/organizations/:organization_id/host_collections/:host_collection_id/errata
    Install errata remotely

Table 38.2. Parameters

Name Required Type Description
errata_ids True Array List of errata identifiers to install

Chapter 39. Host Collection Packages

39.1. Install Packages Remotely

  • POST /katello/api/v2/organizations/:organization_id/host_collections/:host_collection_id/packages
    Install packages remotely

Table 39.1. Parameters

Name Required Type Description
packages False Array List of package names
groups False Array List of package group names

39.2. Update Packages Remotely

  • PUT /katello/api/v2/organizations/:organization_id/host_collections/:host_collection_id/packages
    Update packages remotely

Table 39.2. Parameters

Name Required Type Description
packages False Array List of package names
groups False Array List of package group names

39.3. Uninstall Packages Remotely

  • DELETE /katello/api/v2/organizations/:organization_id/host_collections/:host_collection_id/packages
    Uninstall packages remotely

Table 39.3. Parameters

Name Required Type Description
packages False Array List of package names
groups False Array List of package group names

Chapter 40. Host Collections

40.1. Show a Host Collection

  • GET /katello/api/v2/host_collections/:id
    Show a host collection

Table 40.1. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier

40.2. List Host Collections

  • GET /katello/api/v2/host_collections
    List host collections
  • GET /katello/api/v2/organizations/:organization_id/host_collections
    List host collections
  • GET /katello/api/v2/activation_keys/:activation_key_id/host_collections
    List host collections
  • GET /katello/api/v2/systems/:system_id/host_collections
    List host collections

Table 40.2. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.
organization_id True Number Organization identifier
name False String Host collection name to use as a filter
activation_key_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Activation key identifier
system_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier

40.3. Create a Host Collection

  • POST /katello/api/v2/host_collections
    Create a host collection
  • POST /katello/api/v2/organizations/:organization_id/host_collections
    Create a host collection

Table 40.3. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name True String Host collection name
system_ids False Array List of system UUIDs to assign to the the host collection
description False String Host collection description
max_content_hosts False Integer Maximum number of content hosts in the host collection

40.4. Update a Host Collection

  • PUT /katello/api/v2/host_collections/:id
    Update a host collection

Table 40.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier
name True String Host collection name
system_ids False Array List of system UUIDs to assign to the host collection
description False String Host collection description
max_content_hosts False Integer Maximum number of content hosts in the host collection

40.5. List Content Hosts in the Host Collection

  • GET /katello/api/v2/host_collections/:id/systems
    List content hosts in the host collection

Table 40.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier

40.6. Add Systems to the Host Collection

  • PUT /katello/api/v2/host_collections/:id/add_systems
    Add systems to the host collection

Table 40.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier
system_ids False Array List of system UUIDs

40.7. Remove Systems From the Host Collection

  • PUT /katello/api/v2/host_collections/:id/remove_systems
    Remove systems from the host collection

Table 40.7. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifiers
system_ids False Array List of system IDs to remove

40.8. Destroy a Host Collection

  • DELETE /katello/api/v2/host_collections/:id
    Destroy a host collection

Table 40.8. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier

40.9. Destroy a Host Collection and Contained Systems

  • DELETE /katello/api/v2/host_collections/:id/destroy_systems
    Destroy a host collection nad contained systems

Table 40.9. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier

40.10. Copy a Host Collection

  • POST /katello/api/v2/host_collections/:id/copy
    Make a copy of a host collection

Table 40.10. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host collection identifier
name True String New host collection name

Chapter 41. Hostgroup Classes

41.1. List all Puppet Class IDs for Hostgroup

  • GET /api/v2/hostgroups/:hostgroup_id/puppet class_ids
    List all puppet class IDs for hostgroup

41.2. Add a Puppet Class to Hostgroup

  • POST /api/v2/hostgroups/:hostgroup_id/puppet class_ids
    Add a puppet class to hostgroup

Table 41.1. Parameters

Name Required Type Description
hostgroup_id True String Hostgroup identifier
puppet class_id True String Puppet class identifiers

41.3. Remove a Puppet Class from Hostgroup

  • DELETE /api/v2/hostgroups/:hostgroup_id/puppet class_ids/:id
    Remove a puppet class from hostgroup

Table 41.2. Parameters

Name Required Type Description
hostgroup_id True String Hostgroup identifier
id True String Puppet class identifiers

Chapter 42. Hostgroups

42.1. List all Hostgroups

  • GET /api/v2/hostgroups
    List all hostgroups.

Table 42.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

42.2. Show a Hostgroup

  • GET /api/v2/hostgroups/:id
    Show a hostgroup.

Table 42.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Hostgroup identifier

42.3. Create a Hostgroup

  • POST /api/v2/hostgroups
    Create an hostgroup.

Table 42.3. Parameters

Name Required Type Description
hostgroup False Hash Hostgroup subcollection
hostgroup[name] True String Hostgroup name
hostgroup[parent_id] False Number Parent identifier if defining a subhostgroup
hostgroup[environment_id] False Number Environment identifier
hostgroup[operatingsystem_id] False Number Operating System identifier
hostgroup[architecture_id] False Number Architecture identifier
hostgroup[medium_id] False Number Medium identifier
hostgroup[ptable_id] False Number Partition table identifier
hostgroup[puppet_ca_proxy_id] False Number Puppet CA proxy identifier
hostgroup[subnet_id] False Number Subnet identifier
hostgroup[domain_id] False Number Domain identifier
hostgroup[realm_id] False Number Realm identifier
hostgroup[puppet_proxy_id] False Number Puppet proxy identifier

42.4. Update an Hostgroup

  • PUT /api/v2/hostgroups/:id
    Update a hostgroup.

Table 42.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Hostgroup identifier
hostgroup False Hash Hostgroup subcollection
hostgroup[name] True String Hostgroup name
hostgroup[parent_id] False Number Parent identifier if defining a subhostgroup
hostgroup[environment_id] False Number Environment identifier
hostgroup[operatingsystem_id] False Number Operating System identifier
hostgroup[architecture_id] False Number Architecture identifier
hostgroup[medium_id] False Number Medium identifier
hostgroup[ptable_id] False Number Partition table identifier
hostgroup[puppet_ca_proxy_id] False Number Puppet CA proxy identifier
hostgroup[subnet_id] False Number Subnet identifier
hostgroup[domain_id] False Number Domain identifier
hostgroup[realm_id] False Number Realm identifier
hostgroup[puppet_proxy_id] False Number Puppet proxy identifier

42.5. Delete an Hostgroup

  • DELETE /api/v2/hostgroups/:id
    Delete an hostgroup.

Table 42.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Hostgroup identifier

Chapter 43. Hosts

43.1. List all Hosts

  • GET /api/v2/hosts
    List all hosts.

Table 43.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

43.2. Show a Host

  • GET /api/v2/hosts/:id
    Show a host.

Table 43.2. Parameters

Name Required Type Description
id True String from 1 to 128 characters containing only alphanumeric characters, periods, spaces, underscores, and hypens but with no leading or trailing space Host identifier

43.3. Create a Host

  • POST /api/v2/hosts
    Create a host.

Table 43.3. Parameters

Name Required Type Description
host False Hash Host subcollection
host[name] True String Host name
host[environment_id] False String Environment identifier
host[ip] False String Host IP address. Not required if using a subnet with DHCP proxy.
host[mac] False String Host MAC address. Not required if host is a virtual machine.
host[architecture_id] False Number Host architecture identifier.
host[domain_id] False Number Host domain identifier
host[realm_id] False Number Host realm identifier
host[puppet_proxy_id] False Number Host Puppet Proxy identifier
host[puppet_class_ids] False Array List of Puppet Class identifiers
host[operatingsystem_id] False String Host operating System identifier
host[medium_id] False Number Host medium identifier
host[ptable_id] False Number Host partition table identifier
host[subnet_id] False Number Host subnet identifier
host[compute_resource_id] False Number Host compute resource identifier
host[sp_subnet_id] False Number The subnet identifier to use for the host's service processor on the baseboard management controller
host[model_id] False Number Host's model identifier
host[hostgroup_id] False Number Host's hostgroup identifier
host[owner_id] False Number Host's owner identifier
host[puppet_ca_proxy_id] False Number Host's Puppet certificate authority identifier
host[image_id] False Number Host's image identifier
host[host_parameters_attributes] False Array List of parameter attributes for the host
host[build] False Boolean Enables build mode for the host
host[enabled] False Boolean Defines if the host is included within reporting
host[provision_method] False String Defines the provisioning method to use. Either build or image.
host[managed] False Boolean Defines if Satellite manages the host's build cycle.
host[progress_report_id] False String Progress report identifier to track orchestration tasks status
host[capabilities] False String Capabilities of compute resources for host
host[compute_profile_id] False Number Compute profile identifier
host[compute_attributes] False Hash Subcollection of compute attributes

43.4. Update a Host

  • PUT /api/v2/hosts/:id
    Update a host.

Table 43.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host identifier
host False Hash Host subcollection
host[name] True String Host name
host[environment_id] False String Environment identifier
host[ip] False String Host IP address. Not required if using a subnet with DHCP proxy.
host[mac] False String Host MAC address. Not required if host is a virtual machine.
host[architecture_id] False Number Host architecture identifier.
host[domain_id] False Number Host domain identifier
host[realm_id] False Number Host realm identifier
host[puppet_proxy_id] False Number Host Puppet Proxy identifier
host[puppet_class_ids] False Array List of Puppet Class identifiers
host[operatingsystem_id] False String Host operating System identifier
host[medium_id] False Number Host medium identifier
host[ptable_id] False Number Host partition table identifier
host[subnet_id] False Number Host subnet identifier
host[compute_resource_id] False Number Host compute resource identifier
host[sp_subnet_id] False Number The subnet identifier to use for the host's service processor on the baseboard management controller
host[model_id] False Number Host's model identifier
host[hostgroup_id] False Number Host's hostgroup identifier
host[owner_id] False Number Host's owner identifier
host[puppet_ca_proxy_id] False Number Host's Puppet certificate authority identifier
host[image_id] False Number Host's image identifier
host[host_parameters_attributes] False Array List of parameter attributes for the host
host[build] False Boolean Enables build mode for the host
host[enabled] False Boolean Defines if the host is included within reporting
host[provision_method] False String Defines the provisioning method to use. Either build or image.
host[managed] False Boolean Defines if Satellite manages the host's build cycle.
host[progress_report_id] False String Progress report identifier to track orchestration tasks status
host[capabilities] False String Capabilities of compute resources for host
host[compute_profile_id] False Number Compute profile identifier
host[compute_attributes] False Hash Subcollection of compute attributes

43.5. Delete an Host

  • DELETE /api/v2/hosts/:id
    Delete an host.

Table 43.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host identifier

43.6. Get Status of Host

  • GET /api/v2/hosts/:id/status
    Get status of host

Table 43.6. Parameters

Name Required Type Description
id True String from 1 to 128 characters containing only alphanumeric characters, periods, spaces, underscores, and hypens but with no leading or trailing space Host identifier

43.7. Force a Puppet Run on the Agent

  • PUT /api/v2/hosts/:id/puppetrun
    Force a puppet run on the agent.

Table 43.7. Parameters

Name Required Type Description
id True String from 1 to 128 characters containing only alphanumeric characters, periods, spaces, underscores, and hypens but with no leading or trailing space Host identifier

43.8. Run Power Operation on Host

  • PUT /api/v2/hosts/:id/power
    Run power operation on host.

Table 43.8. Parameters

Name Required Type Description
id True String from 1 to 128 characters containing only alphanumeric characters, periods, spaces, underscores, and hypens but with no leading or trailing space Host identifier
power_action True String Power action to run. Valid actions are:
  • Start the Host: on or start
  • Stop the Host: off, poweroff or stop
  • Soft reboot the Host: soft or reboot
  • Power cycle the Host: cycle or reset
  • Report status of the Host: state or status

43.9. Boot Host From Specified Device

  • PUT /api/v2/hosts/:id/boot
    Boot host from specified device.

Table 43.9. Parameters

Name Required Type Description
id True String from 1 to 128 characters containing only alphanumeric characters, periods, spaces, underscores, and hypens but with no leading or trailing space Host identifier
device True String Boot device. Valid devices are: disk, cdrom, pxe, and bios

43.10. Upload Facts for a Host

  • POST /api/v2/hosts/facts
    Upload facts for a host, creating the host if required.

Table 43.10. Parameters

Name Required Type Description
name True String Hostname of the host
facts True Hash Subcollection containing the facts for the host. Structure facts in a key: value format.
certname False String Certname of the host
type False String The STI type of host to create

Chapter 44. Images

44.1. List all Images for Compute Resource

  • GET /api/v2/compute_resources/:compute_resource_id/images
    List all images for compute resource

Table 44.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

44.2. Show an Image

  • GET /api/v2/compute_resources/:compute_resource_id/images/:id
    Show an image

Table 44.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Image identifier
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier

44.3. Create a Image

  • POST /api/v2/compute_resources/:compute_resource_id/images
    Create a image

Table 44.3. Parameters

Name Required Type Description
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
image False Hash Image subcollection
image[name] True String Image name
image[username] True String Image root username
image[uuid] True String Image UUID. For example, Amazon EC2 uses the format ami-XXXXXXXX.
image[compute_resource_id] True Number Compute resource identifier
image[architecture_id] True Number Architecture identifier
image[operatingsystem_id] True Number Operating System identifier

44.4. Update a Image

  • PUT /api/v2/compute_resources/:compute_resource_id/images/:id
    Update a image.

Table 44.4. Parameters

Name Required Type Description
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Image identifier
image False Hash Image subcollection
image[name] False String Image name
image[username] False String Image root username
image[uuid] False String Image UUID. For example, Amazon EC2 uses the format ami-XXXXXXXX.
image[compute_resource_id] True Number Compute resource identifier
image[architecture_id] True Number Architecture identifier
image[operatingsystem_id] True Number Operating System identifier

44.5. Delete an Image

  • DELETE /api/v2/compute_resources/:compute_resource_id/images/:id
    Delete an image.

Table 44.5. Parameters

Name Required Type Description
compute_resource_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Compute resource identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Image identifier

Chapter 45. Interfaces

45.1. List all Interfaces for Host

  • GET /api/v2/hosts/:host_id/interfaces
    List all interfaces for host

Table 45.1. Parameters

Name Required Type Description
host_id True String ID or name of host

45.2. Show an Interface for Host

  • GET /api/v2/hosts/:host_id/interfaces/:id
    Show an interface for host

Table 45.2. Parameters

Name Required Type Description
host_id True String ID or name of nested host
id True String ID or name of interface

45.3. Create an Interface Linked to a Host

  • POST /api/v2/hosts/:host_id/interfaces
    Create an interface linked to a host

Table 45.3. Parameters

Name Required Type Description
host_id True String ID or name of host
interface False Hash Interface subcollection
interface[mac] True String MAC address of interface
interface[ip] True String IP address of interface
interface[type] True String Interface type. For example, BMC or Interface.
interface[name] True String Interface name
interface[subnet_id] False Fixnum Subnet identifier of interface
interface[domain_id] False Fixnum Domain identifier of interface
interface[username] False String Interface username
interface[password] False String Interface password
interface[provider] False String Interface provider. For example, IPMI.

45.4. Update Host Interface

  • PUT /api/v2/hosts/:host_id/interfaces/:id
    Update host interface

Table 45.4. Parameters

Name Required Type Description
host_id True String ID or name of host
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Interface identifier
interface False Hash Interface subcollection
interface[mac] True String MAC address of interface
interface[ip] True String IP address of interface
interface[type] True String Interface type. For example, BMC or Interface.
interface[name] True String Interface name
interface[subnet_id] False Fixnum Subnet identifier of interface
interface[domain_id] False Fixnum Domain identifier of interface
interface[username] False String Interface username
interface[password] False String Interface password
interface[provider] False String Interface provider. For example, IPMI.

45.5. Delete a Host Interface

  • DELETE /api/v2/hosts/:host_id/interfaces/:id
    Delete a host interface

Table 45.5. Parameters

Name Required Type Description
host_id True String ID or name of host
id True String Interface identifier

Chapter 46. Lifecycle Environments

46.1. List Environments in an Organization

  • GET /katello/api/v2/environments
    List environments in an organization
  • GET /katello/api/v2/organizations/:organization_id/environments
    List environments in an organization

Table 46.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier
library False Must be one of: true, false. Set to true to see only library environments
name False String Filter only environments containing this name

46.2. Show an Environment

  • GET /katello/api/v2/environments/:id
    Show an environment
  • GET /katello/api/v2/organizations/:organization_id/environments/:environment_id
    Show an environment

Table 46.2. Parameters

Name Required Type Description
id True Number Environment identifier
organization_id False Number Organization identifier

46.3. Create an Environment

  • POST /katello/api/v2/environments
    Create an environment
  • POST /katello/api/v2/organizations/:organization_id/environments
    Create an environment in an organization

Table 46.3. Parameters

Name Required Type Description
organization_id True Number Organization identifier
name True String Environment identifier
description False String Description of the environment
prior True String Name of an environment prior to the new environment in the chain. Must be either Library or an environment at the end of a chain.

46.4. Update an Environment

  • PUT /katello/api/v2/environments/:id
    Update an environment
  • PUT /katello/api/v2/organizations/:organization_id/environments/:id
    Update an environment in an organization

Table 46.4. Parameters

Name Required Type Description
id True Number Environment identifier
organization_id False Number Organization identifier
new_name False String New name for the environment
description False String Description of the environment
prior False String Name of an environment prior to the new environment in the chain. Must be either Library or an environment at the end of a chain.

46.5. Destroy an Environment

  • DELETE /katello/api/v2/environments/:id
    Destroy an environment
  • DELETE /katello/api/v2/organizations/:organization_id/environments/:id
    Destroy an environment in an organization

Table 46.5. Parameters

Name Required Type Description
id True Number Environment identifier
organization_id False Number Organization identifier

46.6. List Environment Paths

  • GET /katello/api/v2/organizations/:organization_id/environments/paths
    List environment paths

Table 46.6. Parameters

Name Required Type Description
organization_id False Number Organization identifier
permission_type False String The associated permission type, either readable or promotable. The default is readable.

46.7. List Repositories Available in the Environment

  • GET /katello/api/v2/organizations/:organization_id/environments/:id/repositories
    List repositories available in the environment

Table 46.7. Parameters

Name Required Type Description
id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
organization_id False String Organization identifier
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier

Chapter 47. Locations

47.1. List all Locations

  • GET /api/v2/locations
    List all locations

Table 47.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

47.2. Show a Location

  • GET /api/v2/locations/:id
    Show a location

Table 47.2. Parameters

Name Required Type Description
id True Number Location identifier

47.3. Create a Location

  • POST /api/v2/locations
    Create a location

Table 47.3. Parameters

Name Required Type Description
location False Hash Location subcollection
location[name] True String Location name

47.4. Update a Location

  • PUT /api/v2/locations/:id
    Update a location

Table 47.4. Parameters

Name Required Type Description
id True Number Location identifier
location False Hash Location subcollection
location[name] False String Location name

47.5. Delete a Location

  • DELETE /api/v2/locations/:id
    Delete a location

Table 47.5. Parameters

Name Required Type Description
id True Number Location identifier

Chapter 48. Media

48.1. List all Media

  • GET /api/v2/media
    List all media.

Table 48.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

48.2. Show a Medium

  • GET /api/v2/media/:id
    Show a medium.

Table 48.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Media identifier

48.3. Create a Medium

  • POST /api/v2/media
    Create a medium.

Table 48.3. Parameters

Name Required Type Description
medium False Hash Media subcollection
medium[name] True String Name of media
medium[path] True String The path to the media source. This can be a URL or a valid NFS server. For example www.redhat.com/redhat/$version/os/$arch where $arch will be substituted for the host's actual Operating System architecture and $version, $major, and $minor are substituted for the version of the operating system. Some media might also use $release.
medium[os_family] False String The family that the operating system belongs to. Available families include AIX, Archlinux, Debian, Freebsd, Gentoo, Junos, Redhat, Solaris, Suse, and Windows.
medium[operatingsystem_ids] False Array Operating System identifier

48.4. Update a Medium

  • PUT /api/v2/media/:id
    Update a medium.

Table 48.4. Parameters

Name Required Type Description
id True String Media identifier
medium False Hash Media subcollection
medium[name] True String Name of media
medium[path] True String The path to the media source. This can be a URL or a valid NFS server. For example www.redhat.com/redhat/$version/os/$arch where $arch will be substituted for the host's actual Operating System architecture and $version, $major, and $minor are substituted for the version of the operating system. Some media might also use $release.
medium[os_family] False String The family that the operating system belongs to. Available families include AIX, Archlinux, Debian, Freebsd, Gentoo, Junos, Redhat, Solaris, Suse, and Windows.
medium[operatingsystem_ids] False Array Operating System identifier

48.5. Delete a Medium

  • DELETE /api/v2/media/:id
    Delete a medium.

Table 48.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Media identifier

Chapter 49. Models

49.1. List all Models

  • GET /api/v2/models
    List all models.

Table 49.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

49.2. Show a Model

  • GET /api/v2/models/:id
    Show a model.

Table 49.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Model identifier

49.3. Create a Model

  • POST /api/v2/models
    Create a model.

Table 49.3. Parameters

Name Required Type Description
model False Hash model subcollection
model[name] True String Model name
model[info] False String Model information
model[vendor_class] False String Vendor class of the model
model[hardware_model] False String Hardware model

49.4. Update a Model

  • PUT /api/v2/models/:id
    Update a model.

Table 49.4. Parameters

Name Required Type Description
id True String Model identifier
model False Hash model subcollection
model[name] True String Model name
model[info] False String Model information
model[vendor_class] False String Vendor class of the model
model[hardware_model] False String Hardware model

49.5. Delete a Model

  • DELETE /api/v2/models/:id
    Delete a model.

Table 49.5. Parameters

Name Required Type Description
id True String Model identifier

Chapter 50. Operating Systems

50.1. List all Operating Systems

  • GET /api/v2/operatingsystems
    List all operating systems.

Table 50.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

50.2. Show an Operating System

  • GET /api/v2/operatingsystems/:id
    Show an Operating System.

Table 50.2. Parameters

Name Required Type Description
id True String Operating System identifier

50.3. Create an Operating System

  • POST /api/v2/operatingsystems
    Create an Operating System.

Table 50.3. Parameters

Name Required Type Description
operatingsystem False Hash Operating system subcollection
operatingsystem[name] True Must match regular expression /\A(\S+)\Z/. Operating system name
operatingsystem[major] True String Major version value of the operating system
operatingsystem[minor] False String Minor version value of the operating system
operatingsystem[description] False String Operating system description
operatingsystem[family] False String Operating system family
operatingsystem[release_name] False String Operating system release name

50.4. Update an Operating System

  • PUT /api/v2/operatingsystems/:id
    Update an Operating System.

Table 50.4. Parameters

Name Required Type Description
id True String Operating System identifier
operatingsystem False Hash Operating system subcollection
operatingsystem[name] True Must match regular expression /\A(\S+)\Z/. Operating system name
operatingsystem[major] True String Major version value of the operating system
operatingsystem[minor] False String Minor version value of the operating system
operatingsystem[description] False String Operating system description
operatingsystem[family] False String Operating system family
operatingsystem[release_name] False String Operating system release name

50.5. Delete an Operating System

  • DELETE /api/v2/operatingsystems/:id
    Delete an Operating System.

Table 50.5. Parameters

Name Required Type Description
id True String Operating System identifier

50.6. List Boot Files an Operating System

  • GET /api/v2/operatingsystems/:id/bootfiles
    List boot files an Operating System.

Table 50.6. Parameters

Name Required Type Description
id True String Operating System identifier
medium False String Medium type
architecture False String Architecture type

Chapter 51. Organization Default Information

51.1. Create Default Information

  • POST /katello/api/v2/organizations/:organization_id/default_info/:informable_type
    Create default information

Table 51.1. Parameters

Name Required Type Description
informable_type True String Name of the resource
informable_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Resource identifier
default_information True Hash Default information subcollection
default_info[keyname] True String Key name for the default value

Chapter 52. Organizations

52.1. List all Organizations

  • GET /katello/api/v2/organizations
    List all organizations

Table 52.1. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

52.2. Show Organization

  • GET /katello/api/v2/organizations/:id
    Show organization

Table 52.2. Parameters

Name Required Type Description
id False String Organization identifier

52.3. Update Organization

  • PUT /katello/api/v2/organizations/:id
    Update organization

Table 52.3. Parameters

Name Required Type Description
id False String Organization identifier
description False String Plain text description
redhat_repository_url False String Red Hat CDN URL

52.4. Create Organization

  • POST /katello/api/v2/organizations
    Create organization

Table 52.4. Parameters

Name Required Type Description
name True String Plain text name
label False String Unique label for the organization
description False String Plain text description

52.5. Delete an Organization

  • DELETE /katello/api/v2/organizations/:id
    Delete an organization

Table 52.5. Parameters

Name Required Type Description
id False String Organization identifier

52.6. Discover Repositories

  • PUT /katello/api/v2/organizations/:id/repo_discover
    Discover Repositories

Table 52.6. Parameters

Name Required Type Description
id False String Organization identifier, label, or name
url False String Base URL to perform repository discovery

52.7. Cancel Repository Discovery

  • PUT /katello/api/v2/organizations/:label/cancel_repo_discover
    Cancel repository discovery

Table 52.7. Parameters

Name Required Type Description
label False String Organization label
url False String Base URL to perform repository discovery

52.8. Download a Debug Certificate

  • GET /katello/api/v2/organizations/:label/download_debug_certificate
    Download a debug certificate

Table 52.8. Parameters

Name Required Type Description
label False String Organization label

52.9. Auto-attach Available Subscriptions to all Systems Within an Organization

  • POST /katello/api/v2/organizations/:id/autoattach_subscriptions
    Auto-attach available subscriptions to all systems within an organization. Asynchronous operation.

52.10. List all Resources for an Organization

  • GET /katello/api/v2/organizations/:id/redhat_provider
    List all Resources for an Organization

Chapter 53. Operating System Default Templates

53.1. List Default Templates for Operating System

  • GET /api/v2/operatingsystems/:operatingsystem_id/os_default_templates
    List default templates for operating system

Table 53.1. Parameters

Name Required Type Description
operatingsystem_id False String Operating System identifier
page False String Page number, starting at 1
per_page False String Number of results per page to return

53.2. Show a Default Template Kind for Operating System

  • GET /api/v2/operatingsystems/:operatingsystem_id/os_default_templates/:id
    Show a default template kind for operating system

Table 53.2. Parameters

Name Required Type Description
operatingsystem_id False String Operating System identifier
id True Number Default template identifier

53.3. Create a Default Template for Operating System

  • POST /api/v2/operatingsystems/:operatingsystem_id/os_default_templates
    Create a default template for operating system

Table 53.3. Parameters

Name Required Type Description
operatingsystem_id False String Operating System identifier
os_default_template False Hash Default template subcollection
os_default_template[template_kind_id] False Number Template kind identifier
os_default_template[config_template_id] False Number Configuration template identifier

53.4. Update a Default Template for Operating System

  • PUT /api/v2/operatingsystems/:operatingsystem_id/os_default_templates/:id
    Update a default template for operating system

Table 53.4. Parameters

Name Required Type Description
operatingsystem_id False String Operating System identifier
id True String Default template identifier
os_default_template False Hash Default template subcollection
os_default_template[template_kind_id] False Number Template kind identifier
os_default_template[config_template_id] False Number Configuration template identifier

53.5. Delete a Default Template for Operating System

  • DELETE /api/v2/operatingsystems/:operatingsystem_id/os_default_templates/:id
    Delete a default template for operating system

Table 53.5. Parameters

Name Required Type Description
operatingsystem_id False String Operating System identifier
id True String Default template identifier

Chapter 54. Override Values

54.1. List of Override Values for a Specific Smart Variable

  • GET /api/v2/smart_variables/:smart_variable_id/override_values
    List of override values for a specific smart variable
  • GET /api/v2/smart_class_parameters/:smart_class_parameter_id/override_values
    List of override values for a specific smart class parameter

Table 54.1. Parameters

Name Required Type Description
smart_variable_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier
smart_class_parameter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart class identifier
page False String Page number, starting at 1
per_page False String Number of results per page to return

54.2. Show an Override Value for a Specific Smart Variable

  • GET /api/v2/smart_variables/:smart_variable_id/override_values/:id
    Show an override value for a specific smart variable
  • GET /api/v2/smart_class_parameters/:smart_class_parameter_id/override_values/:id
    Show an override value for a specific smart class parameter

Table 54.2. Parameters

Name Required Type Description
smart_variable_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier
smart_class_parameter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart class identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Override value identifier

54.3. Create an Override Value for a Specific Smart Variable

  • POST /api/v2/smart_variables/:smart_variable_id/override_values
    Create an override value for a specific smart variable
  • POST /api/v2/smart_class_parameters/:smart_class_parameter_id/override_values
    Create an override value for a specific smart class parameter

Table 54.3. Parameters

Name Required Type Description
smart_variable_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier
override_value False Hash Override value subcollection
override_value[match] False String The matcher attribute to override
override_value[value] False String The value for the matcher attribute

54.4. Update an Override Value for a Specific Smart Variable

  • PUT /api/v2/smart_variables/:smart_variable_id/override_values/:id
    Update an override value for a specific smart variable
  • PUT /api/v2/smart_class_parameters/:smart_class_parameter_id/override_values/:id
    Update an override value for a specific smart class parameter

Table 54.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Override value identifier
override_value False Hash Override value subcollection
override_value[match] False String The matcher attribute to override
override_value[value] False String The value for the matcher attribute

54.5. Delete an Override Value for a Specific Smart Variable

  • DELETE /api/v2/smart_variables/:smart_variable_id/override_values/:id
    Delete an override value for a specific smart variable
  • DELETE /api/v2/smart_class_parameters/:smart_class_parameter_id/override_values/:id
    Delete an override value for a specific smart class parameter

Table 54.5. Parameters

Name Required Type Description
smart_variable_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier
smart_class_parameter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart class identifier
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Override value identifier

Chapter 55. Package Groups

55.1. List Package Groups

  • GET /katello/api/v2/package_groups
    List package groups
  • GET /katello/api/v2/content_views/:content_view_id/filters/:filter_id/package_groups
    List package groups
  • GET /katello/api/v2/content_view_filters/:content_view_filter_id/package_groups
    List package groups
  • GET /katello/api/v2/repositories/:repository_id/package_groups
    List package groups

Table 55.1. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
filter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter identifier
content_view_filter_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view filter identifier
repository_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

55.2. Show a Package Group

  • GET /katello/api/v2/package_groups/:id
    Show a package group
  • GET /katello/api/v2/repositories/:repository_id/package_groups/:id
    Show a package group

Table 55.2. Parameters

Name Required Type Description
repository_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
id True String Package group identifier

Chapter 56. Packages

56.1. List Packages

  • GET /katello/api/v2/repositories/:repository_id/packages
    List packages

Table 56.1. Parameters

Name Required Type Description
repository_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

56.2. Show a Package

  • GET /katello/api/v2/repositories/:repository_id/packages/:id
    Show a package

Table 56.2. Parameters

Name Required Type Description
repository_id False Number Repository identifier
id False String Package identifier

Chapter 57. Parameters

57.1. List all Parameters for a Resource

  • GET /api/v2/hosts/:host_id/parameters
    List all parameters for host
  • GET /api/v2/hostgroups/:hostgroup_id/parameters
    List all parameters for hostgroup
  • GET /api/v2/domains/:domain_id/parameters
    List all parameters for domain
  • GET /api/v2/operatingsystems/:operatingsystem_id/parameters
    List all parameters for operating system
  • GET /api/v2/locations/:location_id/parameters
    List all parameters for location
  • GET /api/v2/organizations/:organization_id/parameters
    List all parameters for organization

Table 57.1. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier
search False String Filter results
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

57.2. Show a Nested Parameter for a Resource

  • GET /api/v2/hosts/:host_id/parameters/:id
    Show a nested parameter for host
  • GET /api/v2/hostgroups/:hostgroup_id/parameters/:id
    Show a nested parameter for hostgroup
  • GET /api/v2/domains/:domain_id/parameters/:id
    Show a nested parameter for domain
  • GET /api/v2/operatingsystems/:operatingsystem_id/parameters/:id
    Show a nested parameter for operating system
  • GET /api/v2/locations/:location_id/parameters/:id
    Show a nested parameter for location
  • GET /api/v2/organizations/:organization_id/parameters/:id
    Show a nested parameter for organization

Table 57.2. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier
id True String Parameter identifier

57.3. Create a Nested Parameter for a Resource

  • POST /api/v2/hosts/:host_id/parameters
    Create a nested parameter for host
  • POST /api/v2/hostgroups/:hostgroup_id/parameters
    Create a nested parameter for hostgroup
  • POST /api/v2/domains/:domain_id/parameters
    Create a nested parameter for domain
  • POST /api/v2/operatingsystems/:operatingsystem_id/parameters
    Create a nested parameter for operating system
  • POST /api/v2/locations/:location_id/parameters
    Create a nested parameter for location
  • POST /api/v2/organizations/:organization_id/parameters
    Create a nested parameter for organization

Table 57.3. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier
parameter False Hash Parameter subcollection
parameter[name] True String Parameter key name
parameter[value] True String Parameter value

57.4. Update a Nested Parameter for a Resource

  • PUT /api/v2/hosts/:host_id/parameters/:id
    Update a nested parameter for host
  • PUT /api/v2/hostgroups/:hostgroup_id/parameters/:id
    Update a nested parameter for hostgroup
  • PUT /api/v2/domains/:domain_id/parameters/:id
    Update a nested parameter for domain
  • PUT /api/v2/operatingsystems/:operatingsystem_id/parameters/:id
    Update a nested parameter for operating system
  • PUT /api/v2/locations/:location_id/parameters/:id
    Update a nested parameter for location
  • PUT /api/v2/organizations/:organization_id/parameters/:id
    Update a nested parameter for organization

Table 57.4. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier
id True String Parameter identifier
parameter False Hash Parameter subcollection
parameter[name] False String Parameter key name
parameter[value] False String Parameter value

57.5. Delete a Nested Parameter for a Resource

  • DELETE /api/v2/hosts/:host_id/parameters/:id
    Delete a nested parameter for host
  • DELETE /api/v2/hostgroups/:hostgroup_id/parameters/:id
    Delete a nested parameter for hostgroup
  • DELETE /api/v2/domains/:domain_id/parameters/:id
    Delete a nested parameter for domain
  • DELETE /api/v2/operatingsystems/:operatingsystem_id/parameters/:id
    Delete a nested parameter for operating system
  • DELETE /api/v2/locations/:location_id/parameters/:id
    Delete a nested parameter for location
  • DELETE /api/v2/organizations/:organization_id/parameters/:id
    Delete a nested parameter for organization

Table 57.5. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier
id True String Parameter identifier

57.6. Delete all Nested Parameters for a Resource

  • DELETE /api/v2/hosts/:host_id/parameters
    Delete all nested parameters for host
  • DELETE /api/v2/hostgroups/:hostgroup_id/parameters
    Delete all nested parameters for hostgroup
  • DELETE /api/v2/domains/:domain_id/parameters
    Delete all nested parameters for domain
  • DELETE /api/v2/operatingsystems/:operatingsystem_id/parameters
    Delete all nested parameters for operating system
  • DELETE /api/v2/locations/:location_id/parameters
    Delete all nested parameter for location
  • DELETE /api/v2/organizations/:organization_id/parameters
    Delete all nested parameter for organization

Table 57.6. Parameters

Name Required Type Description
host_id False String Host identifier
hostgroup_id False String Hostgroup identifier
domain_id False String Domain identifier
operatingsystem_id False String Operating System identifier
location_id False String Location identifier
organization_id False String Organization identifier

Chapter 58. Permissions

58.1. List all Permissions

  • GET /katello/api/v2/permissions
    List all permissions.

Table 58.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return
resource_type False String Resource types assigned to the permission
name False String Name of the permission

58.2. Show a Permission

  • GET /katello/api/v2/permissions/:id
    Show a permission.

Table 58.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Permission identifier

58.3. Create a Roles Permission

  • POST /katello/api/v2/roles/:role_id/permissions
    Create a roles permission

Table 58.3. Parameters

Name Required Type Description
permission True Hash Permission subcollection
permission[description] False String Permission description
permission[name] True String Permission name
permission[organization_id] False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Organization identifier of the permission
permission[tags] False Array List of of tags for the permission
permission[type] True String Resource to assign to the permission, or all
permission[verbs] False Array List of permission verbs
permission[all_tags] False Boolean True if the permission uses all tags
permission[all_verbs] False Boolean True if the permission uses all verbs

Chapter 59. Ping

59.1. Shows Status of System and It's Subcomponents

  • GET /katello/api/v2/ping
    Shows status of system and it's subcomponents

59.2. Shows Version Information

  • GET /katello/api/v2/status
    Shows version information

Chapter 60. Plugins

60.1. List of Installed Plugins

  • GET /api/v2/plugins
    List of installed plugins

Chapter 61. Products

61.1. List Products

  • GET /katello/api/v2/products
    List products
  • GET /katello/api/v2/subscriptions/:subscription_id/products
    List of products in a subscription
  • GET /katello/api/v2/activation_keys/:activation_key_id/products
    List of products in an activation key
  • GET /katello/api/v2/organizations/:organization_id/products
    List of products in an organization

Table 61.1. Parameters

Name Required Type Description
organization_id True Number Filter products by organization identifier
subscription_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Filter products by subscription identifier
name False String Filter products by name
enabled False Boolean Filter products by enabled or disabled
custom False boolean Filter products by custom
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

61.2. Create a Product

  • POST /katello/api/v2/products
    Create a product

Table 61.2. Parameters

Name Required Type Description
organization_id True Number Organization identifier
description False String Product description
gpg_key_id False Number Identifier of the GPG key
sync_plan_id False Number Synchronization plan identifier
name True String Product name
label False String Product label

61.3. Show a Product

  • GET /katello/api/v2/products/:id
    Show a product

Table 61.3. Parameters

Name Required Type Description
id True Number Product identifier

61.4. Update a Product

  • PUT /katello/api/v2/products/:id
    Update a product

Table 61.4. Parameters

Name Required Type Description
id True Number Product identifier
description False String Product description
gpg_key_id False Number Identifier of the GPG key
sync_plan_id False Number Synchronization plan identifier
name False String Product name

61.5. Destroy a Product

  • DELETE /katello/api/v2/products/:id
    Destroy a product

Table 61.5. Parameters

Name Required Type Description
id False Number Product identifier

61.6. Synchronize a Repository

  • POST /katello/api/v2/products/:id/sync
    Synchronize a repository

Table 61.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Product identifier

Chapter 62. Products Bulk Actions

62.1. Destroy One or More Products

  • PUT /katello/api/v2/products/bulk/destroy
    Destroy one or more products

Table 62.1. Parameters

Name Required Type Description
ids True Array List of product identifiers

62.2. Synchronize One or More Products

  • PUT /katello/api/v2/products/bulk/sync
    Synchronize one or more products

Table 62.2. Parameters

Name Required Type Description
ids True Array List of product identifiers

62.3. Synchronize One or More Products Based on Plan

  • PUT /katello/api/v2/products/bulk/sync_plan
    Synchronize one or more products

Table 62.3. Parameters

Name Required Type Description
ids True Array List of product identifiers
plan_id True Number Synchronization plan identifier to attach

Chapter 63. Partition Tables

63.1. List all Partition Tables

  • GET /api/v2/ptables
    List all partition tables.

Table 63.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

63.2. Show a Partition Table

  • GET /api/v2/ptables/:id
    Show a partition table.

Table 63.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Partition table identifier

63.3. Create a Partition Table

  • POST /api/v2/ptables
    Create a partition table.

Table 63.3. Parameters

Name Required Type Description
ptable False Hash Partition table subcollection
ptable[name] True String Partition table name
ptable[layout] True String Partition table XML layout.
ptable[os_family] False String Partition table operating system family

63.4. Update a Partition Table

  • PUT /api/v2/ptables/:id
    Update a partition table.

Table 63.4. Parameters

Name Required Type Description
id True String Partition table identifier
ptable False Hash Partition table subcollection
ptable[name] True String Partition table name
ptable[layout] True String Partition table XML layout.
ptable[os_family] False String Partition table operating system family

63.5. Delete a Partition Table

  • DELETE /api/v2/ptables/:id
    Delete a partition table.

Table 63.5. Parameters

Name Required Type Description
id True String Partition table identifier

Chapter 64. Puppet Modules

64.1. List Puppet Modules

  • GET /katello/api/v2/puppet_modules
    List puppet modules
  • GET /katello/api/v2/content_views/:content_view_id/puppet_modules
    List puppet modules
  • GET /katello/api/v2/environments/:environment_id/puppet_modules
    List puppet modules
  • GET /katello/api/v2/repositories/:repository_id/puppet_modules
    List puppet modules

Table 64.1. Parameters

Name Required Type Description
content_view_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Content view identifier
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
repository_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

64.2. Show a Puppet Module

  • GET /katello/api/v2/puppet_modules/:id
    Show a puppet module
  • GET /katello/api/v2/repositories/:repository_id/puppet_modules/:id
    Show a puppet module

Table 64.2. Parameters

Name Required Type Description
repository_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
id True String Puppet module identifier

Chapter 65. Puppet Classes

65.1. List all Puppet Classes

  • GET /api/v2/puppet classes
    List all puppet classes.
  • GET /api/v2/hosts/:host_id/puppet classes
    List all puppet classes for host
  • GET /api/v2/hostgroups/:hostgroup_id/puppet classes
    List all puppet classes for hostgroup
  • GET /api/v2/environments/:environment_id/puppet classes
    List all puppet classes for environment

Table 65.1. Parameters

Name Required Type Description
host_id False String Nested host identifier
hostgroup_id False String Nested host group identifier
environment_id False String Nested environment identifier
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

65.2. Show a Puppet Class

  • GET /api/v2/puppet classes/:id
    Show a puppet class
  • GET /api/v2/hosts/:host_id/puppet classes/:id
    Show a puppet class for host
  • GET /api/v2/hostgroups/:hostgroup_id/puppet classes/:id
    Show a puppet class for hostgroup
  • GET /api/v2/environments/:environment_id/puppet classes/:id
    Show a puppet class for environment

Table 65.2. Parameters

Name Required Type Description
host_id False String Nested host identifier
hostgroup_id False String Nested host group identifier
environment_id False String Nested environment identifier
id True String Puppet class identifiers

65.3. Create a Puppet Class

  • POST /api/v2/puppet classes
    Create a puppet class.

Table 65.3. Parameters

Name Required Type Description
puppet class False Hash Puppet class subcollection
puppet class[name] True String Puppet class name

65.4. Update a Puppet Class

  • PUT /api/v2/puppet classes/:id
    Update a puppet class.

Table 65.4. Parameters

Name Required Type Description
id True String Puppet class identifier
puppet class False Hash Puppet class subcollection
puppet class[name] False String Puppet class name

65.5. Delete a Puppet Class

  • DELETE /api/v2/puppet classes/:id
    Delete a puppet class.

Table 65.5. Parameters

Name Required Type Description
id True String Puppet class identifier

Chapter 66. Realms

66.1. List of Realms

  • GET /api/v2/realms
    List of realms

Table 66.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

66.2. Show a Realm

  • GET /api/v2/realms/:id
    Show a realm.

Table 66.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Realm name or identifier

66.3. Create a Realm

  • POST /api/v2/realms
    Create a realm.

Table 66.3. Parameters

Name Required Type Description
realm False Hash Realm subcollection
realm[name] True String The realm name
realm[realm_proxy_id] False Number Proxy to use for this realm
realm[realm_type] True String Realm type. For example, Red Hat Directory Server, or Active Directory

66.4. Update a Realm

  • PUT /api/v2/realms/:id
    Update a realm.

Table 66.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Realm identifier
realm False Hash Realm subcollection
realm[name] False String Realm name
realm[realm_proxy_id] False Number Proxy to use for this realm
realm[realm_type] False String Realm type. For example, Red Hat Directory Server, or Active Directory

66.5. Delete a Realm

  • DELETE /api/v2/realms/:id
    Delete a realm.

Table 66.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Realm identifier

Chapter 67. Reports

67.1. List all Reports

  • GET /api/v2/reports
    List all reports.

Table 67.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

67.2. Show a Report

  • GET /api/v2/reports/:id
    Show a report.

Table 67.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Report identifier

67.3. Create a Report

  • POST /api/v2/reports
    Create a report.

Table 67.3. Parameters

Name Required Type Description
report False Hash Report subcollection
report[host] True String Hostname or certname
report[reported_at] True String UTC time of report
report[status] True Hash Subcollection of status type totals
report[metrics] True Hash Subcollection of report metrics. Can be empty - {}.
report[logs] False Array Optional list of log hashes

67.4. Delete a Report

  • DELETE /api/v2/reports/:id
    Delete a report.

Table 67.4. Parameters

Name Required Type Description
id True String Report identifier

67.5. Show the Last Report for a Host

  • GET /api/v2/hosts/:host_id/reports/last
    Show the last report for a host.

Table 67.5. Parameters

Name Required Type Description
host_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host identifier

Chapter 68. Repositories

68.1. List Enabled Repositories

  • GET /katello/api/v2/repositories
    List of enabled repositories
  • GET /katello/api/v2/content_views/:id/repositories
    List of repositories for a content view

Table 68.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier
product_id False Number Product identifier
environment_id False Number Environment identifier
content_view_id False Number Content view identifier
library False Boolean Show repositories in Library and the default content view
content_type False String Limit to only repositories of this type
name False String Name of the repository
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

68.2. Create a Custom Repository

  • POST /katello/api/v2/repositories
    Create a custom repository

Table 68.2. Parameters

Name Required Type Description
name True String Repository name
label False String Repository label
product_id True Number Product that owns this repository
url True String Repository source URL
gpg_key_id False Number GPG key assigned to the new repository
unprotected False Boolean Set to true if this repository can be published through HTTP
content_type False String Type of repository. Either yum or puppet. Default is yum.

68.3. Show a Custom Repository

  • GET /katello/api/v2/repositories/:id
    Show a custom repository

Table 68.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

68.4. Synchronize a Repository

  • POST /katello/api/v2/repositories/:id/sync
    Synchronize a repository

Table 68.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

68.5. Update a Custom Repository

  • PUT /katello/api/v2/repositories/:id
    Update a custom repository

Table 68.5. Parameters

Name Required Type Description
name False String New name for the repository
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
gpg_key_id False Number GPG key assigned to this repository
unprotected False Boolean Set to true if this repository can be published through HTTP
url False String The feed URL of the original repository

68.6. Destroy a Custom Repository

  • DELETE /katello/api/v2/repositories/:id
    Destroy a custom repository

Table 68.6. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier

68.7. Notify When a Synchronization is Complete

  • POST /katello/api/v2/repositories/sync_complete
    Notify when a synchronization is complete. Red Hat Satellite uses this as an internal trigger for Pulp. It is recommended not to use this API call.

Table 68.7. Parameters

Name Required Type Description
token True String Shared secret token
payload True Hash Payload subcollection
payload[repo_id] True String Repository identifier
call_report True Hash Call report subcollection
call_report[task_id] True String Task identifier

68.8. Remove Packages from Repository

  • POST /katello/api/repositories/:id/remove_packages
    Remove packages from a repository

Table 68.8. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
uuids True Array Array of package UUIDs to remove

68.9. Upload Content into Repository

  • POST /katello/api/repositories/:id/upload_content
    Upload content into a repository

Table 68.9. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
content True File Content files to upload. Can be a single file or array of files.

68.10. Import Uploads into Repository

  • PUT /katello/api/repositories/:id/import_uploads
    Import uploads into a repository

Table 68.10. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Repository identifier
upload_ids True Array Array of upload identifiers to import

68.11. Show Repository GPG Key Content

  • GET /katello/api/repositories/:id/gpg_key_content
    Return the content of a repository's GPG key. Used directly by Yum.

Table 68.11. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Identifier of the repository

Chapter 69. Repositories Bulk Actions

69.1. Destroy One or More Repositories

  • PUT /katello/api/v2/repositories/bulk/destroy
    Destroy one or more repositories

Table 69.1. Parameters

Name Required Type Description
ids True Array List of repository identifiers

69.2. Synchronize Repository

  • POST /katello/api/v2/repositories/bulk/sync
    Synchronize repository

Table 69.2. Parameters

Name Required Type Description
ids True Array List of repository identifiers

69.3. Repository Sets

69.4. List Repository Sets for a Product

  • GET /katello/api/v2/products/:product_id/repository_sets
    List repository sets for a product.

Table 69.3. Parameters

Name Required Type Description
product_id True Number Product identifier
name False String Repository set name to search

69.5. Get Information About a Repository Set

  • GET /katello/api/v2/products/:product_id/repository_sets/:id
    Get information about a repository set

Table 69.4. Parameters

Name Required Type Description
id True Number Repository set identifier
product_id True Number Product identifier

69.6. Get List or Available Repositories for the Repository Set

  • GET /katello/api/v2/products/:product_id/repository_sets/:id/available_repositories
    Get list or available repositories for the repository set

Table 69.5. Parameters

Name Required Type Description
id True Number Repository set identifier
product_id True Number Product identifier

69.7. Enable a Repository From the Set

  • PUT /katello/api/v2/products/:product_id/repository_sets/:id/enable
    Enable a repository from the set

Table 69.6. Parameters

Name Required Type Description
id True Number Repository set identifier to enable
product_id True Number Product containing the repository set
basearch True String Basearch to enable
releasever True String Releasever to enable

69.8. Disable a Repository Form the Set

  • PUT /katello/api/v2/products/:product_id/repository_sets/:id/disable
    Disable a repository form the set

Table 69.7. Parameters

Name Required Type Description
id True Number Repository set identifier to disable
product_id True Number Product containing the repository set
basearch True String Basearch to disable
releasever True String Releasever to disable

Chapter 70. Role LDAP Groups

70.1. Add Group to List of LDAP Groups Associated With the Role

  • POST /katello/api/v2/roles/:role_id/ldap_groups
    Add group to list of LDAP groups associated with the role

Table 70.1. Parameters

Name Required Type Description
ldap_group True Hash LDAP group subcollection
ldap_group[name] True String Name of the LDAP group

Chapter 71. Roles

71.1. List all Roles

  • GET /katello/api/v2/roles
    List all roles.

Table 71.1. Parameters

Name Required Type Description
search False String Filter results
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

71.2. Show an Role

  • GET /katello/api/v2/roles/:id
    Show an role.

Table 71.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Role identifier

71.3. Create an Role

  • POST /katello/api/v2/roles
    Create an role.

Table 71.3. Parameters

Name Required Type Description
role False Hash Role subcollection
role[name] True String Role name

71.4. Update an Role

  • PUT /katello/api/v2/roles/:id
    Update an role.

Table 71.4. Parameters

Name Required Type Description
id True String Role identifier
role False Hash Role subcollection
role[name] False String Role name

71.5. Delete an Role

  • DELETE /katello/api/v2/roles/:id
    Delete an role.

Table 71.5. Parameters

Name Required Type Description
id True String Role identifier

Chapter 72. Settings

72.1. List all Settings

  • GET /api/v2/settings
    List all settings.

Table 72.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

72.2. Show a Setting

  • GET /api/v2/settings/:id
    Show a setting.

Table 72.2. Parameters

Name Required Type Description
id True String Setting identifier

72.3. Update a Setting

  • PUT /api/v2/settings/:id
    Update a setting.

Table 72.3. Parameters

Name Required Type Description
id True String Setting identifier
setting True Hash Setting subcollection
setting[value] False String Setting value

Chapter 73. Smart Class Parameters

73.1. List Smart Class Parameters

  • GET /api/v2/smart_class_parameters
    List all smart class parameters
  • GET /api/v2/hosts/:host_id/smart_class_parameters
    List of smart class parameters for a specific host
  • GET /api/v2/hostgroups/:hostgroup_id/smart_class_parameters
    List of smart class parameters for a specific hostgroup
  • GET /api/v2/puppet classes/:puppet class_id/smart_class_parameters
    List of smart class parameters for a specific puppet class
  • GET /api/v2/environments/:environment_id/smart_class_parameters
    List of smart class parameters for a specific environment
  • GET /api/v2/environments/:environment_id/puppet classes/:puppet class_id/smart_class_parameters
    List of smart class parameters for a specific environment/puppet class combination

Table 73.1. Parameters

Name Required Type Description
host_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host identifier
hostgroup_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Hostgroup identifier
puppet_class_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Puppet class identifier
environment_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Environment identifier
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

73.2. Show a Smart Class Parameter

  • GET /api/v2/smart_class_parameters/:id
    Show a smart class parameter.

Table 73.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart class parameter identifier

73.3. Update a Smart Class Parameter

  • PUT /api/v2/smart_class_parameters/:id
    Update a smart class parameter.

Table 73.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart class parameter identifier
smart_class_parameter True Hash Smart class parameter subcollection
smart_class_parameter[override] False Boolean Defines if the default smart class parameter can be overridden
smart_class_parameter[description] False String Smart class parameter description
smart_class_parameter[default_value] False String Default value for smart class parameter
smart_class_parameter[path] False String Path for the smart class parameter
smart_class_parameter[validator_type] False String Validator type. Either list or regexp.
smart_class_parameter[validator_rule] False String Rule for the validator
smart_class_parameter[override_value_order] False String Value that defines the order of override value in relation to other override values
smart_class_parameter[parameter_type] False String Smart class parameter type. Either string, boolean, integer, real, array, hash, yaml, or json.
smart_class_parameter[required] False Boolean Defines if the parameter is required

Chapter 74. Smart Proxies (Capsules)

74.1. Import Puppet Classes From Proxy

  • POST /api/v2/smart_proxies/:id/import_puppet classes
    Import Puppet classes from Capsule.
  • POST /api/v2/smart_proxies/:smart_proxy_id/environments/:id/import_puppet classes
    Import Puppet classes from Capsule for particular environment.
  • POST /api/v2/environments/:environment_id/smart_proxies/:id/import_puppet classes
    Import Puppet classes from Capsule for particular environment.

Table 74.1. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Capsule identifier
smart_proxy_id False String Capsule identifier
environment_id False String Environment identifier
dryrun False Boolean Perform a test of the import process without importing actual data
except False String Optional comma-deliminated string containing either new, updated, and obsolete used to limit the import puppet classes actions

74.2. List all Capsules

  • GET /api/v2/smart_proxies
    List all capsules.

Table 74.2. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

74.3. Show a Capsule

  • GET /api/v2/smart_proxies/:id
    Show a Capsule.

Table 74.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Capsule identifier

74.4. Create a Capsule

  • POST /api/v2/smart_proxies
    Create a Capsule.

Table 74.4. Parameters

Name Required Type Description
smart_proxy False Hash Capsule subcollection
smart_proxy[name] True String Capsule name
smart_proxy[url] True String Capsule URL

74.5. Update a Capsule

  • PUT /api/v2/smart_proxies/:id
    Update a Capsule.

Table 74.5. Parameters

Name Required Type Description
id True String Capsule identifier
smart_proxy False Hash Capsule subcollection
smart_proxy[name] False String Capsule name
smart_proxy[url] False String Capsule URL

74.6. Delete a Capsule

  • DELETE /api/v2/smart_proxies/:id
    Delete a Capsule.

Table 74.6. Parameters

Name Required Type Description
id True String Capsule identifier

74.7. Refresh Capsule Features

  • PUT /api/v2/smart_proxies/:id/refresh
    Refresh Capsule features

Table 74.7. Parameters

Name Required Type Description
id True String Capsule identifier

Chapter 75. Smart Variables

75.1. List Smart Variables

  • GET /api/v2/smart_variables
    List all smart variables
  • GET /api/v2/hosts/:host_id/smart_variables
    List of smart variables for a specific host
  • GET /api/v2/hostgroups/:hostgroup_id/smart_variables
    List of smart variables for a specific hostgroup
  • GET /api/v2/puppet classes/:puppet class_id/smart_variables
    List of smart variables for a specific puppet class

Table 75.1. Parameters

Name Required Type Description
host_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Host identifier
hostgroup_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Hostgroup identifier
puppet_class_id False String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Puppet class identifier
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

75.2. Show a Smart Variable

  • GET /api/v2/smart_variables/:id
    Show a smart variable.

Table 75.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier

75.3. Create a Smart Variable

  • POST /api/v2/smart_variables
    Create a smart variable.

Table 75.3. Parameters

Name Required Type Description
smart_variable False Hash Smart variable subcollection
smart_variable[variable] True String Smart variable
smart_variable[puppet class_id] False Number Puppet class identifier
smart_variable[default_value] False String Default value for the variable
smart_variable[override_value_order] False String Order value of the override value
smart_variable[description] False String Description of the smart variable
smart_variable[validator_type] False String Validator type. Either list or regexp.
smart_variable[validator_rule] False String Rule for the validator
smart_variable[variable_type] False String Smart class parameter type. Either string, boolean, integer, real, array, hash, yaml, or json.

75.4. Update a Smart Variable

  • PUT /api/v2/smart_variables/:id
    Update a smart variable.

Table 75.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier
smart_variable False Hash Smart variable subcollection
smart_variable[variable] True String Smart variable
smart_variable[puppet class_id] False Number Puppet class identifier
smart_variable[default_value] False String Default value for the variable
smart_variable[override_value_order] False String Order value of the override value
smart_variable[description] False String Description of the smart variable
smart_variable[validator_type] False String Validator type. Either list or regexp.
smart_variable[validator_rule] False String Rule for the validator
smart_variable[variable_type] False String Smart class parameter type. Either string, boolean, integer, real, array, hash, yaml, or json.

75.5. Delete a Smart Variable

  • DELETE /api/v2/smart_variables/:id
    Delete a smart variable.

Table 75.5. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Smart variable identifier

Chapter 76. Statistics

76.1. Get Statistics

  • GET /api/v2/statistics
    Get statistics

Chapter 77. Subnets

77.1. List of Subnets

  • GET /api/v2/subnets
    List of subnets

Table 77.1. Parameters

Name Required Type Description
search False String Search string
order False String Sort results
page False String Page number, starting at 1
per_page False String Number of results per page to return

77.2. Show a Subnet

  • GET /api/v2/subnets/:id
    Show a subnet.

Table 77.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Subnet identifier

77.3. Create a Subnet

  • POST /api/v2/subnets
    Create a subnet

Table 77.3. Parameters

Name Required Type Description
subnet False Hash Subnet subcollection
subnet[name] True String Subnet name
subnet[network] True String Subnet network
subnet[mask] True String Netmask for this subnet
subnet[gateway] False String Gateway for this subnet
subnet[dns_primary] False String Primary DNS for this subnet
subnet[dns_secondary] False String Secondary DNS for this subnet
subnet[from] False String Starting IP Address for IP auto suggestion
subnet[to] False String Ending IP Address for IP auto suggestion
subnet[vlanid] False String VLAN ID for this subnet
subnet[domain_ids] False Array Domains that include this subnet
subnet[dhcp_id] False Number DHCP Proxy to use within this subnet
subnet[tftp_id] False Number TFTP Proxy to use within this subnet
subnet[dns_id] False Number DNS Proxy to use within this subnet

77.4. Update a Subnet

  • PUT /api/v2/subnets/:id
    Update a subnet

Table 77.4. Parameters

Name Required Type Description
id True Number Subnet identifier
subnet False Hash Subnet subcollection
subnet[name] True String Subnet name
subnet[network] True String Subnet network
subnet[mask] True String Netmask for this subnet
subnet[gateway] False String Gateway for this subnet
subnet[dns_primary] False String Primary DNS for this subnet
subnet[dns_secondary] False String Secondary DNS for this subnet
subnet[from] False String Starting IP Address for IP auto suggestion
subnet[to] False String Ending IP Address for IP auto suggestion
subnet[vlanid] False String VLAN ID for this subnet
subnet[domain_ids] False Array Domains that include this subnet
subnet[dhcp_id] False Number DHCP Proxy to use within this subnet
subnet[tftp_id] False Number TFTP Proxy to use within this subnet
subnet[dns_id] False Number DNS Proxy to use within this subnet

77.5. Delete a Subnet

  • DELETE /api/v2/subnets/:id
    Delete a subnet

Table 77.5. Parameters

Name Required Type Description
id True Number Subnet identifier

Chapter 78. Subscriptions

78.1. List Subscriptions

  • GET /katello/api/v2/systems/:system_id/subscriptions
    List a system's subscriptions
  • GET /katello/api/v2/organizations/:organization_id/subscriptions
    List organization subscriptions
  • GET /katello/api/v2/activation_keys/:activation_key_id/subscriptions
    List an activation key's subscriptions

Table 78.1. Parameters

Name Required Type Description
system_id False String UUID of the system
activation_key_id False String Activation key ID
organization_id False Number Organization ID

78.2. Show a Subscription

  • GET /katello/api/v2/organizations/:organization_id/subscriptions/:id
    Show a subscription
  • GET /katello/api/v2/subscriptions/:id
    Show a subscription

Table 78.2. Parameters

Name Required Type Description
organization_id False Number Organization identifier
id True Number Subscription identifier

78.3. Add a Subscription to a Resource

  • POST /katello/api/v2/subscriptions/:id
    Add a subscription to a resource
  • POST /katello/api/v2/systems/:system_id/subscriptions
    Add a subscription to a system
  • POST /katello/api/v2/activation_keys/:activation_key_id/subscriptions
    Add a subscription to an activation key

Table 78.3. Parameters

Name Required Type Description
id False String Subscription pool UUID
system_id False String System UUID
activation_key_id False String Activation key identifier
quantity False Number Quantity of subscriptions to add
subscriptions False Array of nested elements List of subscriptions to add
subscriptions[id] True String Subscription Pool UUID
subscriptions[quantity] True Number Quantity of this subscriptions to add

78.4. Unattach a Subscription

  • DELETE /katello/api/v2/subscriptions/:id
    Unattach a subscription
  • DELETE /katello/api/v2/systems/:system_id/subscriptions/:id
    Unattach a subscription
  • DELETE /katello/api/v2/activation_keys/:activation_key_id/subscriptions/:id
    Unattach a subscription

Table 78.4. Parameters

Name Required Type Description
id False String Subscription identifier
system_id False String System UUID
activation_key_id False String Aactivation key identifier
subscriptions False Array of nested elements List of subscriptions to add
subscriptions[id] True String Subscription Pool uuid

78.5. Upload a Subscription Manifest

  • POST /katello/api/v2/organizations/:organization_id/subscriptions/upload
    Upload a subscription manifest
  • POST /katello/api/v2/subscriptions/upload
    Upload a subscription manifest

Table 78.5. Parameters

Name Required Type Description
organization_id True Number Organization identifier
content True File Subscription manifest file
repository_url False String Repository URL

78.6. Refresh Previously Imported Manifest for Red Hat Provider

  • PUT /katello/api/v2/organizations/:organization_id/subscriptions/refresh_manifest
    Refresh previously imported manifest for Red Hat provider

Table 78.6. Parameters

Name Required Type Description
organization_id True Number Organization identifier

78.7. Delete Manifest From Red Hat Provider

  • POST /katello/api/v2/organizations/:organization_id/subscriptions/delete_manifest
    Delete manifest from Red Hat provider

Table 78.7. Parameters

Name Required Type Description
organization_id True Number Organization identifier

78.8. Obtain Manifest History for Subscriptions

  • GET /katello/api/v2/organizations/:organization_id/subscriptions/manifest_history
    obtain manifest history for subscriptions

Table 78.8. Parameters

Name Required Type Description
organization_id True Number Organization identifier

78.9. List Available Subscriptions

  • GET /katello/api/v2/systems/:system_id/subscriptions/available
    List available subscriptions

Table 78.9. Parameters

Name Required Type Description
system_id True String System UUID
match_system False Boolean Return subscriptions that match system
match_installed False Boolean Return subscriptions that match installed
no_overlap False Boolean Return subscriptions that do not overlap

Chapter 79. Synchronizations

79.1. Get Status of Repository Synchronisation for Given Product

  • GET /katello/api/v2/organizations/:organization_id/products/:product_id/sync
    Get status of repository synchronisation for given product
  • GET /katello/api/v2/repositories/:repository_id/sync
    Get status of synchronisation for given repository

Chapter 80. Synchronization Plans

80.1. List Synchronization Plans

  • GET /katello/api/v2/organizations/:organization_id/sync_plans
    List synchronization plans

Table 80.1. Parameters

Name Required Type Description
organization_id True Number Filter by organization name or label
name False String Filter by name
sync_date False String Filter by sync date
interval False String Filter by interval. Must be one of none, hourly, daily, and weekly.

80.2. Show a Synchronization Plan

  • GET /katello/api/v2/organizations/:organization_id/sync_plans/:id
    Show a synchronization plan
  • GET /katello/api/v2/sync_plans/:id
    Show a synchronization plan

Table 80.2. Parameters

Name Required Type Description
organization_id False Number Filter by organization name or label
id True Number Synchronization plan identifier

80.3. Create a Synchronization Plan

  • POST /katello/api/v2/organizations/:organization_id/sync_plans
    Create a synchronization plan

Table 80.3. Parameters

Name Required Type Description
organization_id True Number Organization name or label
name True String Synchronization plan name
interval True String Set how often synchronization runs. Must be one of none, hourly, daily, and weekly.
sync_date True Datetime Start date and time of synchronization
description False String Synchronization plan description

80.4. Update a Synchronization Plan

  • PUT /katello/api/v2/organizations/:organization_id/sync_plans/:id
    Update a synchronization plan
  • PUT /katello/api/v2/sync_plans/:id
    Update a synchronization plan

Table 80.4. Parameters

Name Required Type Description
organization_id False Number Organization name or label
id True Number Synchronization plan identifier
name False String Synchronization plan name
interval False String Set how often synchronization runs. Must be one of none, hourly, daily, and weekly.
sync_date False Datetime Start date and time of synchronization
description False String Synchronization plan description

80.5. Destroy a Synchronization Plan

  • DELETE /katello/api/v2/organizations/:organization_id/sync_plans/:id
    Destroy a synchronization plan
  • DELETE /katello/api/v2/sync_plans/:id
    Destroy a synchronization plan

Table 80.5. Parameters

Name Required Type Description
organization_id False Number Filter by organization name or label
id False Number Synchronization plan identifier

80.6. List Products not in a Synchronization Plan

  • GET /katello/api/v2/organizations/:organization_id/sync_plans/:id/available_products
    List products not in a synchronization plan

Table 80.6. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.
name False String Product name to use as a filter

80.7. Add Products to Synchronization Plan

  • PUT /katello/api/v2/organizations/:organization_id/sync_plans/:id/products
    Add products to synchronization plan

Table 80.7. Parameters

Name Required Type Description
id True String Synchronization plan identifier
product_ids True Array List of product identifiers to add to the synchronization plan

80.8. Remove Products From Synchronization Plan

  • PUT /katello/api/v2/organizations/:organization_id/sync_plans/:id/products
    Remove products from synchronization plan

Table 80.8. Parameters

Name Required Type Description
id True String Synchronization plan identifier
product_ids True Array List of product identifiers to remove from the synchronization plan

Chapter 81. System Errata

81.1. Schedule Errata for Installation

  • PUT /katello/api/v2/systems/:system_id/errata/apply
    Schedule errata for installation

Table 81.1. Parameters

Name Required Type Description
system_id False Array System to install errata
errata_ids False Array List of errata identifiers to install

81.2. Retrieve a Single Errata for a System

  • GET /katello/api/v2/systems/:system_id/errata/:id
    Retrieve a single errata for a system

Table 81.2. Parameters

Name Required Type Description
system_id False Array System identifier
id True String Errata ID of the erratum. For example, RHSA-2012:108.

Chapter 82. System Packages

82.1. Install Packages Remotely

  • POST /api/v2/systems/:system_id/packages
    Install packages remotely

Table 82.1. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of package names
groups False Array List of package group names

82.2. Update Packages Remotely

  • PUT /api/v2/systems/:system_id/packages
    Update packages remotely

Table 82.2. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of packages names

82.3. Uninstall Packages Remotely

  • DELETE /api/v2/systems/:system_id/packages
    Uninstall packages remotely

Table 82.3. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of package names
groups False Array List of package group names

82.4. Install Packages Remotely

  • POST /api/v2/systems/:system_id/packages/install
    Install packages remotely

Table 82.4. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of package names
groups False Array List of package group names

82.5. Update Packages Remotely

  • PUT /api/v2/systems/:system_id/packages/upgrade
    Update packages remotely

Table 82.5. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of packages names

82.6. Update Packages Remotely

  • PUT /api/v2/systems/:system_id/packages/upgrade_all
    Update packages remotely

Table 82.6. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier

82.7. Uninstall Packages Remotely

  • POST /api/v2/systems/:system_id/packages/remove
    Uninstall packages remotely

Table 82.7. Parameters

Name Required Type Description
system_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space System identifier
packages False Array List of package names
groups False Array List of package group names

Chapter 83. Systems

83.1. List Systems

  • GET /katello/api/v2/systems
    List systems
  • GET /katello/api/v2/organizations/:organization_id/systems
    List systems in an organization
  • GET /katello/api/v2/environments/:environment_id/systems
    List systems in environment
  • GET /katello/api/v2/host_collections/:host_collection_id/systems
    List systems in a host collection

Table 83.1. Parameters

Name Required Type Description
name False String Filter systems by name
pool_id False String Filter systems by subscribed pool
uuid False String Filter systems by UUID
organization_id True Number Organization identifier
environment_id False String Environment identifier
host_collection_id False String Host collection identifier
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.

83.2. Register a System

  • POST /katello/api/v2/systems
    Register a system
  • POST /katello/api/v2/environments/:environment_id/systems
    Register a system in environment
  • POST /katello/api/v2/host_collections/:host_collection_id/systems
    Register a system in environment

Table 83.2. Parameters

Name Required Type Description
name True String Name of the system
description False String Description of the system
location False String Physical location of the system
facts True Hash Subcollection of system-specific facts
facts[fact] False String Facts about the system in key-value format
type True String Type of the system. Always set to system.
guest_ids False Array List of guests running on this system
installed_products False Array List of products installed on the system
release_ver False String Release version of the system
service_level False String A service level for auto-healing process
last_checkin False String Last check-in time of this system
organization_id True Number Organization identifier
environment_id False String Environment identifier
content_view_id False String Content view identifier
host_collection_id False String Host collection identifier

83.3. Update System Information

  • PUT /katello/api/v2/systems/:id
    Update system information

Table 83.3. Parameters

Name Required Type Description
id True String UUID of the system
name False String Name of the system
description False String Description of the system
location False String Physical location of the system
facts True Hash Subcollection of system-specific facts
facts[fact] False String Facts about this system in key-value format
type True String Type of the system. Always set to system.
guest_ids False Array List of guests running on this system
installed_products False Array List of products installed on the system
release_ver False String Release version of the system
service_level False String A service level for auto-healing process
last_checkin False String Last check-in time of this system
environment_id False String Environment identifier
content_view_id False String Specify the content view

83.4. Show a System

  • GET /katello/api/v2/systems/:id
    Show a system

Table 83.4. Parameters

Name Required Type Description
id True String UUID of the system

83.5. List Host Collections the System Does Not Belong To

  • GET /katello/api/v2/systems/:id/available_host_collections
    List host collections the system does not belong to

Table 83.5. Parameters

Name Required Type Description
search False String Search string
page False Number Page number, starting at 1
per_page False Number Number of results per page to return
order False String Sort field and order. For example, name DESC.
full_results False Boolean Whether or not to show all results
sort False Hash Hash version of order parameter
sort[by] False String Field to use for sorting the results
sort[order] False String How to order the sorted results. Use ASC for ascending and DESC descending.
name False String Host collection name to use as a filter

83.6. Unregister a System

  • DELETE /katello/api/v2/systems/:id
    Unregister a system

Table 83.6. Parameters

Name Required Type Description
id True String UUID of the system

83.7. List Packages Installed on the System

  • GET /katello/api/v2/systems/:id/packages
    List packages installed on the system

Table 83.7. Parameters

Name Required Type Description
id True String UUID of the system

83.8. Trigger Refresh of Subscriptions

  • PUT /katello/api/v2/systems/:id/refresh_subscriptions
    Trigger a refresh of subscriptions, auto-attaching if enabled

Table 83.8. Parameters

Name Required Type Description
id True String UUID of the system

83.9. List Errata Available for the System

  • GET /katello/api/v2/systems/:id/errata
    List errata available for the system

Table 83.9. Parameters

Name Required Type Description
id True String UUID of the system

83.10. List Asynchronous Tasks for the System

  • GET /katello/api/v2/systems/:id/tasks
    List asynchronous tasks for the system

Table 83.10. Parameters

Name Required Type Description
id True String UUID of the system

83.11. Get System Reports

  • GET /katello/api/v2/environments/:environment_id/systems/report
    Get system reports for the environment
  • GET /katello/api/v2/organizations/:organization_id/systems/report
    Get system reports for the organization

83.12. List Pools a System Is Subscribed To

  • GET /katello/api/v2/systems/:id/pools
    List pools a system is subscribed

Table 83.11. Parameters

Name Required Type Description
id True String UUID of the system
match_system False Must be one of: true, false. Match pools to system
match_installed False Must be one of: true, false. Match pools to installed
no_overlap False Boolean Allow overlap

83.13. Show Releases Available for the System

  • GET /katello/api/v2/systems/:id/releases
    Show releases available for the system

Table 83.12. Parameters

Name Required Type Description
id True String UUID of the system

83.14. Update the Information About Enabled Repositories

  • PUT /katello/api/v2/systems/:id/enabled_repos
    Update the information about enabled repositories

Table 83.13. Parameters

Name Required Type Description
enabled_repos True Hash Enabled repositories subcollection
enabled_repos[repos] True Array of nested elements List of repositories
id True String UUID of the system

Chapter 84. Systems Bulk Actions

84.1. Add One or More Host Collections to One or More Content Hosts

  • PUT /katello/api/v2/systems/bulk/add_host_collections
    Add one or more host collections to one or more content hosts

Table 84.1. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
host_collection_ids True Array List of host collection identifiers

84.2. Remove One or More Host Collections From One or More Content Hosts

  • PUT /katello/api/v2/systems/bulk/remove_host_collections
    Remove one or more host collections from one or more content hosts

Table 84.2. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
host_collection_ids True Array List of host collection identifiers

84.3. Fetch Applicable Errata for a System

  • POST /katello/api/v2/systems/bulk/applicable_errata
    Fetch applicable errata for a system.

Table 84.3. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action

84.4. Install Content on One or More Systems

  • PUT /katello/api/v2/systems/bulk/install_content
    Install content on one or more systems

Table 84.4. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
content_type True String The type of content. The following types are supported: package, package_group, and errata.
content True Array List of content, such as package names, package group names, or errata IDs

84.5. Update Content on One or More Systems

  • PUT /katello/api/v2/systems/bulk/update_content
    Update content on one or more systems

Table 84.5. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
content_type True String The type of content. The following types are supported: package and package_group.
content True Array List of content, such as package names and package group names.

84.6. Remove Content on One or More Systems

  • PUT /katello/api/v2/systems/bulk/remove_content
    Remove content on one or more systems

Table 84.6. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
content_type True String The type of content. The following types are supported: package and package_group.
content True Array List of content, such as package names and package group names.

84.7. Destroy One or More Systems

  • PUT /katello/api/v2/systems/bulk/destroy
    Destroy one or more systems

Table 84.7. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action

84.8. Assign the Environment and Content View to One or More Systems

  • PUT /katello/api/v2/systems/bulk/environment_content_view
    Assign the environment and content view to one or more systems

Table 84.8. Parameters

Name Required Type Description
include True Hash Include subcollection
include[search] False String Search string for systems to perform an action
include[ids] False Array List of system identifiers to perform an action
exclude True Hash Exclude subcollection
exclude[ids] False Array List of system identifiers to exclude and not run an action
environment_id False Integer Environment identifier
content_view_id False Integer Content view identifier

Chapter 85. Tasks

85.1. List Tasks of Given Organization

  • GET /api/v2/organizations/:organization_id/tasks
    List tasks of given organization

Table 85.1. Parameters

Name Required Type Description
organization_id True Number Organization identifier

85.2. Show a Task Information

  • GET /api/v2/tasks/:id
    Show a task information

Table 85.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Task identifier

Chapter 86. Template Combinations

86.1. List Template Combination

  • GET /api/v2/config_templates/:config_template_id/template_combinations
    List Template Combination

Table 86.1. Parameters

Name Required Type Description
config_template_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Configuration template identifier

86.2. Add a Template Combination

  • POST /api/v2/config_templates/:config_template_id/template_combinations
    Add a Template Combination

Table 86.2. Parameters

Name Required Type Description
config_template_id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Configuration template identifier
template_combination True Hash Template combination subcollection
template_combination[environment_id] False Number Environment identifier
template_combination[hostgroup_id] False Number Hostgroup identifier

86.3. Show Template Combination

  • GET /api/v2/template_combinations/:id
    Show Template Combination

Table 86.3. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Template combination identifier

86.4. Delete a Template

  • DELETE /api/v2/template_combinations/:id
    Delete a template

Table 86.4. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Template combination identifier

Chapter 87. Template Kinds

87.1. List all Template Kinds

  • GET /api/v2/template_kinds
    List all template kinds.

Table 87.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return

Chapter 88. Usergroups

88.1. List all Usergroups

  • GET /api/v2/usergroups
    List all usergroups.

Table 88.1. Parameters

Name Required Type Description
page False String Page number, starting at 1
per_page False String Number of results per page to return
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.

88.2. Show a Usergroup

  • GET /api/v2/usergroups/:id
    Show a usergroup.

Table 88.2. Parameters

Name Required Type Description
id True String from 2 to 128 characters containing only alphanumeric characters, space, underscores, and dashes but no leading or trailing space Usergroup identifier

88.3. Create a Usergroup

  • POST /api/v2/usergroups
    Create a usergroup.

Table 88.3. Parameters

Name Required Type Description
usergroup False Hash Usergroup subcollection
usergroup[name] True String Usergroup name
usergroup[user_ids] False Array List of users to attach to the usergroup
usergroup[usergroup_ids] False Array List of child usergroups to attach to the parent usergroup
usergroup[role_ids] False Array List of roles to attach to the usergroup

88.4. Update a Usergroup

  • PUT /api/v2/usergroups/:id
    Update a usergroup.

Table 88.4. Parameters

Name Required Type Description
id True String Usergroup identifier
usergroup False Hash Usergroup subcollection
usergroup[name] False String Usergroup name
usergroup[user_ids] False Array List of users to attach to the usergroup
usergroup[usergroup_ids] False Array List of child usergroups to attach to the parent usergroup
usergroup[role_ids] False Array List of roles to attach to the usergroup

88.5. Delete a Usergroup

  • DELETE /api/v2/usergroups/:id
    Delete a usergroup.

Table 88.5. Parameters

Name Required Type Description
id True String Usergroup identifier

Chapter 89. Users

89.1. List all Users

  • GET /api/v2/users
    List all users.

Table 89.1. Parameters

Name Required Type Description
search False String Search string
order False String How to order the sorted results. Use ASC for ascending and DESC descending.
page False String Page number, starting at 1
per_page False String Number of results per page to return

89.2. Show a User

  • GET /api/v2/users/:id
    Show an user.

Table 89.2. Parameters

Name Required Type Description
id True String User identifier

89.3. Create a User

  • POST /api/v2/users
    Create an user.

Table 89.3. Parameters

Name Required Type Description
user False Hash User subcollection
user[login] True String User login
user[firstname] False String User first name
user[lastname] False String User last name
user[mail] True String User email address
user[admin] False Boolean Define if the user is an administrator
user[password] True String User password
user[default_location_id] False Integer Default location identifier
user[default_organization_id] False Integer Default organization identifier
user[auth_source_id] True Integer Authentication source of the user

89.4. Update a User

  • PUT /api/v2/users/:id
    Update an user.

Table 89.4. Parameters

Name Required Type Description
id True String User identifier
user False Hash User subcollection
user[login] True String User login
user[firstname] False String User first name
user[lastname] False String User last name
user[mail] True String User email address
user[admin] False Boolean Define if the user is an administrator
user[password] True String User password
user[default_location_id] False Integer Default location identifier
user[default_organization_id] False Integer Default organization identifier
user[auth_source_id] True Integer Authentication source of the user

89.5. Delete a User

  • DELETE /api/v2/users/:id
    Delete an user.

Table 89.5. Parameters

Name Required Type Description
id True String User identifier

Appendix A. Revision History

Revision History
Revision 2-3Tue Feb 2 2016Byron Gravenorst
BZ 1258102: Updated the Satellite 6.0 API Guide with the correct URL.
Revision 1-0Tue Sep 9 2014Athene Chan
Red Hat Satellite 6.0 GA Release
Revision 0-9.1Tue Jul 1 2014Athene Chan
Edited content specification details.
Revision 0-9Mon Jun 30 2014Athene Chan
Preparing book for Beta release.
Revision 0-8.403Mon Nov 11 2013Rüdiger Landmann
Rebuild with Publican 4.0.0
Revision 0-08Mon Nov 11 2013Dan Macpherson
Fixing minor errors.
Revision 0-07Mon 11 Nov 2013Dan Macpherson
Preparation for MDP2.
Revision 0-06Wed 09 Oct 2013Dan Macpherson
Finalizing QE review implementation.
Revision 0-05Thu 26 Sep 2013Dan Macpherson
Minor QE review fixes.
Revision 0-04Wed 25 Sep 2013Dan Macpherson
Minor QE review fixes.
Revision 0-03Wed 25 Sep 2013Dan Macpherson
Implementation of QE review feedback.
Revision 0-02Wed 14 Aug 2013Dan Macpherson
Build of book for technical review.
Revision 0-01Tue 28 May 2013Athene Chan
Intial book creation of the Red Hat Satellite API Guide.

Legal Notice

Copyright © 2014 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.