Examples

GET /api/common_parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2018-07-24 12:59:59 UTC",
      "updated_at": "2018-07-24 12:59:59 UTC",
      "hidden_value?": false,
      "hidden_value": "*****",
      "id": 636252244,
      "name": "test",
      "value": "myvalue"
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Type Possible values
domain_name string
host_group_name string
host_name string
location_name string
name string
organization_name string
os_name string
subnet_name text
type string
value text