Examples

PUT /api/hosts/bulk/content_overrides
{
  "included": {
    "ids": [
      980191157,
      980191158
    ]
  },
  "organization_id": 114267492,
  "content_overrides": [
    {
      "content_label": "some-content",
      "value": 1
    },
    {
      "content_label": "some-content2",
      "value": "default"
    }
  ],
  "hosts_bulk_action": {
    "included": {
      "ids": [
        980191157,
        980191158
      ]
    },
    "organization_id": 114267492,
    "content_overrides": [
      {
        "content_label": "some-content",
        "value": 1
      },
      {
        "content_label": "some-content2",
        "value": "default"
      }
    ]
  }
}
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

content_overrides
optional

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
required

Label of the content

Validations:

  • String

content_overrides[value]
optional

Override value. Provide a boolean value if name is 'enabled'

Validations:

  • String

content_overrides[name]
optional

Override key or name. Note if name is not provided the default name will be 'enabled'

Validations:

  • String

content_overrides[remove]
optional

Set true to remove an override and reset it to 'default'

Validations:

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