DELETE /api/hosts/bulk
Delete multiple hosts

Examples

DELETE /api/hosts/bulk
{
  "search": "id ^ (980190962,298486374)",
  "hosts_bulk_action": {
    "search": "id ^ (980190962,298486374)"
  }
}
200
{
  "message": "Deleted 2 hosts"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Hosts to include in the action

Validations:

  • Hash

included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform the action on

Validations:

  • Must be an array of any type

excluded
required

Hosts to explicitly exclude in the action. All other hosts will be included in the action, unless an included parameter is passed as well.

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not perform the action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/add_host_collections
Add one or more host collections to one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

host_collection_ids
required

List of host collection ids

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/remove_host_collections
Remove one or more host collections from one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

host_collection_ids
required

List of host collection ids

Validations:

  • Must be an array of any type


POST /api/hosts/bulk/applicable_errata
Fetch applicable errata for one or more hosts.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


POST /api/hosts/bulk/installable_errata
Fetch installable errata for one or more hosts.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/destroy
Destroy one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/remove_subscriptions
Remove subscriptions from one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

subscriptions
optional

Array of subscriptions to remove

Validations:

  • Must be an Array of nested elements

subscriptions[id]
required

Subscription Pool id

Validations:

  • String

subscriptions[quantity]
optional

Quantity of specified subscription to remove

Validations:

  • Integer


PUT /api/hosts/bulk/add_subscriptions
Add subscriptions to one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

subscriptions
required

Array of subscriptions to add

Validations:

  • Must be an Array of nested elements

subscriptions[id]
required

Subscription Pool id

Validations:

  • String

subscriptions[quantity]
required

Quantity of this subscriptions to add

Validations:

  • Must be a number.


PUT /api/hosts/bulk/auto_attach
Trigger an auto-attach of subscriptions on one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/content_overrides
Set content overrides to one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

content_overrides
optional

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
required

Label of the content

Validations:

  • String

content_overrides[value]
optional

Override value. Provide a boolean value if name is 'enabled'

Validations:

  • String

content_overrides[name]
optional

Override key or name. Note if name is not provided the default name will be 'enabled'

Validations:

  • String

content_overrides[remove]
optional

Set true to remove an override and reset it to 'default'

Validations:

  • Must be one of: true, false, 1, 0.


PUT /api/hosts/bulk/environment_content_view
Assign the environment and content view to one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

environment_id
optional

Validations:

  • Integer

content_view_id
optional

Validations:

  • Integer


PUT /api/hosts/bulk/release_version
Assign the release version to one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

release_version
optional

content release version

Validations:

  • String


POST /api/hosts/bulk/traces
Fetch traces for one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/resolve_traces
Resolve traces for one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

trace_ids
required

Array of Trace IDs

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/system_purpose
Assign system purpose attributes on one or more hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

service_level
optional

Service level of host

Validations:

  • String

purpose_role
optional

Role of host

Validations:

  • String

purpose_usage
optional

Usage of host

Validations:

  • String

purpose_addons
optional

Sets the system add-ons

Validations:

  • Must be an array of any type


POST /api/hosts/bulk/available_incremental_updates
Given a set of hosts and errata, lists the content view versions and environments that need updating.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type

errata_ids
required

List of Errata ids

Validations:

  • Must be an array of any type


POST /api/hosts/bulk/module_streams
Fetch available module streams for hosts.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
required

ID of the organization

Validations:

  • Must be a number.

included
required

Validations:

  • Hash

included[search]
optional , nil allowed

Search string for hosts to perform an action on

Validations:

  • String

included[ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type

excluded
required

Validations:

  • Hash

excluded[ids]
optional , nil allowed

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type


PUT /api/hosts/bulk/change_content_source
Update the content source for specified hosts and generate the reconfiguration script

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

host_ids
required

The ids of the hosts to alter. Hosts not managed by Katello are ignored

Validations:

  • Must be an array of any type

environment_id
required

The id of the lifecycle environment

Validations:

  • Must be a number.

content_view_id
required

The id of the content view

Validations:

  • Must be a number.

content_source_id
required

The id of the content source

Validations:

  • Must be a number.