Common parameters

>>>

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": "2021-05-18 15:42:44 UTC",
      "updated_at": "2021-05-18 15:42:44 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.
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, ‘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

Examples

GET /api/common_parameters/636252244-test
200
{
  "created_at": "2021-05-18 15:42:44 UTC",
  "updated_at": "2021-05-18 15:42:44 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

Examples

POST /api/common_parameters
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
201
{
  "created_at": "2021-05-18 15:42:55 UTC",
  "updated_at": "2021-05-18 15:42:55 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 767575239,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

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

Examples

PUT /api/common_parameters/636252244-test
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "created_at": "2021-05-18 15:42:44 UTC",
  "updated_at": "2021-05-18 15:42:55 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 636252244,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

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

Examples

DELETE /api/common_parameters/636252244-test
{
  "common_parameter": {}
}
200
{
  "id": 636252244,
  "name": "test",
  "value": "myvalue",
  "reference_id": null,
  "created_at": "2021-05-18T15:42:44.325Z",
  "updated_at": "2021-05-18T15:42:44.325Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_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
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.