Common parameters

>>>

GET /api/common_parameters
List all global parameters

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
show_hidden
optional

Display hidden values

Validations:

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

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • 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
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text
>>>

GET /api/common_parameters/:id
Show a global parameter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
show_hidden
optional

Display hidden values

Validations:

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

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
>>>

POST /api/common_parameters
Create a global parameter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
common_parameter
required

Validations:

  • Hash
common_parameter[name]
required

Validations:

  • String
common_parameter[value]
required

Validations:

  • String
common_parameter[parameter_type]
required

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.
>>>

PUT /api/common_parameters/:id
Update a global parameter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
common_parameter
required

Validations:

  • Hash
common_parameter[name]
optional

Validations:

  • String
common_parameter[value]
optional

Validations:

  • String
common_parameter[parameter_type]
optional

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.
>>>

DELETE /api/common_parameters/:id
Delete a global parameter

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..