GET /api/common_parameters
List all global parameters

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

Examples

GET /api/common_parameters/636252244-test
200
{
  "created_at": "2019-11-07 08:32:17 UTC",
  "updated_at": "2019-11-07 08:32:17 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 636252244,
  "name": "test",
  "parameter_type": "string",
  "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.

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) 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:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

common_parameter
required

Validations:

  • Must be a Hash

common_parameter[name]
required

Validations:

  • Must be a String

common_parameter[value]
required

Validations:

  • Must be a 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:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

common_parameter
required

Validations:

  • Must be a Hash

common_parameter[name]
optional

Validations:

  • Must be a String

common_parameter[value]
optional

Validations:

  • Must be a 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:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.