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
Lista parametrów hosta

GET /api/hostgroups/:hostgroup_id/parameters
Lista parametrów dla grupy hostów

GET /api/domains/:domain_id/parameters
Lista parametrów domeny

GET /api/operatingsystems/:operatingsystem_id/parameters
Lista parametrów dla systemu operacyjnego

GET /api/locations/:location_id/parameters
Lista parametrów domeny

GET /api/organizations/:organization_id/parameters
Lista wszystkich parametrów dla organizacji

GET /api/subnets/:subnet_id/parameters
List all parameters for a subnet

Przykłady

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

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String

show_hidden
opcjonalny

Display hidden values

Validations:

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

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ 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/hosts/:host_id/parameters/:id
Pokaż zagnieżdżony parametr dla hosta

GET /api/hostgroups/:hostgroup_id/parameters/:id
Pokaż zagnieżdżony parametr dla grupy hostów

GET /api/domains/:domain_id/parameters/:id
Pokaż zagnieżdżony parametr dla domeny

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Pokaż zagnieżdżony parametr dla systemu operacyjnego

GET /api/locations/:location_id/parameters/:id
Pokaż zagnieżdżony parametr dla lokalizacji

GET /api/organizations/:organization_id/parameters/:id
Pokaż zagnieżdżony parametr dla organizacji

GET /api/subnets/:subnet_id/parameters/:id
Show a nested parameter for a subnet

Przykłady

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

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String

id
wymagany

Identyfikator parametru

Validations:

  • Must be a String

show_hidden
opcjonalny

Display hidden values

Validations:

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


POST /api/hosts/:host_id/parameters
Tworzenie zagnieżdżonego parametru dla hosta

POST /api/hostgroups/:hostgroup_id/parameters
Tworzenie zagnieżdżonego parametru dla grupy hostów

POST /api/domains/:domain_id/parameters
Tworzenie zagnieżdżonego parametru dla domeny

POST /api/operatingsystems/:operatingsystem_id/parameters
Tworzenie zagnieżdżonego parametru dla systemu operacyjnego

POST /api/locations/:location_id/parameters
Tworzenie zagnieżdżonego parametru dla lokalizacji

POST /api/organizations/:organization_id/parameters
Tworzenie zagnieżdżonego parametru dla organizacji

POST /api/subnets/:subnet_id/parameters
Create a nested parameter for a subnet

Przykłady

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

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String

parameter
wymagany

Validations:

  • Must be a Hash

parameter[name]
wymagany

Validations:

  • Must be a String

parameter[value]
wymagany

Validations:

  • Must be a String

parameter[parameter_type]
wymagany

Type of value

Validations:

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


PUT /api/hosts/:host_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla hosta

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla grupy hostów

PUT /api/domains/:domain_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla domeny

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla systemu operacyjnego

PUT /api/locations/:location_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla lokalizacji

PUT /api/organizations/:organization_id/parameters/:id
Aktualizacja zagnieżdżonego parametru dla organizacji

PUT /api/subnets/:subnet_id/parameters/:id
Update a nested parameter for a subnet

Przykłady

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

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

id
wymagany

Identyfikator parametru

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String

parameter
wymagany

Validations:

  • Must be a Hash

parameter[name]
opcjonalny

Validations:

  • Must be a String

parameter[value]
opcjonalny

Validations:

  • Must be a String

parameter[parameter_type]
opcjonalny

Type of value

Validations:

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


DELETE /api/hosts/:host_id/parameters/:id
Usuń zagnieżdżony parametr dla hosta

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Usuń zagnieżdżony parametr dla grupy hostów

DELETE /api/domains/:domain_id/parameters/:id
Usuwanie zagnieżdżonego parametru dla domeny

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Usuwanie zagnieżdżonego parametru dla systemu operacyjnego

DELETE /api/locations/:location_id/parameters/:id
Usuwanie zagnieżdżonego parametru dla lokalizacji

DELETE /api/organizations/:organization_id/parameters/:id
Usuwanie zagnieżdżonego parametru dla organizacji

DELETE /api/subnets/:subnet_id/parameters/:id
Delete a nested parameter for a subnet

Przykłady

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

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

id
wymagany

Identyfikator parametru

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Usuń wszystkie zagnieżdżone parametry hosta

DELETE /api/hostgroups/:hostgroup_id/parameters
Usuń wszystkie zagnieżdżone parametry dla grupy hostów

DELETE /api/domains/:domain_id/parameters
Usuń wszystkie zagnieżdżone parametry dla domeny

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Usuń wszystkie zagnieżdżone parametry systemu operacyjnego

DELETE /api/locations/:location_id/parameters
Usuń wszystkie zagnieżdżone parametry dla lokalizacji

DELETE /api/organizations/:organization_id/parameters
Usuń wszystkie zagnieżdżone parametry dla organizacji

DELETE /api/subnets/:subnet_id/parameters
Delete all nested parameters for a subnet

Przykłady

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

]

Parametry

Nazwa parametru Opis
host_id
opcjonalny

ID hostu

Validations:

  • Must be a String

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String

operatingsystem_id
opcjonalny

ID systemów operacyjnych

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

subnet_id
opcjonalny

ID podsieci

Validations:

  • Must be a String