Common parameters

>>>

GET /api/common_parameters
List all global parameters

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

filtrera resultat

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

antal poster per begäran

Validations:

  • Must be a String

Search fields

Field name Typ 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:

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

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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[hidden_value]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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[hidden_value]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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:

  • Must be a Integer
organization_id
Optional

Scope by organizations

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.