Examples

PUT /api/hosts/bulk/remove_subscriptions
{
  "organization_id": 114267492,
  "included": {
    "ids": [
      980191169,
      980191170
    ]
  },
  "subscriptions": [
    {
      "id": 128914721,
      "quantity": 1
    }
  ],
  "hosts_bulk_action": {
    "organization_id": 114267492,
    "included": {
      "ids": [
        980191169,
        980191170
      ]
    },
    "subscriptions": [
      {
        "id": 128914721,
        "quantity": 1
      }
    ]
  }
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

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

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