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