GET /api/common_parameters
List all global parameters

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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 results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • 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

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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

common_parameter
required

Validations:

  • Hash

common_parameter[name]
required

Validations:

  • String

common_parameter[value]
required

Validations:

  • String

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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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[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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

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