Examples

GET /api/domains/22495316-mydomain-net/parameters
200
{
  "total": 2,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = parameter2",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 30,
      "created_at": "2019-11-07 08:37:11 UTC",
      "updated_at": "2019-11-07 08:37:11 UTC",
      "id": 767575490,
      "name": "parameter2",
      "parameter_type": "string",
      "value": "X"
    }
  ]
}

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be a String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String

show_hidden
Optional

Display hidden values

Validations:

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

search
Optional

filter results

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id 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

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
domain_name string
host_group_name string
host_name string
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text