DELETE /api/hosts/bulk { "search": "id ^ (980190962,298486374)", "hosts_bulk_action": { "search": "id ^ (980190962,298486374)" } } 200 { "message": "Deleted 2 hosts" }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Hosts to include in the action Validations:
|
included[search]
optional , nil allowed |
Search string describing which hosts to perform the action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform the action on Validations:
|
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:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not perform the action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
host_collection_ids
required |
List of host collection ids Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
host_collection_ids
required |
List of host collection ids Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
subscriptions
optional |
Array of subscriptions to remove Validations:
|
subscriptions[id]
required |
Subscription Pool id Validations:
|
subscriptions[quantity]
optional |
Quantity of specified subscription to remove Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
subscriptions
required |
Array of subscriptions to add Validations:
|
subscriptions[id]
required |
Subscription Pool id Validations:
|
subscriptions[quantity]
required |
Quantity of this subscriptions to add Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
content_overrides
optional |
Array of Content override parameters Validations:
|
content_overrides[content_label]
required |
Label of the content Validations:
|
content_overrides[value]
optional |
Override value. Provide a boolean value if name is 'enabled' Validations:
|
content_overrides[name]
optional |
Override key or name. Note if name is not provided the default name will be 'enabled' Validations:
|
content_overrides[remove]
optional |
Set true to remove an override and reset it to 'default' Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
environment_id
optional |
Validations:
|
content_view_id
optional |
Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
release_version
optional |
content release version Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
trace_ids
required |
Array of Trace IDs Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
service_level
optional |
Service level of host Validations:
|
purpose_role
optional |
Role of host Validations:
|
purpose_usage
optional |
Usage of host Validations:
|
purpose_addons
optional |
Sets the system add-ons Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
errata_ids
required |
List of Errata ids Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
required |
ID of the organization Validations:
|
included
required |
Validations:
|
included[search]
optional , nil allowed |
Search string for hosts to perform an action on Validations:
|
included[ids]
optional , nil allowed |
List of host ids to perform an action on Validations:
|
excluded
required |
Validations:
|
excluded[ids]
optional , nil allowed |
List of host ids to exclude and not run an action on Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
host_ids
required |
The ids of the hosts to alter. Hosts not managed by Katello are ignored Validations:
|
environment_id
required |
The id of the lifecycle environment Validations:
|
content_view_id
required |
The id of the content view Validations:
|
content_source_id
required |
The id of the content source Validations:
|