GET /api/common_parameters
List all global parameters

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-11-16 10:02:08 UTC",
      "updated_at": "2018-11-16 10:02:08 UTC",
      "hidden_value?": false,
      "hidden_value": "*****",
      "id": 636252244,
      "name": "test",
      "value": "myvalue"
    }
  ]
}

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
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 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
domain_name string
host_group_name string
host_name string
id integer
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text