Common parameters

>>>

GET /api/common_parameters
Alle globalen Parameter auflisten

Parameter

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

Versteckte Werte anzeigen

Validations:

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

Ergebnisse filtern

Validations:

  • Must be a String
order
optional

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • Must be a String
page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.
per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
domain_name
host_group_name
host_name
key_type
location_name
name
organization_name
os_name
parameter_type
subnet_name
type
value
>>>

GET /api/common_parameters/:id
Globalen Parameter anzeigen

Parameter

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

Versteckte Werte anzeigen

Validations:

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

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
Globale Parameter erstellen

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

  • Must be a Hash
common_parameter[name]
verpflichtend

Validations:

  • Must be a String
common_parameter[value]
verpflichtend

Validations:

  • Must be a String
common_parameter[parameter_type]
verpflichtend

Typ des Wertes

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
optional , nil erlaubt

Validations:

  • Must be one of: true, false.
>>>

PUT /api/common_parameters/:id
Globalen Parameter aktualisieren

Parameter

Parametername Beschreibung
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
verpflichtend

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
verpflichtend

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

Typ des Wertes

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
optional , nil erlaubt

Validations:

  • Must be one of: true, false.
>>>

DELETE /api/common_parameters/:id
Globalen Parameter löschen

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

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