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

Examples

PUT /api/hosts/bulk/remove_host_collections
{
  "included": {
    "ids": [
      980191237,
      980191238
    ]
  },
  "organization_id": 114267492,
  "host_collection_ids": [
    992660475,
    1031461452
  ],
  "hosts_bulk_action": {
    "included": {
      "ids": [
        980191237,
        980191238
      ]
    },
    "organization_id": 114267492,
    "host_collection_ids": [
      992660475,
      1031461452
    ]
  }
}
200
{
  "displayMessages": [
    "Successfully removed 1 content host(s) from host collection Simple Host Collection.",
    "Successfully removed 0 content host(s) from host collection Another Simple Host Collection."
  ]
}

Params

Param name Description
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