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
Afficher tous les paramètres d'un hôte

GET /api/hostgroups/:hostgroup_id/parameters
Afficher tous les paramètres d'un groupe d'hôtes

GET /api/domains/:domain_id/parameters
Afficher tous les paramètres d'un domaine

GET /api/operatingsystems/:operatingsystem_id/parameters
Afficher tous les paramètres d'un système d'exploitation

GET /api/locations/:location_id/parameters
Afficher tous les paramètres d'un emplacement

GET /api/organizations/:organization_id/parameters
Afficher tous les paramètres d'une organisation

GET /api/subnets/:subnet_id/parameters
Lister tous les paramètres pour le sous-réseaux

Exemples

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

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String

show_hidden
optionel

Afficher les valeurs masquées

Validations:

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

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

Champ et sens de tri, ex: ‘id DESC’

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
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
Afficher un paramètre imbriqué pour un hôte

GET /api/hostgroups/:hostgroup_id/parameters/:id
Afficher un paramètre imbriqué pour un groupe d'hôtes

GET /api/domains/:domain_id/parameters/:id
Afficher un paramètre imbriqué pour un domaine

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Afficher un paramètre imbriqué pour un système d'exploitation

GET /api/locations/:location_id/parameters/:id
Afficher un paramètre imbriqué pour un emplacement

GET /api/organizations/:organization_id/parameters/:id
Afficher un paramètre imbriqué pour une organisation

GET /api/subnets/:subnet_id/parameters/:id
Afficher un paramètre imbriqué pour un sous-réseaux

Exemples

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

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String

id
requis

ID du paramêtre

Validations:

  • Must be a String

show_hidden
optionel

Afficher les valeurs masquées

Validations:

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


POST /api/hosts/:host_id/parameters
Créer un paramètre imbriqué pour un hôte

POST /api/hostgroups/:hostgroup_id/parameters
Créer un paramètre imbriqué pour un groupe d'hôtes

POST /api/domains/:domain_id/parameters
Créer un paramètre imbriqué pour un domaine

POST /api/operatingsystems/:operatingsystem_id/parameters
Créer un paramètre imbriqué pour un système d'exploitation

POST /api/locations/:location_id/parameters
Créer un paramètre imbriqué pour un emplacement

POST /api/organizations/:organization_id/parameters
Créer un paramètre imbriqué pour une organisation

POST /api/subnets/:subnet_id/parameters
Créer un paramètre imbriqué pour un sous-réseaux

Exemples

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

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String

parameter
requis

Validations:

  • Must be a Hash

parameter[name]
requis

Validations:

  • Must be a String

parameter[value]
requis

Validations:

  • Must be a String

parameter[parameter_type]
requis

Type de valeur

Validations:

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


PUT /api/hosts/:host_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour un hôte

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour un groupe d'hôtes

PUT /api/domains/:domain_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour un domaine

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour un système d'exploitation

PUT /api/locations/:location_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour un emplacement

PUT /api/organizations/:organization_id/parameters/:id
Mise à jour d'un paramètre imbriqué pour une organisation

PUT /api/subnets/:subnet_id/parameters/:id
Mettre à jour un paramètre imbriqué pour un sous-réseaux

Exemples

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

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

id
requis

ID du paramêtre

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String

parameter
requis

Validations:

  • Must be a Hash

parameter[name]
optionel

Validations:

  • Must be a String

parameter[value]
optionel

Validations:

  • Must be a String

parameter[parameter_type]
optionel

Type de valeur

Validations:

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


DELETE /api/hosts/:host_id/parameters/:id
Supprimer une paramètre imbriqué pour un hôte

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Supprimer un paramètre imbriqué pour un groupe d'hôtes

DELETE /api/domains/:domain_id/parameters/:id
Supprimer un paramètre imbriqué pour un domaine

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Supprimer une paramètre imbriqué pour un système d'exploitation

DELETE /api/locations/:location_id/parameters/:id
Supprimer un paramètre imbriqué pour un emplacement

DELETE /api/organizations/:organization_id/parameters/:id
Supprimer un paramètre imbriqué pour une organisation

DELETE /api/subnets/:subnet_id/parameters/:id
Supprimer un paramètre imbriqué pour un sous-réseaux

Exemples

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

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

id
requis

ID du paramêtre

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Supprimer tous les paramètres imbriqués pour un hôte

DELETE /api/hostgroups/:hostgroup_id/parameters
Supprimer tous les paramètres imbriqués pour un groupe d'hôtes

DELETE /api/domains/:domain_id/parameters
Supprimer tous les paramètres imbriqués pour un domaine

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Supprimer tous les paramètres imbriqués pour un système d'exploitation

DELETE /api/locations/:location_id/parameters
Supprimer tous les paramètres imbriqués pour un emplacement

DELETE /api/organizations/:organization_id/parameters
Supprimer tous les paramètres imbriqués pour une organisation

DELETE /api/subnets/:subnet_id/parameters
Supprimer tous les paramètres imbriqués pour un sous-réseaux

Exemples

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

]

Paramètres

Nom du paramètre Description
host_id
optionel

ID de l’hôte

Validations:

  • Must be a String

hostgroup_id
optionel

ID du groupe d’hôtes

Validations:

  • Must be a String

domain_id
optionel

ID du domaine

Validations:

  • Must be a String

operatingsystem_id
optionel

ID du système d’exploitation

Validations:

  • Must be a String

location_id
optionel

ID d’emplacement

Validations:

  • Must be a String

organization_id
optionel

ID de l’organisation

Validations:

  • Must be a String

subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String