Host_module_streams

>>>

GET /api/hosts/:host_id/module_streams
List module streams available to the host

Examples

GET /api/hosts/980190962/module_streams
200
{
  "total": 3,
  "subtotal": 3,
  "selectable": 3,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "status": "enabled",
      "installed_profiles": null,
      "upgradable": false,
      "install_status": "Not installed",
      "id": 62347170,
      "name": "Ohio",
      "stream": "noitsariver",
      "module_spec": "Ohio:noitsariver"
    },
    {
      "status": "enabled",
      "installed_profiles": [
        "default"
      ],
      "upgradable": false,
      "install_status": "Up-to-date",
      "id": 53289001,
      "name": "one",
      "stream": "noitsariver",
      "module_spec": "one:noitsariver"
    },
    {
      "status": "disabled",
      "installed_profiles": null,
      "upgradable": false,
      "install_status": "Not installed",
      "id": 680209599,
      "name": "two",
      "stream": "noitsariver",
      "module_spec": "two:noitsariver"
    }
  ]
}

Params

Param name Description
host_id
required

ID of the host

Validations:

  • Must be a number.
status
optional

Streams based on the host based on their status

Validations:

  • Must be one of: enabled, disabled, unknown, installed, upgradable.
install_status
optional

Streams based on the host based on the installation status

Validations:

  • String
search
optional

Search string

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String
full_result
optional

Whether or not to show all results

Validations:

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

Field to sort the results on

Validations:

  • String
sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String