Hosts_bulk_actions

>>>

DELETE /api/hosts/bulk
Delete multiple hosts

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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/build
Build

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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
reboot
optional

Reboot after build. Ignored if rebuild_configuration is passed.

Validations:

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

Rebuild configuration only

Validations:

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

PUT /api/hosts/bulk/reassign_hostgroups
Reassign hostgroups

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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
hostgroup_id
optional

ID of the hostgroup to reassign the hosts to

Validations:

  • Must be a number.
>>>

PUT /api/hosts/bulk/change_owner
Change owner

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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
owner_id
required

ID of the owner to reassign the hosts to

Validations:

  • Must be a number.
>>>

PUT /api/hosts/bulk/disassociate
Disassociate compute resources

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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/assign_organization
Assign organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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
id
required

The organization ID to assign the hosts to

Validations:

  • Must be a number.
mismatch_setting
required

Fix organization on mismatch

Validations:

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

PUT /api/hosts/bulk/assign_location
Assign location

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
required

ID of the organization

Validations:

  • Must be a number.
included
required

Hosts to include in the action

Validations:

  • Must be a Hash
included[search]
optional , nil allowed

Search string describing which hosts to perform the action on

Validations:

  • Must be a 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:

  • Must be a 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
id
required

The location ID to assign the hosts to

Validations:

  • Must be a number.
mismatch_setting
required

Fix location on mismatch

Validations:

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