These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for global parameters, go to this link.


GET /api/hosts/:host_id/parameters
Alle Parameter für einen Host auflisten

GET /api/hostgroups/:hostgroup_id/parameters
Alle Parameter für eine Hostgruppe auflisten

GET /api/domains/:domain_id/parameters
Alle Parameter für eine Domäne auflisten

GET /api/operatingsystems/:operatingsystem_id/parameters
Alle Parameter für ein Betriebssystem auflisten

GET /api/locations/:location_id/parameters
Alle Parameter für einen Standort auflisten

GET /api/organizations/:organization_id/parameters
Alle Parameter für eine Organisation auflisten

GET /api/subnets/:subnet_id/parameters
Alle Parameter für ein Subnetz auflisten

Beispiele

GET /api/domains/22495316-mydomain-net/parameters
200
{
  "total": 2,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = parameter2",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 30,
      "created_at": "2019-11-07 08:37:11 UTC",
      "updated_at": "2019-11-07 08:37:11 UTC",
      "id": 767575490,
      "name": "parameter2",
      "parameter_type": "string",
      "value": "X"
    }
  ]
}

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String

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 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/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host anzeigen

GET /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe anzeigen

GET /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne anzeigen

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem anzeigen

GET /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort anzeigen

GET /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation anzeigen

GET /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz anzeigen

Beispiele

GET /api/hosts/host343/parameters/767575241-parameter7
200
{
  "priority": 70,
  "created_at": "2019-11-07 08:37:01 UTC",
  "updated_at": "2019-11-07 08:37:01 UTC",
  "id": 767575241,
  "name": "parameter7",
  "parameter_type": "string",
  "value": "parameter value 21"
}

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String

id
verpflichtend

Parameterkennung

Validations:

  • Must be a String

show_hidden
optional

Versteckte Werte anzeigen

Validations:

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


POST /api/hosts/:host_id/parameters
Verschachtelten Parameter für einen Host erstellen

POST /api/hostgroups/:hostgroup_id/parameters
Verschachtelten Parameter für eine Hostgruppe erstellen

POST /api/domains/:domain_id/parameters
Verschachtelten Parameter für eine Domäne erstellen

POST /api/operatingsystems/:operatingsystem_id/parameters
Verschachtelten Parameter für ein Betriebssystem erstellen

POST /api/locations/:location_id/parameters
Verschachtelten Parameter für einen Standort erstellen

POST /api/organizations/:organization_id/parameters
Verschachtelten Parameter für eine Organisation erstellen

POST /api/subnets/:subnet_id/parameters
Verschachtelten Parameter für ein Subnetz erstellen

Beispiele

POST /api/domains/22495316-mydomain-net/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 30,
  "created_at": "2019-11-07 08:37:11 UTC",
  "updated_at": "2019-11-07 08:37:11 UTC",
  "id": 767575490,
  "name": "parameter2",
  "parameter_type": "string",
  "value": "X"
}

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String

parameter
verpflichtend

Validations:

  • Must be a Hash

parameter[name]
verpflichtend

Validations:

  • Must be a String

parameter[value]
verpflichtend

Validations:

  • Must be a String

parameter[parameter_type]
verpflichtend

Typ des Wertes

Validations:

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


PUT /api/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host aktualisieren

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe aktualisieren

PUT /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne aktualisieren

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem aktualisieren

PUT /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort aktualisieren

PUT /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation aktualisieren

PUT /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz aktualisieren

Beispiele

PUT /api/subnets/1018350795-five/parameters/297943576-parameter
{
  "parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "priority": null,
  "created_at": "2019-11-07 09:09:56 UTC",
  "updated_at": "2019-11-07 09:09:59 UTC",
  "id": 297943576,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

id
verpflichtend

Parameterkennung

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String

parameter
verpflichtend

Validations:

  • Must be a Hash

parameter[name]
optional

Validations:

  • Must be a String

parameter[value]
optional

Validations:

  • Must be a String

parameter[parameter_type]
optional

Typ des Wertes

Validations:

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


DELETE /api/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host löschen

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe löschen

DELETE /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne löschen

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem löschen

DELETE /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort löschen

DELETE /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation löschen

DELETE /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz löschen

Beispiele

DELETE /api/hostgroups/636252244-Common/parameters/767575238-group1
{
  "parameter": {}
}
200
{
  "id": 767575238,
  "name": "group1",
  "value": "group1",
  "reference_id": 636252244,
  "created_at": "2019-11-07T09:09:56.749Z",
  "updated_at": "2019-11-07T09:09:56.749Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_value": "group1"
}

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

id
verpflichtend

Parameterkennung

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Alle verschachtelten Parameter für einen Host löschen

DELETE /api/hostgroups/:hostgroup_id/parameters
Alle verschachtelten Parameter für eine Hostgruppe löschen

DELETE /api/domains/:domain_id/parameters
Alle verschachtelten Parameter für eine Domäne löschen

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Alle verschachtelten Parameter für ein Betriebssystem löschen

DELETE /api/locations/:location_id/parameters
Alle verschachtelten Parameter für einen Standort löschen

DELETE /api/organizations/:organization_id/parameters
Alle verschachtelten Parameter für eine Organisation löschen

DELETE /api/subnets/:subnet_id/parameters
Alle verschachtelten Parameter für ein Subnetz löschen

Beispiele

DELETE /api/hosts/host2698/parameters
{
  "parameter": {}
}
200
[

]

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String