Examples

GET /api/operatingsystems
200
{
  "total": 8,
  "subtotal": 8,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "major": "5",
      "minor": "3",
      "family": "Redhat",
      "release_name": null,
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 309172073,
      "name": "centos",
      "title": "centos 5.3"
    },
    {
      "description": null,
      "major": "5",
      "minor": "17",
      "family": "VRP",
      "release_name": null,
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 32055736,
      "name": "Huawei_VRP",
      "title": "Huawei VRP 5"
    },
    {
      "description": null,
      "major": "1",
      "minor": "1",
      "family": "Redhat",
      "release_name": null,
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 775246587,
      "name": "NoHosts",
      "title": "NoHosts 1.1"
    },
    {
      "description": null,
      "major": "12",
      "minor": "3",
      "family": "Suse",
      "release_name": null,
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 750842046,
      "name": "OpenSuse",
      "title": "OpenSuSE 12.3"
    },
    {
      "description": "RHEL 6.1",
      "major": "6",
      "minor": "1",
      "family": "Redhat",
      "release_name": null,
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 1073012828,
      "name": "Redhat",
      "title": "RHEL 6.1"
    },
    {
      "description": null,
      "major": "5",
      "minor": "10",
      "family": "Solaris",
      "release_name": "hw0910",
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 442321401,
      "name": "Solaris",
      "title": "Solaris 5.10"
    },
    {
      "description": null,
      "major": "10",
      "minor": "10",
      "family": "Debian",
      "release_name": "rn10",
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 331303656,
      "name": "Ubuntu",
      "title": "Ubuntu 10.10"
    },
    {
      "description": null,
      "major": "12",
      "minor": "10",
      "family": "Debian",
      "release_name": "rn10",
      "password_hash": "SHA256",
      "created_at": "2022-09-06 15:04:25 UTC",
      "updated_at": "2022-09-06 15:04:25 UTC",
      "id": 272342666,
      "name": "Ubuntu",
      "title": "Ubuntu 12.10"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

architecture_id
optional

ID of architecture

Validations:

  • Must be a String

medium_id
optional

ID of medium

Validations:

  • Must be a String

ptable_id
optional

ID of partition table

Validations:

  • Must be a String

provisioning_template_id
optional

ID of template

Validations:

  • Must be a String

os_parameters_attributes
optional

Array of parameters

Validations:

  • Must be an Array of nested elements

os_parameters_attributes[name]
required

Name of the parameter

Validations:

  • Must be a String

os_parameters_attributes[value]
required

Parameter value

Validations:

  • Must be a String

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
architecture string
description string
family string
id integer
major string
medium string
minor string
name string
params string
template string
title string