GET /api/common_parameters
Listar todos os parâmetros globais

Exemplos

GET /api/common_parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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"
    }
  ]
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden
opcional

Exibir valores ocultos

Validations:

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

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
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
Mostrar um parâmetro global

Exemplos

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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden
opcional

Exibir valores ocultos

Validations:

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

id
requerido

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
Criar um parâmetro global

Exemplos

POST /api/common_parameters
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
201
{
  "created_at": "2019-11-07 08:32:20 UTC",
  "updated_at": "2019-11-07 08:32:20 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 767575239,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

common_parameter
requerido

Validations:

  • Must be a Hash

common_parameter[name]
requerido

Validations:

  • Must be a String

common_parameter[value]
requerido

Validations:

  • Must be a String

common_parameter[parameter_type]
requerido

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

common_parameter[hidden_value]
opcional , nulo permitido

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
Atualizar um parâmetro global

Exemplos

PUT /api/common_parameters/636252244-test
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "created_at": "2019-11-07 08:32:17 UTC",
  "updated_at": "2019-11-07 08:32:20 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 636252244,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

common_parameter[name]
opcional

Validations:

  • Must be a String

common_parameter[value]
opcional

Validations:

  • Must be a String

common_parameter[parameter_type]
opcional

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

common_parameter[hidden_value]
opcional , nulo permitido

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
Apagar um parâmetro global

Exemplos

DELETE /api/common_parameters/636252244-test
{
  "common_parameter": {}
}
200
{
  "id": 636252244,
  "name": "test",
  "value": "myvalue",
  "reference_id": null,
  "created_at": "2019-11-07T08:32:17.727Z",
  "updated_at": "2019-11-07T08:32:17.727Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_value": "myvalue"
}

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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