Foreman API v2 is currently the default API version.

Resources

Activation keys

Resource Description
GET /katello/api/activation_keys List activation keys
GET /katello/api/environments/:environment_id/activation_keys
GET /katello/api/organizations/:organization_id/activation_keys
POST /katello/api/activation_keys Create an activation key
PUT /katello/api/activation_keys/:id Update an activation key
DELETE /katello/api/activation_keys/:id Destroy an activation key
GET /katello/api/activation_keys/:id Show an activation key
POST /katello/api/activation_keys/:id/copy Copy an activation key
GET /katello/api/activation_keys/:id/host_collections/available List host collections the activation key does not belong to
GET /katello/api/activation_keys/:id/releases Show release versions available for an activation key
GET /katello/api/activation_keys/:id/product_content Show content available for an activation key
POST /katello/api/activation_keys/:id/host_collections
PUT /katello/api/activation_keys/:id/host_collections
PUT /katello/api/activation_keys/:id/add_subscriptions Attach a subscription
PUT /katello/api/activation_keys/:id/remove_subscriptions Unattach a subscription
PUT /katello/api/activation_keys/:id/content_override Override content for activation_key

Architectures

Resource Description
GET /api/architectures List all architectures
GET /api/operatingsystems/:operatingsystem_id/architectures List all architectures for operating system
GET /api/architectures/:id Show an architecture
POST /api/architectures Create an architecture
PUT /api/architectures/:id Update an architecture
DELETE /api/architectures/:id Delete an architecture

Audits

Resource Description
GET /api/audits List all audits
GET /api/hosts/:host_id/audits List all audits for a given host
GET /api/audits/:id Show an audit

Auth source externals

Resource Description
GET /api/auth_source_externals List external authentication sources
GET /api/locations/:location_id/auth_source_externals List external authentication sources per location
GET /api/organizations/:organization_id/auth_source_externals List external authentication sources per organization
GET /api/auth_source_externals/:id Show an external authentication source
PUT /api/auth_source_externals/:id Update an external authentication source

Auth source internals

Resource Description
GET /api/auth_source_internals List internal authentication sources
GET /api/auth_source_internals/:id Show an internal authentication source

Auth source ldaps

Resource Description
GET /api/auth_source_ldaps List all LDAP authentication sources
GET /api/locations/:location_id/auth_source_ldaps List LDAP authentication sources per location
GET /api/organizations/:organization_id/auth_source_ldaps List LDAP authentication sources per organization
GET /api/auth_source_ldaps/:id Show an LDAP authentication source
POST /api/auth_source_ldaps Create an LDAP authentication source
PUT /api/auth_source_ldaps/:id Update an LDAP authentication source
PUT /api/auth_source_ldaps/:id/test Test LDAP connection
DELETE /api/auth_source_ldaps/:id Delete an LDAP authentication source

Auth sources

Resource Description
GET /api/auth_sources List all authentication sources
GET /api/locations/:location_id/auth_sources List all authentication sources per location
GET /api/organizations/:organization_id/auth_sources List all authentication sources per organization

Autosign

Resource Description
GET /api/smart_proxies/smart_proxy_id/autosign List all autosign entries
POST /api/smart_proxies/:smart_proxy_id/autosign Create autosign entry
DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id Delete autosign entry

Bookmarks

Resource Description
GET /api/bookmarks List all bookmarks
GET /api/bookmarks/:id Show a bookmark
POST /api/bookmarks Create a bookmark
PUT /api/bookmarks/:id Update a bookmark
DELETE /api/bookmarks/:id Delete a bookmark

Capsule content

Resource Description
GET /katello/api/capsules/:id/content/lifecycle_environments List the lifecycle environments attached to the smart proxy
GET /katello/api/capsules/:id/content/available_lifecycle_environments List the lifecycle environments not attached to the smart proxy
POST /katello/api/capsules/:id/content/lifecycle_environments Add lifecycle environments to the smart proxy
DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id Remove lifecycle environments from the smart proxy
POST /katello/api/capsules/:id/content/sync Synchronize the content to the smart proxy
GET /katello/api/capsules/:id/content/sync Get current smart proxy synchronization status
DELETE /katello/api/capsules/:id/content/sync Cancel running smart proxy synchronization

Capsules

Resource Description
GET /katello/api/capsules List all smart proxies that have content
GET /katello/api/capsules/:id Show the smart proxy details

Common parameters

Resource Description
GET /api/common_parameters List all global parameters
GET /api/common_parameters/:id Show a global parameter
POST /api/common_parameters Create a global parameter
PUT /api/common_parameters/:id Update a global parameter
DELETE /api/common_parameters/:id Delete a global parameter

Compute attributes

Resource Description
POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes Create a compute attributes set
POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes Create a compute attributes set
POST /api/compute_resources/:compute_resource_id/compute_attributes Create a compute attributes set
POST /api/compute_profiles/:compute_profile_id/compute_attributes Create a compute attributes set
POST /api/compute_attributes Create a compute attributes set
PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id Update a compute attributes set
PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id Update a compute attributes set
PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id Update a compute attributes set
PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id Update a compute attributes set
PUT /api/compute_attributes/:id Update a compute attributes set

Compute profiles

Resource Description
GET /api/compute_profiles List of compute profiles
GET /api/compute_profiles/:id Show a compute profile
POST /api/compute_profiles Create a compute profile
PUT /api/compute_profiles/:id Update a compute profile
DELETE /api/compute_profiles/:id Delete a compute profile

Compute resources

Resource Description
GET /api/compute_resources List all compute resources
GET /api/compute_resources/:id Show a compute resource
POST /api/compute_resources Create a compute resource
PUT /api/compute_resources/:id Update a compute resource
DELETE /api/compute_resources/:id Delete a compute resource
GET /api/compute_resources/:id/available_images List available images for a compute resource
GET /api/compute_resources/:id/available_clusters List available clusters for a compute resource
GET /api/compute_resources/:id/available_flavors List available flavors for a compute resource
GET /api/compute_resources/:id/available_folders List available folders for a compute resource
GET /api/compute_resources/:id/available_zones List available zone for a compute resource
GET /api/compute_resources/:id/available_networks List available networks for a compute resource
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks List available networks for a compute resource cluster
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools List resource pools for a compute resource cluster
GET /api/compute_resources/:id/available_storage_domains List storage domains for a compute resource
GET /api/compute_resources/:id/available_storage_domains/:storage_domain List attributes for a given storage domain
GET /api/compute_resources/:id/available_storage_pods List storage pods for a compute resource
GET /api/compute_resources/:id/available_storage_pods/:storage_pod List attributes for a given storage pod
GET /api/compute_resources/:id/available_security_groups List available security groups for a compute resource
PUT /api/compute_resources/:id/associate Associate VMs to Hosts
PUT /api/compute_resources/:id/refresh_cache Refresh Compute Resource Cache

Config groups

Resource Description
GET /api/config_groups List of config groups
GET /api/config_groups/:id Show a config group
POST /api/config_groups Create a config group
PUT /api/config_groups/:id Update a config group
DELETE /api/config_groups/:id Delete a config group

Config reports

Resource Description
GET /api/config_reports List all reports
GET /api/config_reports/:id Show a report
POST /api/config_reports Create a report
DELETE /api/config_reports/:id Delete a report
GET /api/hosts/:host_id/config_reports/last Show the last report for a host

Config templates

Resource Description
GET /api/config_templates List provisioning templates
GET /api/operatingsystems/:operatingsystem_id/config_templates List provisioning templates per operating system
GET /api/locations/:location_id/config_templates List provisioning templates per location
GET /api/organizations/:organization_id/config_templates List provisioning templates per organization
GET /api/config_templates/:id Show provisioning template details
POST /api/config_templates Create a provisioning template
PUT /api/config_templates/:id Update a provisioning template
GET /api/config_templates/revision
DELETE /api/config_templates/:id Delete a provisioning template
POST /api/config_templates/build_pxe_default Update the default PXE menu on all configured TFTP servers
POST /api/config_templates/:id/clone Clone a provision template

Containers

Resource Description
GET /docker/api/v2/containers List all containers
GET /docker/api/v2/compute_resources/:compute_resource_id/containers List all containers on a compute resource
GET /docker/api/v2/containers/:id Show a container
GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id Show container on a compute resource
POST /docker/api/v2/containers Create a container
POST /docker/api/v2/compute_resources/:compute_resource_id/containers Create container on a compute resource
DELETE /docker/api/v2/containers/:id Delete a container
DELETE /docker/api/v2/compute_resources/:compute_resource_id/containers/:id Delete container on a compute resource
GET /docker/api/v2/containers/:id/logs Show container logs
GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/logs Show logs from a container on a compute resource
PUT /docker/api/v2/containers/:id/power Run power operation on a container
PUT /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/power Run power operation on a container on a compute resource

Content credentials

Resource Description
GET /katello/api/content_credentials List content credentials
POST /katello/api/content_credentials Create a content credential
GET /katello/api/content_credentials/:id Show a content credential
PUT /katello/api/content_credentials/:id Update a content credential
DELETE /katello/api/content_credentials/:id Destroy a content credential
GET /katello/api/content_credentials/:id/content Return the content of a content credential, used directly by yum
POST /katello/api/content_credentials/:id/content Upload content credential contents

Content uploads

Resource Description
POST /katello/api/repositories/:repository_id/content_uploads Create an upload request
PUT /katello/api/repositories/:repository_id/content_uploads/:id Upload a chunk of the file's content
DELETE /katello/api/repositories/:repository_id/content_uploads/:id Delete an upload request

Content view components

Resource Description
GET /katello/api/content_views/:composite_content_view_id/content_view_components List components attached to this content view
PUT /katello/api/content_views/:composite_content_view_id/content_view_components/add Add components to the content view
PUT /katello/api/content_views/:composite_content_view_id/content_view_components/remove Remove components from the content view
GET /katello/api/content_views/:composite_content_view_id/content_view_components/:id Show a content view component
PUT /katello/api/content_views/:composite_content_view_id/content_view_components/:id Update a component associated with the content view

Content view filter rules

Resource Description
GET /katello/api/content_view_filters/:content_view_filter_id/rules List filter rules
POST /katello/api/content_view_filters/:content_view_filter_id/rules Create a filter rule. The parameters included should be based upon the filter type.
GET /katello/api/content_view_filters/:content_view_filter_id/rules/:id Show filter rule info
PUT /katello/api/content_view_filters/:content_view_filter_id/rules/:id Update a filter rule. The parameters included should be based upon the filter type.
DELETE /katello/api/content_view_filters/:content_view_filter_id/rules/:id Delete a filter rule

Content view filters

Resource Description
get /katello/api/content_views/:content_view_id/filters list filters
get /katello/api/content_view_filters list filters
post /katello/api/content_views/:content_view_id/filters create a filter for a content view
post /katello/api/content_view_filters create a filter for a content view
get /katello/api/content_views/:content_view_id/filters/:id show filter info
get /katello/api/content_view_filters/:id show filter info
put /katello/api/content_views/:content_view_id/filters/:id update a filter
put /katello/api/content_view_filters/:id update a filter
delete /katello/api/content_views/:content_view_id/filters/:id delete a filter
delete /katello/api/content_view_filters/:id delete a filter

Content view histories

Resource Description
GET /katello/api/content_views/:id/history Show a content view's history

Content view puppet modules

Resource Description
GET /katello/api/content_views/:content_view_id/content_view_puppet_modules List content view puppet modules
POST /katello/api/content_views/:content_view_id/content_view_puppet_modules Add a puppet module to the content view
GET /katello/api/content_views/:content_view_id/content_view_puppet_modules/:id Show a content view puppet module
PUT /katello/api/content_views/:content_view_id/content_view_puppet_modules/:id Update a puppet module associated with the content view
DELETE /katello/api/content_views/:content_view_id/content_view_puppet_modules/:id Remove a puppet module from the content view

Content view versions

Resource Description
GET /katello/api/content_view_versions List content view versions
GET /katello/api/content_views/:content_view_id/content_view_versions List content view versions
GET /katello/api/content_view_versions/:id Show content view version
POST /katello/api/content_view_versions/:id/promote Promote a content view version
PUT /katello/api/content_view_versions/:id Update a content view version
PUT /katello/api/content_view_versions/:id/republish_repositories Forces a republish of the version's repositories' metadata
POST /katello/api/content_view_versions/:id/export DEPRECATED Export a content view version
DELETE /katello/api/content_view_versions/:id Remove content view version
POST /katello/api/content_view_versions/incremental_update Perform an Incremental Update on one or more Content View Versions

Content views

Resource Description
GET /katello/api/organizations/:organization_id/content_views List content views
GET /katello/api/content_views List content views
POST /katello/api/organizations/:organization_id/content_views Create a content view
POST /katello/api/content_views Create a content view
PUT /katello/api/content_views/:id Update a content view
POST /katello/api/content_views/:id/publish Publish a content view
GET /katello/api/content_views/:id Show a content view
GET /katello/api/content_views/:id/available_puppet_modules Get puppet modules that are available to be added to the content view
GET /katello/api/content_views/:id/available_puppet_module_names Get puppet modules names that are available to be added to the content view
DELETE /katello/api/content_views/:id/environments/:environment_id Remove a content view from an environment
PUT /katello/api/content_views/:id/remove Remove versions and/or environments from a content view and reassign systems and keys
DELETE /katello/api/content_views/:id Delete a content view
POST /katello/api/content_views/:id/copy Make copy of a content view

Dashboard

Resource Description
GET /api/dashboard Get dashboard details

Deb Packages

Resource Description
GET /katello/api/debs List debs
GET /katello/api/content_views/:content_view_id/filters/:filter_id/debs List debs
GET /katello/api/content_view_filters/:content_view_filter_id/debs List debs
GET /katello/api/repositories/:repository_id/debs List debs
GET /katello/api/debs/:id Show a deb
GET /katello/api/repositories/:repository_id/debs/:id Show a deb
GET /katello/api/debs/compare List debs

Docker manifest lists

Resource Description
GET /katello/api/docker_manifest_lists List docker_manifest_lists
GET /katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists List docker_manifest_lists
GET /katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists List docker_manifest_lists
GET /katello/api/repositories/:repository_id/docker_manifest_lists List docker_manifest_lists
GET /katello/api/docker_manifest_lists/:id Show a docker manifest list
GET /katello/api/repositories/:repository_id/docker_manifest_lists/:id Show a docker manifest list
GET /katello/api/docker_manifest_lists/compare List docker_manifest_lists

Docker manifests

Resource Description
GET /katello/api/docker_manifests List docker_manifests
GET /katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests List docker_manifests
GET /katello/api/content_view_filters/:content_view_filter_id/docker_manifests List docker_manifests
GET /katello/api/repositories/:repository_id/docker_manifests List docker_manifests
GET /katello/api/docker_manifests/:id Show a docker manifest
GET /katello/api/repositories/:repository_id/docker_manifests/:id Show a docker manifest
GET /katello/api/docker_manifests/compare List docker_manifests

Docker tags

Resource Description
GET /katello/api/docker_tags List docker_tags
GET /katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags List docker_tags
GET /katello/api/content_view_filters/:content_view_filter_id/docker_tags List docker_tags
GET /katello/api/repositories/:repository_id/docker_tags List docker_tags
GET /katello/api/docker_tags/:id Show a docker tag
GET /katello/api/repositories/:repository_id/docker_tags/:id Show a docker tag
GET /katello/api/docker_tags/compare List docker_tags

Domains

Resource Description
GET /api/domains List of domains
GET /api/subnets/:subnet_id/domains List of domains per subnet
GET /api/locations/:location_id/domains List of domains per location
GET /api/organizations/:organization_id/domains List of domains per organization
GET /api/domains/:id Show a domain
POST /api/domains Create a domain
PUT /api/domains/:id Update a domain
DELETE /api/domains/:id Delete a domain

Environments

Resource Description
POST /api/smart_proxies/:id/import_puppetclasses Import puppet classes from puppet proxy
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses Import puppet classes from puppet proxy for an environment
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses Import puppet classes from puppet proxy for an environment
GET /api/environments List all environments
GET /api/puppetclasses/:puppetclass_id/environments List environments of Puppet class
GET /api/locations/:location_id/environments List environments per location
GET /api/organizations/:organization_id/environments List environments per organization
GET /api/environments/:id Show an environment
POST /api/environments Create an environment
PUT /api/environments/:id Update an environment
DELETE /api/environments/:id Delete an environment

Errata

Resource Description
GET /katello/api/errata List errata
GET /katello/api/errata/:id Show an erratum
GET /katello/api/repositories/:repository_id/errata/:id Show an erratum
GET /katello/api/errata/compare List errata
GET /katello/api/content_view_versions/:id/available_errata DEPRECATED Return errata that can be added to the Content View Version via an Incremental Update

External usergroups

Resource Description
GET /api/usergroups/:usergroup_id/external_usergroups List all external user groups for user group
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups List all external user groups for LDAP authentication source
GET /api/usergroups/:usergroup_id/external_usergroups/:id Show an external user group for user group
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id Show an external user group for LDAP authentication source
POST /api/usergroups/:usergroup_id/external_usergroups Create an external user group linked to a user group
PUT /api/usergroups/:usergroup_id/external_usergroups/:id Update external user group
PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh Refresh external user group
DELETE /api/usergroups/:usergroup_id/external_usergroups/:id Delete an external user group

Fact values

Resource Description
GET /api/fact_values List all fact values
GET /api/hosts/:host_id/facts List all fact values of a given host

Files

Resource Description
GET /katello/api/files List files
GET /katello/api/content_views/:content_view_id/filters/:filter_id/files List files
GET /katello/api/content_view_filters/:content_view_filter_id/files List files
GET /katello/api/repositories/:repository_id/files List files
GET /katello/api/files/:id Show a file
GET /katello/api/repositories/:repository_id/files/:id Show a file
GET /katello/api/files/compare List files

Filters

Resource Description
GET /api/filters List all filters
GET /api/filters/:id Show a filter
POST /api/filters Create a filter
PUT /api/filters/:id Update a filter
DELETE /api/filters/:id Delete a filter

Foreman tasks

Resource Description
GET /foreman_tasks/api/tasks/summary Show task summary
GET /foreman_tasks/api/tasks/:id Show task details
POST /foreman_tasks/api/tasks/bulk_search List dynflow tasks for uuids
POST /foreman_tasks/api/tasks/bulk_resume Resume all paused error tasks
GET /foreman_tasks/api/tasks List tasks
POST /foreman_tasks/api/tasks/callback Send data to the task from external executor (such as smart_proxy_dynflow)

Gpg keys

Resource Description
GET /katello/api/gpg_keys List gpg keys
POST /katello/api/gpg_keys Create a gpg key
GET /katello/api/gpg_keys/:id Show a gpg key
PUT /katello/api/gpg_keys/:id Update a repository
DELETE /katello/api/gpg_keys/:id Destroy a gpg key
GET /katello/api/gpg_keys/:id/content Return the content of a gpg key, used directly by yum
POST /katello/api/gpg_keys/:id/content Upload gpg key contents

Home

Resource Description
GET /api Show available API links
GET /api/status Show status

Host classes

Resource Description
GET /api/hosts/:host_id/puppetclass_ids List all Puppet class IDs for host
POST /api/hosts/:host_id/puppetclass_ids Add a Puppet class to host
DELETE /api/hosts/:host_id/puppetclass_ids/:id Remove a Puppet class from host

Host collections

Resource Description
GET /katello/api/host_collections/:id Show a host collection
GET /katello/api/host_collections List host collections
GET /katello/api/organizations/:organization_id/host_collections List host collections within an organization
GET /katello/api/activation_keys/:activation_key_id/host_collections List host collections in an activation key
POST /katello/api/host_collections Create a host collection
POST /katello/api/organizations/:organization_id/host_collections Create a host collection
PUT /katello/api/host_collections/:id Update a host collection
PUT /katello/api/host_collections/:id/add_hosts Add host to the host collection
PUT /katello/api/host_collections/:id/remove_hosts Remove hosts from the host collection
DELETE /katello/api/host_collections/:id Destroy a host collection
POST /katello/api/host_collections/:id/copy Make copy of a host collection

Host errata

Resource Description
GET /api/hosts/:host_id/errata List errata available for the content host
PUT /api/hosts/:host_id/errata/apply Schedule errata for installation
GET /api/hosts/:host_id/errata/:id Retrieve a single errata for a host
PUT /api/hosts/:host_id/errata/applicability Force regenerate applicability.

Host module streams

Resource Description
GET /api/hosts/:host_id/module_streams List module streams available to the host

Host packages

Resource Description
GET /api/hosts/:host_id/packages List packages installed on the host
PUT /api/hosts/:host_id/packages/install Install packages remotely
PUT /api/hosts/:host_id/packages/upgrade Update packages remotely
PUT /api/hosts/:host_id/packages/upgrade_all Update packages remotely
PUT /api/hosts/:host_id/packages/remove Uninstall packages remotely

Host subscriptions

Resource Description
GET /api/hosts/:host_id/subscriptions List a host's subscriptions
PUT /api/hosts/:host_id/subscriptions/auto_attach Trigger an auto-attach of subscriptions
GET /api/hosts/:host_id/subscriptions/events List subscription events for the host
DELETE /api/hosts/:host_id/subscriptions Unregister the host as a subscription consumer
POST /api/hosts/subscriptions Register a host with subscription and information
PUT /api/hosts/:host_id/subscriptions/remove_subscriptions
PUT /api/hosts/:host_id/subscriptions/add_subscriptions Add a subscription to a host
PUT /api/hosts/:host_id/subscriptions/content_override Set content overrides for the host
GET /api/hosts/:host_id/subscriptions/product_content Get content and overrides for the host
GET /api/hosts/:host_id/subscriptions/available_release_versions Show releases available for the content host

Host tracer

Resource Description
GET /api/hosts/:host_id/traces List services that need restarting on the host

Hostgroup classes

Resource Description
GET /api/hostgroups/:hostgroup_id/puppetclass_ids List all Puppet class IDs for host group
POST /api/hostgroups/:hostgroup_id/puppetclass_ids Add a Puppet class to host group
DELETE /api/hostgroups/:hostgroup_id/puppetclass_ids/:id Remove a Puppet class from host group

Hostgroups

Resource Description
GET /api/hostgroups List all host groups
GET /api/puppetclasses/:puppetclass_id/hostgroups List all host groups for a Puppet class
GET /api/locations/:location_id/hostgroups List all host groups per location
GET /api/organizations/:organization_id/hostgroups List all host groups per organization
GET /api/hostgroups/:id Show a host group
POST /api/hostgroups Create a host group
PUT /api/hostgroups/:id Update a host group
DELETE /api/hostgroups/:id Delete a host group
POST /api/hostgroups/:id/clone Clone a host group
PUT /api/hostgroups/:id/rebuild_config Rebuild orchestration config

Hosts

Resource Description
GET /api/hosts List all hosts
GET /api/hostgroups/:hostgroup_id/hosts List all hosts for a host group
GET /api/locations/:location_id/hosts List hosts per location
GET /api/organizations/:organization_id/hosts List hosts per organization
GET /api/environments/:environment_id/hosts List hosts per environment
GET /api/hosts/:id Show a host
POST /api/hosts Create a host
PUT /api/hosts/:id Update a host
DELETE /api/hosts/:id Delete a host
GET /api/hosts/:id/enc Get ENC values of host
GET /api/hosts/:id/status Get configuration status of host
GET /api/hosts/:id/status/:type Get status of host
GET /api/hosts/:id/vm_compute_attributes Get vm attributes of host
PUT /api/hosts/:id/disassociate Disassociate the host from a VM
PUT /api/hosts/:id/power Run a power operation on host
PUT /api/hosts/:id/boot Boot host from specified device
POST /api/hosts/facts Upload facts for a host, creating the host if required
PUT /api/hosts/:id/rebuild_config Rebuild orchestration config
GET /api/hosts/:id/template/:kind Preview rendered provisioning template content
PUT /api/hosts/:host_id/host_collections Alter a hosts host collections

Hosts bulk actions

Resource Description
PUT /api/hosts/bulk/add_host_collections Add one or more host collections to one or more hosts
PUT /api/hosts/bulk/remove_host_collections Remove one or more host collections from one or more hosts
POST /api/hosts/bulk/applicable_errata Fetch applicable errata for a host.
POST /api/hosts/bulk/installable_errata Fetch installable errata for a host.
PUT /api/hosts/bulk/install_content Install content on one or more hosts
PUT /api/hosts/bulk/update_content Update content on one or more hosts
PUT /api/hosts/bulk/remove_content Remove content on one or more hosts
PUT /api/hosts/bulk/destroy Destroy one or more hosts
PUT /api/hosts/bulk/remove_subscriptions Remove subscriptions from one or more hosts
PUT /api/hosts/bulk/add_subscriptions Add subscriptions to one or more hosts
PUT /api/hosts/bulk/auto_attach Trigger an auto-attach of subscriptions on one or more hosts
PUT /api/hosts/bulk/content_overrides Set content overrides to one or more hosts
PUT /api/hosts/bulk/environment_content_view Assign the environment and content view to one or more hosts
PUT /api/hosts/bulk/release_version Assign the release version to one or more hosts
POST /api/hosts/bulk/available_incremental_updates Given a set of hosts and errata, lists the content view versions and environments that need updating.
POST /api/hosts/bulk/module_streams Fetch available module streams for hosts.

Http proxies

Resource Description
GET /api/http_proxies List of HTTP Proxies
GET /api/http_proxies/:id Show an HTTP Proxy
POST /api/http_proxies Create an HTTP Proxy
PUT /api/http_proxies/:id Update an HTTP Proxy
DELETE /api/http_proxies/:id Delete an HTTP Proxy

Images

Resource Description
GET /api/compute_resources/:compute_resource_id/images List all images for a compute resource
GET /api/operatingsystems/:operatingsystem_id/images List all images for operating system
GET /api/architectures/:architecture_id/images List all images for architecture
GET /api/compute_resources/:compute_resource_id/images/:id Show an image
GET /api/operatingsystems/:operatingsystem_id/images/:id Show an image
GET /api/architectures/:architecture_id/images/:id Show an image
POST /api/compute_resources/:compute_resource_id/images Create an image
PUT /api/compute_resources/:compute_resource_id/images/:id Update an image
DELETE /api/compute_resources/:compute_resource_id/images/:id Delete an image

Interfaces

Resource Description
GET /api/hosts/:host_id/interfaces List all interfaces for host
GET /api/domains/:domain_id/interfaces List all interfaces for domain
GET /api/subnets/:subnet_id/interfaces List all interfaces for subnet
GET /api/hosts/:host_id/interfaces/:id Show an interface for host
POST /api/hosts/:host_id/interfaces Create an interface on a host
PUT /api/hosts/:host_id/interfaces/:id Update a host's interface
DELETE /api/hosts/:host_id/interfaces/:id Delete a host's interface

Lifecycle environments

Resource Description
GET /katello/api/environments List environments in an organization
GET /katello/api/organizations/:organization_id/environments List environments in an organization
GET /katello/api/environments/:id Show an environment
GET /katello/api/organizations/:organization_id/environments/:environment_id Show an environment
POST /katello/api/environments Create an environment
POST /katello/api/organizations/:organization_id/environments Create an environment in an organization
PUT /katello/api/environments/:id Update an environment
PUT /katello/api/organizations/:organization_id/environments/:id Update an environment in an organization
DELETE /katello/api/environments/:id Destroy an environment
DELETE /katello/api/organizations/:organization_id/environments/:id Destroy an environment in an organization
GET /katello/api/organizations/:organization_id/environments/paths List environment paths

Locations

Resource Description
GET /api/locations List all locations
GET /api/locations/:id Show a location
POST /api/locations Create a location
PUT /api/locations/:id Update a location
DELETE /api/locations/:id Delete a location

Mail notifications

Resource Description
GET /api/mail_notifications List of email notifications
GET /api/mail_notifications/:id Show an email notification

Media

Resource Description
GET /api/media List all installation media
GET /api/operatingsystems/:operatingsystem_id/media List all media for an operating system
GET /api/locations/:location_id/media List all media per location
GET /api/organizations/:organization_id/media List all media per organization
GET /api/media/:id Show a medium
POST /api/media Create a medium
PUT /api/media/:id Update a medium
DELETE /api/media/:id Delete a medium

Models

Resource Description
GET /api/models List all hardware models
GET /api/models/:id Show a hardware model
POST /api/models Create a hardware model
PUT /api/models/:id Update a hardware model
DELETE /api/models/:id Delete a hardware model

Module streams

Resource Description
GET /katello/api/module_streams List module_streams
GET /katello/api/content_views/:content_view_id/filters/:filter_id/module_streams List module_streams
GET /katello/api/content_view_filters/:content_view_filter_id/module_streams List module_streams
GET /katello/api/repositories/:repository_id/module_streams List module_streams
GET /katello/api/module_streams/:id Show a module stream
GET /katello/api/repositories/:repository_id/module_streams/:id Show a module stream
GET /katello/api/module_streams/compare List module_streams

Operating systems

Resource Description
GET /api/operatingsystems List all operating systems
GET /api/architectures/:architecture_id/operatingsystems List all operating systems for nested architecture
GET /api/media/:medium_id/operatingsystems List all operating systems for nested medium
GET /api/ptables/:ptable_id/operatingsystems List all operating systems for nested partition table
GET /api/config_templates/:config_template_id/operatingsystems List all operating systems for nested provisioning template
GET /api/provisioning_templates/:provisioning_template_id/operatingsystems List all operating systems for nested provisioning template
GET /api/operatingsystems/:id Show an operating system
POST /api/operatingsystems Create an operating system
PUT /api/operatingsystems/:id Update an operating system
DELETE /api/operatingsystems/:id Delete an operating system
GET /api/operatingsystems/:id/bootfiles List boot files for an operating system

Organizations

Resource Description
GET /katello/api/organizations List all organizations
GET /katello/api/organizations/:id Show organization
POST /katello/api/organizations Create organization
PUT /katello/api/organizations/:id Update organization
DELETE /katello/api/organizations/:id Delete an organization
PUT /katello/api/organizations/:id/repo_discover Discover Repositories
PUT /katello/api/organizations/:label/cancel_repo_discover Cancel repository discovery
GET /katello/api/organizations/:label/download_debug_certificate Download a debug certificate
GET /katello/api/organizations/:id/releases List available releases in the organization
POST /katello/api/organizations/:id/autoattach_subscriptions DEPRECATED Auto-attach available subscriptions to all hosts within an organization. Asynchronous operation.
GET /katello/api/organizations/:id/redhat_provider List all :resource_id

Os default templates

Resource Description
GET /api/operatingsystems/:operatingsystem_id/os_default_templates List default templates combinations for an operating system
GET /api/config_templates/:config_template_id/os_default_templates List operating systems where this template is set as a default
GET /api/provisioning_templates/:provisioning_template_id/os_default_templates List operating systems where this template is set as a default
GET /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Show a default template combination for an operating system
POST /api/operatingsystems/:operatingsystem_id/os_default_templates Create a default template combination for an operating system
PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Update a default template combination for an operating system
DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Delete a default template combination for an operating system

Ostree branches

Resource Description
GET /katello/api/ostree_branches List ostree_branches
GET /katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches List ostree_branches
GET /katello/api/content_view_filters/:content_view_filter_id/ostree_branches List ostree_branches
GET /katello/api/repositories/:repository_id/ostree_branches List ostree_branches
GET /katello/api/ostree_branches/:id Show an ostree branch
GET /katello/api/repositories/:repository_id/ostree_branches/:id Show an ostree branch
GET /katello/api/ostree_branches/compare List ostree_branches

Override values

Resource Description
GET /api/smart_variables/:smart_variable_id/override_values List of override values for a specific smart variable
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values List of override values for a specific smart class parameter
GET /api/smart_variables/:smart_variable_id/override_values/:id Show an override value for a specific smart variable
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Show an override value for a specific smart class parameter
POST /api/smart_variables/:smart_variable_id/override_values Create an override value for a specific smart variable
POST /api/smart_class_parameters/:smart_class_parameter_id/override_values Create an override value for a specific smart class parameter
PUT /api/smart_variables/:smart_variable_id/override_values/:id Update an override value for a specific smart variable
PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Update an override value for a specific smart class parameter
DELETE /api/smart_variables/:smart_variable_id/override_values/:id Delete an override value for a specific smart variable
DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Delete an override value for a specific smart class parameter

Package groups

Resource Description
GET /katello/api/package_groups List package_groups
GET /katello/api/content_views/:content_view_id/filters/:filter_id/package_groups List package_groups
GET /katello/api/content_view_filters/:content_view_filter_id/package_groups List package_groups
GET /katello/api/repositories/:repository_id/package_groups List package_groups
GET /katello/api/package_groups/:id Show a package group
GET /katello/api/repositories/:repository_id/package_groups/:id Show a package group
GET /katello/api/package_groups/compare List package_groups
POST /katello/api/package_group Create a package group
DELETE /katello/api/package_group Delete a package group

Packages

Resource Description
GET /katello/api/packages List packages
GET /katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id List :resource_id
GET /katello/api/content_view_filters/:content_view_filter_id/:resource_id List :resource_id
GET /katello/api/repositories/:repository_id/:resource_id List :resource_id
GET /katello/api/packages/:id Show a package
GET /katello/api/repositories/:repository_id/packages/:id Show a package
GET /katello/api/packages/compare List packages

Parameters

Resource Description
GET /api/hosts/:host_id/parameters List all parameters for a host
GET /api/hostgroups/:hostgroup_id/parameters List all parameters for a host group
GET /api/domains/:domain_id/parameters List all parameters for a domain
GET /api/operatingsystems/:operatingsystem_id/parameters List all parameters for an operating system
GET /api/locations/:location_id/parameters List all parameters for a location
GET /api/organizations/:organization_id/parameters List all parameters for an organization
GET /api/subnets/:subnet_id/parameters List all parameters for a subnet
GET /api/hosts/:host_id/parameters/:id Show a nested parameter for a host
GET /api/hostgroups/:hostgroup_id/parameters/:id Show a nested parameter for a host group
GET /api/domains/:domain_id/parameters/:id Show a nested parameter for a domain
GET /api/operatingsystems/:operatingsystem_id/parameters/:id Show a nested parameter for an operating system
GET /api/locations/:location_id/parameters/:id Show a nested parameter for a location
GET /api/organizations/:organization_id/parameters/:id Show a nested parameter for an organization
GET /api/subnets/:subnet_id/parameters/:id Show a nested parameter for a subnet
POST /api/hosts/:host_id/parameters Create a nested parameter for a host
POST /api/hostgroups/:hostgroup_id/parameters Create a nested parameter for a host group
POST /api/domains/:domain_id/parameters Create a nested parameter for a domain
POST /api/operatingsystems/:operatingsystem_id/parameters Create a nested parameter for an operating system
POST /api/locations/:location_id/parameters Create a nested parameter for a location
POST /api/organizations/:organization_id/parameters Create a nested parameter for an organization
POST /api/subnets/:subnet_id/parameters Create a nested parameter for a subnet
PUT /api/hosts/:host_id/parameters/:id Update a nested parameter for a host
PUT /api/hostgroups/:hostgroup_id/parameters/:id Update a nested parameter for a host group
PUT /api/domains/:domain_id/parameters/:id Update a nested parameter for a domain
PUT /api/operatingsystems/:operatingsystem_id/parameters/:id Update a nested parameter for an operating system
PUT /api/locations/:location_id/parameters/:id Update a nested parameter for a location
PUT /api/organizations/:organization_id/parameters/:id Update a nested parameter for an organization
PUT /api/subnets/:subnet_id/parameters/:id Update a nested parameter for a subnet
DELETE /api/hosts/:host_id/parameters/:id Delete a nested parameter for a host
DELETE /api/hostgroups/:hostgroup_id/parameters/:id Delete a nested parameter for a host group
DELETE /api/domains/:domain_id/parameters/:id Delete a nested parameter for a domain
DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id Delete a nested parameter for an operating system
DELETE /api/locations/:location_id/parameters/:id Delete a nested parameter for a location
DELETE /api/organizations/:organization_id/parameters/:id Delete a nested parameter for an organization
DELETE /api/subnets/:subnet_id/parameters/:id Delete a nested parameter for a subnet
DELETE /api/hosts/:host_id/parameters Delete all nested parameters for a host
DELETE /api/hostgroups/:hostgroup_id/parameters Delete all nested parameters for a host group
DELETE /api/domains/:domain_id/parameters Delete all nested parameters for a domain
DELETE /api/operatingsystems/:operatingsystem_id/parameters Delete all nested parameters for an operating system
DELETE /api/locations/:location_id/parameters Delete all nested parameter for a location
DELETE /api/organizations/:organization_id/parameters Delete all nested parameter for an organization
DELETE /api/subnets/:subnet_id/parameters Delete all nested parameters for a subnet

Permissions

Resource Description
GET /api/permissions List all permissions
GET /api/permissions/:id Show a permission
GET /api/permissions/resource_types List available resource types

Personal access tokens

Resource Description
GET /api/users/:user_id/personal_access_tokens List all Personal Access Tokens for a user
GET /api/users/:user_id/personal_access_tokens/:id Show a Personal Access Token for a user
POST /api/users/:user_id/personal_access_tokens Create a Personal Access Token for a user
DELETE /api/users/:user_id/personal_access_tokens/:id Revoke a Personal Access Token for a user

Ping

Resource Description
GET /katello/api/ping Shows status of system and it's subcomponents
GET /katello/api/status Shows version information

Plugins

Resource Description
GET /api/plugins List installed plugins

Products

Resource Description
GET /katello/api/products List products
GET /katello/api/subscriptions/:subscription_id/products List of subscription products in a subscription
GET /katello/api/activation_keys/:activation_key_id/products List of subscription products in an activation key
GET /katello/api/organizations/:organization_id/products List of products in an organization
GET /katello/api/sync_plans/:sync_plan_id/products List of Products for sync plan
GET /katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products List of Products for sync plan
POST /katello/api/products Create a product
GET /katello/api/products/:id Show a product
PUT /katello/api/products/:id Updates a product
DELETE /katello/api/products/:id Destroy a product
POST /katello/api/products/:id/sync Sync all repositories for a product

Products bulk actions

Resource Description
PUT /katello/api/products/bulk/destroy Destroy one or more products
PUT /katello/api/products/bulk/sync Sync one or more products
PUT /katello/api/products/bulk/sync_plan Sync one or more products

Provisioning templates

Resource Description
GET /api/provisioning_templates List provisioning templates
GET /api/operatingsystems/:operatingsystem_id/provisioning_templates List provisioning templates per operating system
GET /api/locations/:location_id/provisioning_templates List provisioning templates per location
GET /api/organizations/:organization_id/provisioning_templates List provisioning templates per organization
GET /api/provisioning_templates/:id Show provisioning template details
POST /api/provisioning_templates Create a provisioning template
POST /api/provisioning_templates/import Import a provisioning template
PUT /api/provisioning_templates/:id Update a provisioning template
GET /api/provisioning_templates/revision
DELETE /api/provisioning_templates/:id Delete a provisioning template
POST /api/provisioning_templates/build_pxe_default Update the default PXE menu on all configured TFTP servers
POST /api/provisioning_templates/:id/clone Clone a provision template
GET /api/provisioning_templates/:id/export Export a provisioning template to ERB

Ptables

Resource Description
GET /api/ptables List all partition tables
GET /api/operatingsystems/:operatingsystem_id/ptables List all partition tables for an operating system
GET /api/locations/:location_id/ptables List all partition tables per location
GET /api/organizations/:organization_id/ptables List all partition tables per organization
GET /api/ptables/:id Show a partition table
POST /api/ptables Create a partition table
POST /api/ptables/import Import a provisioning template
GET /api/ptables/revision
PUT /api/ptables/:id Update a partition table
DELETE /api/ptables/:id Delete a partition table
POST /api/ptables/:id/clone Clone a template
GET /api/ptables/:id/export Export a partition template to ERB

Puppet hosts

Resource Description
PUT /api/hosts/:id/puppetrun Force a Puppet agent run on the host

Puppet modules

Resource Description
GET /katello/api/puppet_modules List puppet_modules
GET /katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules List puppet_modules
GET /katello/api/content_view_filters/:content_view_filter_id/puppet_modules List puppet_modules
GET /katello/api/repositories/:repository_id/puppet_modules List puppet_modules
GET /katello/api/puppet_modules/:id Show a puppet module
GET /katello/api/repositories/:repository_id/puppet_modules/:id Show a puppet module
GET /katello/api/puppet_modules/compare List puppet_modules

Puppetclasses

Resource Description
GET /api/puppetclasses List all Puppet classes
GET /api/hosts/:host_id/puppetclasses List all Puppet classes for a host
GET /api/hostgroups/:hostgroup_id/puppetclasses List all Puppet classes for a host group
GET /api/environments/:environment_id/puppetclasses List all Puppet classes for an environment
GET /api/puppetclasses/:id Show a Puppet class
GET /api/hosts/:host_id/puppetclasses/:id Show a Puppet class for host
GET /api/hostgroups/:hostgroup_id/puppetclasses/:id Show a Puppet class for a host group
GET /api/environments/:environment_id/puppetclasses/:id Show a Puppet class for an environment
POST /api/puppetclasses Create a Puppet class
PUT /api/puppetclasses/:id Update a Puppet class
DELETE /api/puppetclasses/:id Delete a Puppet class

Realms

Resource Description
GET /api/realms List of realms
GET /api/realms/:id Show a realm
POST /api/realms Create a realm
PUT /api/realms/:id Update a realm
DELETE /api/realms/:id Delete a realm

Recurring logics

Resource Description
GET /foreman_tasks/api/recurring_logics List recurring logics
GET /foreman_tasks/api/recurring_logics/:id Show recurring logic details
PUT /foreman_tasks/api/recurring_logics/:id Update recurring logic
POST /foreman_tasks/api/recurring_logics/:id/cancel Cancel recurring logic

Registries

Resource Description
GET /docker/api/v2/registries List all docker registries
GET /docker/api/v2/registries/:id Show a docker registry
POST /docker/api/v2/registries Create a docker registry
PUT /docker/api/v2/registries/:id Update a docker registry
DELETE /docker/api/v2/registries/:id Delete a docker registry

Report templates

Resource Description
GET /api/report_templates List all report templates
GET /api/locations/:location_id/report_templates List all report templates per location
GET /api/organizations/:organization_id/report_templates List all report templates per organization
GET /api/report_templates/:id Show a report template
POST /api/report_templates Create a report template
POST /api/report_templates/import Import a report template
GET /api/report_templates/revision
PUT /api/report_templates/:id Update a report template
DELETE /api/report_templates/:id Delete a report template
POST /api/report_templates/:id/clone Clone a template
GET /api/report_templates/:id/export Export a report template to ERB
POST /api/report_templates/:id/generate Generate a report template

Reports

Resource Description
GET /api/reports List all reports
GET /api/reports/:id Show a report
POST /api/reports Create a report
DELETE /api/reports/:id Delete a report
GET /api/hosts/:host_id/reports/last Show the last report for a host

Repositories

Resource Description
GET /katello/api/repositories List of enabled repositories
GET /katello/api/content_views/:id/repositories List of repositories for a content view
GET /katello/api/organizations/:organization_id/repositories List of repositories in an organization
GET /katello/api/organizations/:organization_id/environments/:environment_id/repositories List repositories in the environment
GET /katello/api/products/:product_id/repositories List of repositories for a product
GET /katello/api/environments/:environment_id/products/:product_id/repositories List of repositories belonging to a product in an environment
POST /katello/api/repositories Create a custom repository
GET /katello/api/repositories/repository_types Show the available repository types
PUT /katello/api/repositories/:id/republish Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.
GET /katello/api/repositories/:id Show a repository
POST /katello/api/repositories/:id/sync Sync a repository
POST /katello/api/repositories/:id/export Export a repository
PUT /katello/api/repositories/:id Update a repository
DELETE /katello/api/repositories/:id Destroy a custom repository
PUT /katello/api/repositories/:id/remove_packages
PUT /katello/api/repositories/:id/remove_docker_manifests
PUT /katello/api/repositories/:id/remove_puppet_modules
PUT /katello/api/repositories/:id/remove_content
POST /katello/api/repositories/:id/upload_content Upload content into the repository
PUT /katello/api/repositories/:id/import_uploads Import uploads into a repository
GET /katello/api/repositories/:id/gpg_key_content Return the content of a repo gpg key, used directly by yum

Repositories bulk actions

Resource Description
PUT /katello/api/repositories/bulk/destroy Destroy one or more repositories
POST /katello/api/repositories/bulk/sync Synchronize repository

Repository sets

Resource Description
GET /katello/api/repository_sets List repository sets.
GET /katello/api/products/:product_id/repository_sets List repository sets for a product.
GET /katello/api/repository_sets/:id Get info about a repository set
GET /katello/api/products/:product_id/repository_sets/:id Get info about a repository set
GET /katello/api/repository_sets/:id/available_repositories Get list of available repositories for the repository set
GET /katello/api/products/:product_id/repository_sets/:id/available_repositories Get list of available repositories for the repository set
PUT /katello/api/repository_sets/:id/enable Enable a repository from the set
PUT /katello/api/products/:product_id/repository_sets/:id/enable Enable a repository from the set
PUT /katello/api/repository_sets/:id/disable Disable a repository from the set
PUT /katello/api/products/:product_id/repository_sets/:id/disable Disable a repository from the set

Roles

Resource Description
GET /api/roles List all roles
GET /api/roles/:id Show a role
POST /api/roles Create a role
PUT /api/roles/:id Update a role
DELETE /api/roles/:id Delete a role
POST /api/roles/:id/clone Clone a role

Settings

Resource Description
GET /api/settings List all settings
GET /api/settings/:id Show a setting
PUT /api/settings/:id Update a setting

Smart class parameters

Resource Description
GET /api/smart_class_parameters List all smart class parameters
GET /api/hosts/:host_id/smart_class_parameters List of smart class parameters for a specific host
GET /api/hostgroups/:hostgroup_id/smart_class_parameters List of smart class parameters for a specific host group
GET /api/puppetclasses/:puppetclass_id/smart_class_parameters List of smart class parameters for a specific Puppet class
GET /api/environments/:environment_id/smart_class_parameters List of smart class parameters for a specific environment
GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters List of smart class parameters for a specific environment/Puppet class combination
GET /api/smart_class_parameters/:id Show a smart class parameter
PUT /api/smart_class_parameters/:id Update a smart class parameter

Smart proxies

Resource Description
POST /api/smart_proxies/:id/import_puppetclasses Import puppet classes from puppet proxy
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses Import puppet classes from puppet proxy for an environment
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses Import puppet classes from puppet proxy for an environment
GET /api/smart_proxies List all smart proxies
GET /api/smart_proxies/:id Show a smart proxy
POST /api/smart_proxies Create a smart proxy
PUT /api/smart_proxies/:id Update a smart proxy
DELETE /api/smart_proxies/:id Delete a smart proxy
PUT /api/smart_proxies/:id/refresh Refresh smart proxy features

Smart variables

Resource Description
GET /api/smart_variables List all smart variables
GET /api/hosts/:host_id/smart_variables List of smart variables for a specific host
GET /api/hostgroups/:hostgroup_id/smart_variables List of smart variables for a specific host group
GET /api/puppetclasses/:puppetclass_id/smart_variables List of smart variables for a specific Puppet class
GET /api/smart_variables/:id Show a smart variable
POST /api/smart_variables Create a smart variable
PUT /api/smart_variables/:id Update a smart variable
DELETE /api/smart_variables/:id Delete a smart variable

Ssh keys

Resource Description
GET /api/users/:user_id/ssh_keys List all SSH keys for a user
GET /api/users/:user_id/ssh_keys/:id Show an SSH key from a user
POST /api/users/:user_id/ssh_keys Add an SSH key for a user
DELETE /api/users/:user_id/ssh_keys/:id Delete an SSH key for a user

Statistics

Resource Description
GET /api/statistics Get statistics

Subnets

Resource Description
GET /api/subnets List of subnets
GET /api/domains/:domain_id/subnets List of subnets for a domain
GET /api/locations/:location_id/subnets List of subnets per location
GET /api/organizations/:organization_id/subnets List of subnets per organization
GET /api/subnets/:id Show a subnet
POST /api/subnets Create a subnet
PUT /api/subnets/:id Update a subnet
DELETE /api/subnets/:id Delete a subnet
GET /api/subnets/:id/freeip Provides an unused IP address in this subnet

Subscriptions

Resource Description
GET /katello/api/organizations/:organization_id/subscriptions List organization subscriptions
GET /katello/api/activation_keys/:activation_key_id/subscriptions List an activation key's subscriptions
GET /katello/api/subscriptions
GET /katello/api/organizations/:organization_id/subscriptions/:id Show a subscription
GET /katello/api/subscriptions/:id Show a subscription
POST /katello/api/activation_keys/:activation_key_id/subscriptions DEPRECATED Add a subscription to an activation key
POST /katello/api/organizations/:organization_id/subscriptions/upload Upload a subscription manifest
PUT /katello/api/organizations/:organization_id/subscriptions/refresh_manifest Refresh previously imported manifest for Red Hat provider
POST /katello/api/organizations/:organization_id/subscriptions/delete_manifest Delete manifest from Red Hat provider
GET /katello/api/organizations/:organization_id/subscriptions/manifest_history obtain manifest history for subscriptions

Sync

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

Sync plans

Resource Description
GET /katello/api/sync_plans List sync plans
GET /katello/api/organizations/:organization_id/sync_plans
GET /katello/api/organizations/:organization_id/sync_plans/:id Show a sync plan
GET /katello/api/sync_plans/:id Show a sync plan
POST /katello/api/organizations/:organization_id/sync_plans Create a sync plan
PUT /katello/api/organizations/:organization_id/sync_plans/:id Update a sync plan
PUT /katello/api/sync_plans/:id Update a sync plan
DELETE /katello/api/organizations/:organization_id/sync_plans/:id Destroy a sync plan
DELETE /katello/api/sync_plans/:id Destroy a sync plan
PUT /katello/api/organizations/:organization_id/sync_plans/:id/add_products Add products to sync plan
PUT /katello/api/organizations/:organization_id/sync_plans/:id/remove_products Remove products from sync plan
PUT /katello/api/sync_plans/:id/sync Initiate a sync of the products attached to the sync plan
PUT /katello/api/organizations/:organization_id/sync_plans/:id/sync Initiate a sync of the products attached to the sync plan

Table preferences

Resource Description
GET /api/users/:user_id/table_preferences List of table preferences for a user
GET /api/users/:user_id/table_preferences/:name Table preference details of a given table
POST /api/users/:user_id/table_preferences Creates a table preference for a given table
PUT /api/users/:user_id/table_preferences/:name Updates a table preference for a given table
DELETE /api/users/:user_id/table_preferences/:name Delete a table preference for a given table

Tasks

Resource Description
GET /api/orchestration/:id/tasks List all tasks for a given orchestration event

Template combinations

Resource Description
GET /api/config_templates/:config_template_id/template_combinations DEPRECATED List template combination
GET /api/provisioning_templates/:provisioning_template_id/template_combinations List template combination
GET /api/hostgroups/:hostgroup_id/template_combinations List template combination
GET /api/environments/:environment_id/template_combinations List template combination
POST /api/config_templates/:config_template_id/template_combinations DEPRECATED Add a template combination
POST /api/provisioning_templates/:provisioning_template_id/template_combinations Add a template combination
POST /api/hostgroups/:hostgroup_id/template_combinations Add a template combination
POST /api/environments/:environment_id/template_combinations Add a template combination
GET /api/template_combinations/:id Show template combination
GET /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED Show template combination
GET /api/provisioning_templates/:provisioning_template_id/template_combinations/:id Show template combination
GET /api/hostgroups/:hostgroup_id/template_combinations/:id Show template combination
GET /api/environments/:environment_id/template_combinations/:id Show template combination
PUT /api/provisioning_templates/:provisioning_template_id/template_combinations/:id Update template combination
PUT /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED Update template combination
PUT /api/hostgroups/:hostgroup_id/template_combinations/:id Update template combination
PUT /api/environments/:environment_id/template_combinations/:id Update template combination
DELETE /api/template_combinations/:id Delete a template combination

Template inputs

Resource Description
GET /api/templates/:template_id/template_inputs List template inputs
GET /api/templates/:template_id/template_inputs/:id Show template input details
POST /api/templates/:template_id/template_inputs Create a template input
DELETE /api/templates/:template_id/template_inputs/:id Delete a template input
PUT /api/templates/:template_id/template_inputs/:id Update a template input

Template kinds

Resource Description
GET /api/template_kinds List all template kinds

Trends

Resource Description
GET /api/trends List of trends counters
GET /api/trends/:id Show a trend
POST /api/trends Create a trend counter
DELETE /api/trends/:id Delete a trend counter

Upstream subscriptions

Resource Description
GET /katello/api/organizations/:organization_id/upstream_subscriptions List available subscriptions from Red Hat Subscription Management
PUT /katello/api/organizations/:organization_id/upstream_subscriptions Update the quantity of one or more subscriptions on an upstream allocation
DELETE /katello/api/organizations/:organization_id/upstream_subscriptions Remove one or more subscriptions from an upstream subscription allocation
POST /katello/api/organizations/:organization_id/upstream_subscriptions Add subscriptions consumed by a manifest from Red Hat Subscription Management

Usergroups

Resource Description
GET /api/usergroups List all user groups
GET /api/usergroups/:id Show a user group
POST /api/usergroups Create a user group
PUT /api/usergroups/:id Update a user group
DELETE /api/usergroups/:id Delete a user group

Users

Resource Description
GET /api/users List all users
GET /api/auth_source_ldaps/:auth_source_ldap_id/users List all users for LDAP authentication source
GET /api/auth_source_externals/:auth_source_external_id/users List all users for external authentication source
GET /api/usergroups/:usergroup_id/users List all users for user group
GET /api/roles/:role_id/users List all users for role
GET /api/locations/:location_id/users List all users for location
GET /api/organizations/:organization_id/users List all users for organization
GET /api/users/:id Show a user
POST /api/users Create a user
PUT /api/users/:id Update a user
DELETE /api/users/:id Delete a user