API

Polemarch provides REST API for all it’s functionality accessible via web GUI, because our GUI also uses this API to work. Below there is an information about every entity we have in Polemarch and methods applicable to it.

This is an example of api schema, but you can find actual schema on Polemarch host at /api/endpoint/.

Structure

In Polemarch we have some entities that can be nested to another entities. Below examples of such entities:

Inventory can be nested into Project

Group can be nested into Inventory or into another Group with children=true

Host can be nested into Inventory or into another Group with children=false

User can be nested into Team

To add entities into another, you only need send [{"id": [instance_id]}, ...] to subpath. Also you can insert instead of data results of bulk request, inner mechanism add all entities in result to parent entity.

GET /community_template/

List of community project templates.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string)

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (required)

  • results[].name (string) – (required)

  • results[].type (string)

GET /community_template/{id}/

Return a community project template instance.

Parameters:

  • id (integer) – A unique value identifying this project community template.

Status Codes:
Response JSON Object:

  • description (string) – (required)

  • id (integer) – (required)

  • name (string) – (required)

  • repository (string) – (required)

  • type (string)

POST /community_template/{id}/use_it/

Create a project based on current template.

Parameters:

  • id (integer) – A unique value identifying this project community template.

Request JSON Object:

  • name (string)

  • project_id (integer) – (read only)

Status Codes:
Response JSON Object:

  • name (string)

  • project_id (integer) – (read only)

GET /group/

Return all groups.

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /group/

Create a new group.

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /group/{id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /group/{id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /group/{id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /group/{id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Status Codes:
POST /group/{id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /group/{id}/groups/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /group/{id}/groups/

Create a new group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /group/{id}/groups/{groups_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /group/{id}/groups/{groups_id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /group/{id}/groups/{groups_id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /group/{id}/groups/{groups_id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
POST /group/{id}/groups/{groups_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /group/{id}/groups/{groups_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /group/{id}/groups/{groups_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /group/{id}/groups/{groups_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /group/{id}/groups/{groups_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /group/{id}/groups/{groups_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /group/{id}/groups/{groups_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /group/{id}/groups/{groups_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /group/{id}/groups/{groups_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /group/{id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /group/{id}/groups/{groups_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /group/{id}/groups/{groups_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /group/{id}/groups/{groups_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /group/{id}/groups/{groups_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /group/{id}/groups/{groups_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /group/{id}/groups/{groups_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /group/{id}/groups/{groups_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /group/{id}/hosts/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /group/{id}/hosts/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /group/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /group/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /group/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /group/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /group/{id}/hosts/{hosts_id}/copy/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /group/{id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /group/{id}/hosts/{hosts_id}/variables/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /group/{id}/hosts/{hosts_id}/variables/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /group/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /group/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /group/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /group/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /group/{id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /group/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /group/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /group/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /group/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /group/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /group/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this group.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /history/

Return all history instances of executions.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • status (string) – Status of execution.

  • mode (string) – Module or playbook name.

  • kind (string) – Kind of execution.

  • older (string) – Older then this time

  • newer (string) – Newer then this time

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].executor (string) – (required)

  • results[].id (integer) – (read only)

  • results[].initiator (integer)

  • results[].initiator_type (string)

  • results[].inventory (string) – (read only)

  • results[].kind (string)

  • results[].mode (string) – (required)

  • results[].options (string) – (read only)

  • results[].project (integer)

  • results[].start_time (string)

  • results[].status (string) – (required)

  • results[].stop_time (string)

GET /history/{id}/

Return an execution history instance.

Parameters:

  • id (integer) – A unique integer value identifying this history.

Status Codes:
Response JSON Object:

  • execute_args (string) – (required)

  • execution_time (integer) – (required)

  • executor (string) – (required)

  • id (integer) – (read only)

  • initiator (integer)

  • initiator_type (string)

  • inventory (integer)

  • kind (string)

  • mode (string) – (required)

  • options (string) – (read only)

  • project (integer)

  • raw_args (string)

  • raw_inventory (string)

  • raw_stdout (string) – (read only)

  • revision (string)

  • start_time (string)

  • status (string) – (required)

  • stop_time (string)

DELETE /history/{id}/

Remove an existing history record.

Parameters:

  • id (integer) – A unique integer value identifying this history.

Status Codes:
PATCH /history/{id}/cancel/

Cancel working task.

Parameters:

  • id (integer) – A unique integer value identifying this history.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

DELETE /history/{id}/clear/

Clear execution output.

Parameters:

  • id (integer) – A unique integer value identifying this history.

Status Codes:
GET /history/{id}/facts/

Get facts from “setup” ansible module execution.

Parameters:

  • id (integer) – A unique integer value identifying this history.

Status Codes:
Response JSON Object:

  • facts (string) – (read only)

GET /hook/

Return all hooks.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • when (string)

  • type (string) – Instance type.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].enable (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].recipients (string) – (required)

  • results[].type (string) – (required)

  • results[].when (string)

POST /hook/

Create a new hook.

Request JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

Status Codes:
Response JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

GET /hook/{id}/

Return a hook instance.

Parameters:

  • id (integer) – A unique integer value identifying this hook.

Status Codes:
Response JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

PUT /hook/{id}/

Update a hook.

Parameters:

  • id (integer) – A unique integer value identifying this hook.

Request JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

Status Codes:
Response JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

PATCH /hook/{id}/

Update one or more fields on an existing hook.

Parameters:

  • id (integer) – A unique integer value identifying this hook.

Request JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

Status Codes:
Response JSON Object:

  • enable (boolean)

  • id (integer) – (read only)

  • name (string)

  • recipients (string) – <b>HTTP</b>: list of URLs, separated by “|”.<br><b>SCRIPT</b>: script files, separated by “|” Files must be in HOOKS_DIR directory. (required)

  • type (string) – (required)

  • when (string) – (required)

DELETE /hook/{id}/

Remove an existing hook.

Parameters:

  • id (integer) – A unique integer value identifying this hook.

Status Codes:
GET /host/

Return all hosts.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /host/

Create a new host.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /host/{id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /host/{id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /host/{id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /host/{id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Status Codes:
POST /host/{id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /host/{id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /host/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /host/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /host/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /host/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /host/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /host/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this host.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /inventory/

Return all inventories.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • plugin (array)

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].plugin (string) – (read only)

  • results[].state_managed (boolean) – (read only)

POST /inventory/

Create a new inventory.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (required)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (required)

  • state_managed (boolean) – (read only)

POST /inventory/import_inventory/

Import inventory from file.

Request JSON Object:

  • data (string) – (required)

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

Status Codes:
Response JSON Object:

  • data (string) – (required)

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

GET /inventory/{id}/

Return a inventory instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

PUT /inventory/{id}/

Update a inventory.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

PATCH /inventory/{id}/

Update one or more fields on an existing inventory.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

DELETE /inventory/{id}/

Remove an existing inventory.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Status Codes:
GET /inventory/{id}/all_groups/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

GET /inventory/{id}/all_groups/{all_groups_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • all_groups_id (string)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /inventory/{id}/all_hosts/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

GET /inventory/{id}/all_hosts/{all_hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • all_hosts_id (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

POST /inventory/{id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /inventory/{id}/group/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /inventory/{id}/group/

Create a new group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /inventory/{id}/group/{group_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /inventory/{id}/group/{group_id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /inventory/{id}/group/{group_id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /inventory/{id}/group/{group_id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Status Codes:
POST /inventory/{id}/group/{group_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /inventory/{id}/group/{group_id}/groups/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /inventory/{id}/group/{group_id}/groups/

Create a new group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /inventory/{id}/group/{group_id}/groups/{groups_id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /inventory/{id}/group/{group_id}/groups/{groups_id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
POST /inventory/{id}/group/{group_id}/groups/{groups_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /inventory/{id}/group/{group_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /inventory/{id}/group/{group_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /inventory/{id}/group/{group_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /inventory/{id}/group/{group_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /inventory/{id}/group/{group_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /inventory/{id}/group/{group_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /inventory/{id}/group/{group_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /inventory/{id}/group/{group_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /inventory/{id}/group/{group_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/group/{group_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/group/{group_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/group/{group_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/group/{group_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/group/{group_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/group/{group_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /inventory/{id}/hosts/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /inventory/{id}/hosts/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /inventory/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /inventory/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /inventory/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /inventory/{id}/hosts/{hosts_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /inventory/{id}/hosts/{hosts_id}/copy/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /inventory/{id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/hosts/{hosts_id}/variables/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/hosts/{hosts_id}/variables/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/hosts/{hosts_id}/variables/{variables_id}/

Manage inventory hosts.

retrieve:

Return a host instance.

list:

Return all hosts.

create:

Create a new host.

destroy:

Remove an existing host.

partial_update:

Update one or more fields on an existing host.

update:

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /inventory/{id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /inventory/{id}/state/

State

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Status Codes:
Response JSON Object:

  • data (string) – (required)

PUT /inventory/{id}/state/

State

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • data (string) – (required)

Status Codes:
Response JSON Object:

  • data (string) – (required)

GET /inventory/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /inventory/{id}/variables/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /inventory/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /inventory/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /inventory/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /inventory/{id}/variables/{variables_id}/

Inventory hosts variables.

retrieve:

Return a variable of inventory host.

list:

Return all variables of inventory host.

create:

Create a new variable of inventory host.

destroy:

Remove an existing variable.

partial_update:

Update one or more fields on an existing variable.

update:

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this inventory.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /project/

Return all projects.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • status (array) – Project sync status.

  • status__not (array) – Project sync status.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].status (string) – (read only)

  • results[].type (string) – (read only)

POST /project/

Create a new project.

Request JSON Object:

  • additional_playbook_path (string)

  • auth_data (string)

  • branch (string)

  • id (integer) – (read only)

  • name (string) – (required)

  • repo_auth (string)

  • repository (string)

  • status (string) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • additional_playbook_path (string)

  • auth_data (string)

  • branch (string)

  • id (integer) – (read only)

  • name (string) – (required)

  • repo_auth (string)

  • repository (string)

  • status (string) – (read only)

  • type (string)

GET /project/{id}/

Return a project instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Status Codes:
Response JSON Object:

  • branch (string) – (read only)

  • execute_view_data (object)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • readme_content (string) – (read only)

  • repository (string)

  • revision (string) – (read only)

  • status (string) – (read only)

PUT /project/{id}/

Update a project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • branch (string) – (read only)

  • execute_view_data (object)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • readme_content (string) – (read only)

  • repository (string)

  • revision (string) – (read only)

  • status (string) – (read only)

Status Codes:
Response JSON Object:

  • branch (string) – (read only)

  • execute_view_data (object)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • readme_content (string) – (read only)

  • repository (string)

  • revision (string) – (read only)

  • status (string) – (read only)

PATCH /project/{id}/

Update one or more fields on an existing project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • branch (string) – (read only)

  • execute_view_data (object)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • readme_content (string) – (read only)

  • repository (string)

  • revision (string) – (read only)

  • status (string) – (read only)

Status Codes:
Response JSON Object:

  • branch (string) – (read only)

  • execute_view_data (object)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • readme_content (string) – (read only)

  • repository (string)

  • revision (string) – (read only)

  • status (string) – (read only)

DELETE /project/{id}/

Remove an existing project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Status Codes:
GET /project/{id}/_project_template_options/

ExecutionTemplateOption(id, name, template, notes, arguments)

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • template (string) – Search by template’s primary key or name

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].extended_name (string) – (required)

  • results[].id (string)

  • results[].template (integer) – (required)

GET /project/{id}/_project_template_options/{_project_template_options_id}/

ExecutionTemplateOption(id, name, template, notes, arguments)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • _project_template_options_id (string)

Status Codes:
Response JSON Object:

  • extended_name (string) – (required)

  • id (string)

  • template (integer) – (required)

GET /project/{id}/ansible_modules/

Ansible modules for project.

retrieve:

Return a module details of project instance.

list:

Return all available modules of project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • path (array) – Full path to module.

  • path__not (array) – Full path to module.

  • name (string) – Full path to module.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].path (string) – (required)

GET /project/{id}/ansible_modules/{ansible_modules_id}/

Ansible modules for project.

retrieve:

Return a module details of project instance.

list:

Return all available modules of project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • ansible_modules_id (integer) – A unique integer value identifying instance of this ansible_modules sublist.

Status Codes:
Response JSON Object:

  • data (string) – (required)

  • id (integer) – (read only)

  • path (string) – (required)

GET /project/{id}/ansible_playbooks/

Ansible playbooks for project.

retrieve:

Return a playbook of project instance.

list:

Return all playbooks of project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • playbook (array) – Playbook filename.

  • playbook__not (array) – Playbook filename.

  • pb_filter (string) – Playbook filename - filter for prefetch.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].playbook (string) – (required)

GET /project/{id}/ansible_playbooks/{ansible_playbooks_id}/

Ansible playbooks for project.

retrieve:

Return a playbook of project instance.

list:

Return all playbooks of project.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • ansible_playbooks_id (integer) – A unique integer value identifying instance of this ansible_playbooks sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • playbook (string) – (required)

POST /project/{id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • status (string) – (read only)

  • type (string) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • status (string) – (read only)

  • type (string) – (read only)

POST /project/{id}/execute_ansible_module/

Execute ANSIBLE_MODULE plugin.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • args (string) – host pattern

  • background (integer) – run asynchronously, failing after X seconds (default=N/A)

  • become (boolean) – run operations with become (does not imply password prompting)

  • become_method (string) – privilege escalation method to use (default=sudo), use ansible-doc -t become -l to list valid choices.

  • check (boolean) – don’t make any changes; instead, try to predict some of the changes that may occur

  • connection (string) – connection type to use (default=ssh)

  • diff (boolean) – when changing (small) files and templates, show the differences in those files; works great with –check

  • extra_vars (string) – set additional variables as key=value or YAML/JSON, if filename prepend with @. This argument may be specified multiple times.

  • forks (integer) – specify number of parallel processes to use (default=5)

  • group (string)

  • inventory (string) – specify inventory host path or comma separated host list. –inventory-file is deprecated. This argument may be specified multiple times.

  • limit (string) – further limit selected hosts to an additional pattern

  • list_hosts (boolean) – outputs a list of matching hosts; does not execute anything else

  • module (string) – (required)

  • one_line (boolean) – condense output

  • playbook_dir (string) – Since this tool does not use playbooks, use this as a substitute playbook directory. This sets the relative path for many features including roles/ group_vars/ etc.

  • poll (integer) – set the poll interval if using -B (default=15)

  • private_key (string) – use this file to authenticate the connection

  • scp_extra_args (string) – specify extra arguments to pass to scp only (e.g. -l)

  • sftp_extra_args (string) – specify extra arguments to pass to sftp only (e.g. -f, -l)

  • ssh_common_args (string) – specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)

  • ssh_extra_args (string) – specify extra arguments to pass to ssh only (e.g. -R)

  • task_timeout (integer) – set task timeout limit in seconds, must be positive integer.

  • timeout (integer) – override the connection timeout in seconds (default depends on connection)

  • tree (string) – log output to this directory

  • user (string) – connect as this user (default=None)

  • vault_password_file (string) – vault password file

  • verbose (integer) – Causes Ansible to print more debug messages. Adding multiple -v will increase the verbosity, the builtin plugins currently evaluate up to -vvvvvv. A reasonable level to start is -vvv, connection debugging might require -vvvv. This argument may be specified multiple times.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

  • executor (integer) – (read only)

  • history_id (integer) – (read only)

POST /project/{id}/execute_ansible_playbook/

Execute ANSIBLE_PLAYBOOK plugin.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • args (string) – Playbook(s)

  • become (boolean) – run operations with become (does not imply password prompting)

  • become_method (string) – privilege escalation method to use (default=sudo), use ansible-doc -t become -l to list valid choices.

  • check (boolean) – don’t make any changes; instead, try to predict some of the changes that may occur

  • connection (string) – connection type to use (default=ssh)

  • diff (boolean) – when changing (small) files and templates, show the differences in those files; works great with –check

  • extra_vars (string) – set additional variables as key=value or YAML/JSON, if filename prepend with @. This argument may be specified multiple times.

  • flush_cache (boolean) – clear the fact cache for every host in inventory

  • force_handlers (boolean) – run handlers even if a task fails

  • forks (integer) – specify number of parallel processes to use (default=5)

  • inventory (string) – specify inventory host path or comma separated host list. –inventory-file is deprecated. This argument may be specified multiple times.

  • limit (string) – further limit selected hosts to an additional pattern

  • list_hosts (boolean) – outputs a list of matching hosts; does not execute anything else

  • list_tags (boolean) – list all available tags

  • list_tasks (boolean) – list all tasks that would be executed

  • playbook (string) – (required)

  • private_key (string) – use this file to authenticate the connection

  • scp_extra_args (string) – specify extra arguments to pass to scp only (e.g. -l)

  • sftp_extra_args (string) – specify extra arguments to pass to sftp only (e.g. -f, -l)

  • skip_tags (integer) – only run plays and tasks whose tags do not match these values. This argument may be specified multiple times.

  • ssh_common_args (string) – specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)

  • ssh_extra_args (string) – specify extra arguments to pass to ssh only (e.g. -R)

  • start_at_task (string) – start the playbook at the task matching this name

  • step (boolean) – one-step-at-a-time: confirm each task before running

  • syntax_check (boolean) – perform a syntax check on the playbook, but do not execute it

  • tags (integer) – only run plays and tasks tagged with these values. This argument may be specified multiple times.

  • timeout (integer) – override the connection timeout in seconds (default depends on connection)

  • user (string) – connect as this user (default=None)

  • vault_password_file (string) – vault password file

  • verbose (integer) – Causes Ansible to print more debug messages. Adding multiple -v will increase the verbosity, the builtin plugins currently evaluate up to -vvvvvv. A reasonable level to start is -vvv, connection debugging might require -vvvv. This argument may be specified multiple times.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

  • executor (integer) – (read only)

  • history_id (integer) – (read only)

GET /project/{id}/execution_templates/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • plugin (string)

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string) – (required)

  • results[].plugin (string) – (required)

POST /project/{id}/execution_templates/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • arguments (string) – (required)

  • id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

Status Codes:
Response JSON Object:

  • arguments (string) – (required)

  • id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

GET /project/{id}/execution_templates/{execution_templates_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • plugin (string) – (read only)

PUT /project/{id}/execution_templates/{execution_templates_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • plugin (string) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • plugin (string) – (read only)

PATCH /project/{id}/execution_templates/{execution_templates_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • plugin (string) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • plugin (string) – (read only)

DELETE /project/{id}/execution_templates/{execution_templates_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Status Codes:
POST /project/{id}/execution_templates/{execution_templates_id}/execute/

Execute template with option.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Request JSON Object:

  • option (integer) – (required)

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

  • executor (integer) – (read only)

  • history_id (integer) – (read only)

GET /project/{id}/execution_templates/{execution_templates_id}/history/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • status (string) – Status of execution.

  • mode (string) – Module or playbook name.

  • kind (string) – Kind of execution.

  • older (string) – Older then this time

  • newer (string) – Newer then this time

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].executor (string) – (required)

  • results[].id (integer) – (read only)

  • results[].initiator (integer)

  • results[].initiator_type (string)

  • results[].inventory (string) – (read only)

  • results[].kind (string)

  • results[].mode (string) – (required)

  • results[].options (string) – (read only)

  • results[].project (integer)

  • results[].start_time (string)

  • results[].status (string) – (required)

  • results[].stop_time (string)

GET /project/{id}/execution_templates/{execution_templates_id}/history/{history_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • execute_args (string) – (required)

  • execution_time (integer) – (required)

  • executor (string) – (required)

  • id (integer) – (read only)

  • initiator (integer)

  • initiator_type (string)

  • inventory (integer)

  • kind (string)

  • mode (string) – (required)

  • options (string) – (read only)

  • project (integer)

  • raw_args (string)

  • raw_inventory (string)

  • raw_stdout (string) – (read only)

  • revision (string)

  • start_time (string)

  • status (string) – (required)

  • stop_time (string)

DELETE /project/{id}/execution_templates/{execution_templates_id}/history/{history_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
PATCH /project/{id}/execution_templates/{execution_templates_id}/history/{history_id}/cancel/

Cancel working task.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

DELETE /project/{id}/execution_templates/{execution_templates_id}/history/{history_id}/clear/

Clear execution output.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
GET /project/{id}/execution_templates/{execution_templates_id}/history/{history_id}/facts/

Get facts from “setup” ansible module execution.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • facts (string) – (read only)

GET /project/{id}/execution_templates/{execution_templates_id}/options/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (string)

  • results[].name (string) – (required)

POST /project/{id}/execution_templates/{execution_templates_id}/options/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

Request JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

Status Codes:
Response JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

GET /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Status Codes:
Response JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

PUT /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Request JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

Status Codes:
Response JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

PATCH /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Request JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

Status Codes:
Response JSON Object:

  • arguments (string) – (required)

  • id (string) – (read only)

  • name (string) – (required)

  • notes (string)

DELETE /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Status Codes:
POST /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/execute/

Execute template with option.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

  • executor (integer) – (read only)

  • history_id (integer) – (read only)

GET /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • schedule (string)

  • enabled (boolean)

  • save_result (boolean)

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].enabled (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string) – (required)

  • results[].save_result (boolean)

  • results[].schedule (string) – (required)

POST /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

Request JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

Status Codes:
Response JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

GET /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/{periodic_tasks_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

  • periodic_tasks_id (string)

Status Codes:
Response JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

PUT /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/{periodic_tasks_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

  • periodic_tasks_id (string)

Request JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

Status Codes:
Response JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

PATCH /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/{periodic_tasks_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

  • periodic_tasks_id (string)

Request JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

Status Codes:
Response JSON Object:

  • enabled (boolean)

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string)

  • save_result (boolean)

  • schedule (string) – (required)

  • type (string) – (required)

DELETE /project/{id}/execution_templates/{execution_templates_id}/options/{options_id}/periodic_tasks/{periodic_tasks_id}/

Manage execution templates of project.

retrieve:

Return an execution template instance.

list:

Return all execution templates in project.

create:

Create a new execution template.

destroy:

Remove an existing execution template.

partial_update:

Update one or more fields on an existing execution template.

update:

Update an execution template.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • execution_templates_id (integer) – A unique integer value identifying instance of this execution_templates sublist.

  • options_id (string)

  • periodic_tasks_id (string)

Status Codes:
GET /project/{id}/history/

View previous executions.

retrieve:

Return an execution history instance.

list:

Return all history instances of executions.

destroy:

Remove an existing history record.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • status (string) – Status of execution.

  • mode (string) – Module or playbook name.

  • kind (string) – Kind of execution.

  • older (string) – Older then this time

  • newer (string) – Newer then this time

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].executor (string) – (required)

  • results[].id (integer) – (read only)

  • results[].initiator (integer)

  • results[].initiator_type (string)

  • results[].inventory (string) – (read only)

  • results[].kind (string)

  • results[].mode (string) – (required)

  • results[].options (string) – (read only)

  • results[].project (integer)

  • results[].start_time (string)

  • results[].status (string) – (required)

  • results[].stop_time (string)

GET /project/{id}/history/{history_id}/

View previous executions.

retrieve:

Return an execution history instance.

list:

Return all history instances of executions.

destroy:

Remove an existing history record.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • execute_args (string) – (required)

  • execution_time (integer) – (required)

  • executor (string) – (required)

  • id (integer) – (read only)

  • initiator (integer)

  • initiator_type (string)

  • inventory (integer)

  • kind (string)

  • mode (string) – (required)

  • options (string) – (read only)

  • project (integer)

  • raw_args (string)

  • raw_inventory (string)

  • raw_stdout (string) – (read only)

  • revision (string)

  • start_time (string)

  • status (string) – (required)

  • stop_time (string)

DELETE /project/{id}/history/{history_id}/

View previous executions.

retrieve:

Return an execution history instance.

list:

Return all history instances of executions.

destroy:

Remove an existing history record.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
PATCH /project/{id}/history/{history_id}/cancel/

Cancel working task.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

DELETE /project/{id}/history/{history_id}/clear/

Clear execution output.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
GET /project/{id}/history/{history_id}/facts/

Get facts from “setup” ansible module execution.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

Status Codes:
Response JSON Object:

  • facts (string) – (read only)

GET /project/{id}/inventory/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • plugin (array)

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].plugin (string) – (read only)

  • results[].state_managed (boolean) – (read only)

POST /project/{id}/inventory/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (required)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (required)

  • state_managed (boolean) – (read only)

POST /project/{id}/inventory/import_inventory/

Import inventory from file.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • data (string) – (required)

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

Status Codes:
Response JSON Object:

  • data (string) – (required)

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • plugin (string) – (required)

GET /project/{id}/inventory/{inventory_id}/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

PUT /project/{id}/inventory/{inventory_id}/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

PATCH /project/{id}/inventory/{inventory_id}/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • plugin (string) – (read only)

  • state_managed (boolean) – (read only)

DELETE /project/{id}/inventory/{inventory_id}/

Inventory(id, hidden, notes, owner, name, plugin, _inventory_state)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Status Codes:
GET /project/{id}/inventory/{inventory_id}/all_groups/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

GET /project/{id}/inventory/{inventory_id}/all_groups/{all_groups_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • all_groups_id (string)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /project/{id}/inventory/{inventory_id}/all_hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

GET /project/{id}/inventory/{inventory_id}/all_hosts/{all_hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • all_hosts_id (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

POST /project/{id}/inventory/{inventory_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /project/{id}/inventory/{inventory_id}/group/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /project/{id}/inventory/{inventory_id}/group/

Create a new group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Status Codes:
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/

Return all groups.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Query Parameters:

  • __deep_parent (integer)

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].children (boolean)

  • results[].id (integer) – (read only)

  • results[].name (string)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/

Create a new group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/

Return a group instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/

Update a group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/

Update one or more fields on an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

Status Codes:
Response JSON Object:

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/

Remove an existing group.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Status Codes:
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/groups/{groups_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • groups_id (integer) – A unique integer value identifying instance of this groups sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/group/{group_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • group_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /project/{id}/inventory/{inventory_id}/hosts/

Return all hosts.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • type (string) – Instance type.

  • variables (string) – List of variables to filter. Comma separated “key:value” list.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].name (string)

  • results[].type (string)

POST /project/{id}/inventory/{inventory_id}/hosts/

Create a new host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

GET /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/

Return a host instance.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PUT /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/

Update a host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

PATCH /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/

Update one or more fields on an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

  • notes (string)

  • owner (integer) – (read only)

  • type (string)

DELETE /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/

Remove an existing host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Status Codes:
POST /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • name (string)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • name (string)

PATCH /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • hosts_id (integer) – A unique integer value identifying instance of this hosts sublist.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /project/{id}/inventory/{inventory_id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/state/

State

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Status Codes:
Response JSON Object:

  • data (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/state/

State

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • data (string) – (required)

Status Codes:
Response JSON Object:

  • data (string) – (required)

GET /project/{id}/inventory/{inventory_id}/variables/

Return all variables of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/inventory/{inventory_id}/variables/

Create a new variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/inventory/{inventory_id}/variables/{variables_id}/

Return a variable of inventory host.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/inventory/{inventory_id}/variables/{variables_id}/

Update variable value.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/inventory/{inventory_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/inventory/{inventory_id}/variables/{variables_id}/

Remove an existing variable.

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • inventory_id (string)

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
PATCH /project/{id}/set_owner/

Change instance owner.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • owner (integer) – (required)

Status Codes:
Response JSON Object:

  • owner (integer) – (required)

PATCH /project/{id}/sync/

Synchronize project with repository.

Parameters:

  • id (integer) – A unique integer value identifying this project.

Status Codes:
Response JSON Object:

  • detail (string) – (read only)

GET /project/{id}/variables/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • key (string) – A key name string value (or comma separated list) of instance.

  • value (string) – A value of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].id (integer) – (read only)

  • results[].key (string) – (required)

  • results[].value (string) – (required)

POST /project/{id}/variables/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

GET /project/{id}/variables/{variables_id}/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PUT /project/{id}/variables/{variables_id}/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

PATCH /project/{id}/variables/{variables_id}/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Request JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

Status Codes:
Response JSON Object:

  • id (integer) – (read only)

  • key (string) – (required)

  • value (string) – (required)

DELETE /project/{id}/variables/{variables_id}/

Variable(id, hidden, content_type, object_id, key, value)

Parameters:

  • id (integer) – A unique integer value identifying this project.

  • variables_id (integer) – A unique integer value identifying instance of this variables sublist.

Status Codes:
GET /stats/
Status Codes:
Response JSON Object:

  • execution_plugins (integer) – (required)

  • inventories (integer) – (required)

  • inventory_plugins (integer) – (required)

  • jobs.day[].all (integer) – (required)

  • jobs.day[].day (string) – (required)

  • jobs.day[].status (string) – (required)

  • jobs.day[].sum (integer) – (required)

  • jobs.month[].all (integer) – (required)

  • jobs.month[].month (string) – (required)

  • jobs.month[].status (string) – (required)

  • jobs.month[].sum (integer) – (required)

  • jobs.year[].all (integer) – (required)

  • jobs.year[].status (string) – (required)

  • jobs.year[].sum (integer) – (required)

  • jobs.year[].year (string) – (required)

  • projects (integer) – (required)

  • users (integer) – (required)

GET /user/

Return all users.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • username (string) – A name string value (or comma separated list) of instance.

  • is_active (boolean) – Boolean value meaning status of user.

  • first_name (string) – Users first name.

  • last_name (string) – Users last name.

  • email (string) – Users e-mail value.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • username__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].email (string)

  • results[].id (integer) – (read only)

  • results[].is_active (boolean)

  • results[].username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

POST /user/

Create a new user.

Request JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • password (string) – (required)

  • password2 (string) – (required)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes:
Response JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • password (string) – (required)

  • password2 (string) – (required)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /user/{id}/

Return a user instance.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Status Codes:
Response JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PUT /user/{id}/

Update a user.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes:
Response JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PATCH /user/{id}/

Update one or more fields on an existing user.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes:
Response JSON Object:

  • email (string)

  • first_name (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • last_name (string)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

DELETE /user/{id}/

Remove an existing user.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Status Codes:
GET /user/{id}/_settings/

Manage users.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Status Codes:
Response JSON Object:

  • custom (object)

  • main.dark_mode (boolean)

  • main.language (string)

PUT /user/{id}/_settings/

Manage users.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • custom (object)

  • main.dark_mode (boolean)

  • main.language (string)

Status Codes:
Response JSON Object:

  • custom (object)

  • main.dark_mode (boolean)

  • main.language (string)

POST /user/{id}/change_password/

Manage users.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • old_password (string) – (required)

  • password (string) – (required)

  • password2 (string) – (required)

Status Codes:
Response JSON Object:

  • old_password (string) – (required)

  • password (string) – (required)

  • password2 (string) – (required)

POST /user/{id}/copy/

Endpoint which copy instance with deps.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • email (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes:
Response JSON Object:

  • email (string)

  • id (integer) – (read only)

  • is_active (boolean)

  • username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /user/{id}/token/

Oauth2Token(id, session, name, user, token)

Parameters:

  • id (integer) – A unique integer value identifying this user.

Query Parameters:

  • id (array) – A unique integer value (or comma separated list) identifying this instance.

  • name (string) – A name string value (or comma separated list) of instance.

  • id__not (array) – A unique integer value (or comma separated list) identifying this instance.

  • name__not (string) – A name string value (or comma separated list) of instance.

  • ordering (array) – Which field to use when ordering the results.

  • __search (string) – A search term.

  • limit (integer) – Number of results to return per page.

  • offset (integer) – The initial index from which to return the results.

Status Codes:
Response JSON Object:

  • count (integer) – (required)

  • next (string)

  • previous (string)

  • results[].expires (string) – (read only)

  • results[].id (integer) – (read only)

  • results[].name (string) – (required)

POST /user/{id}/token/

Oauth2Token(id, session, name, user, token)

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • expires (string) – (required)

  • id (integer) – (read only)

  • name (string) – (required)

  • token (string) – (read only)

Status Codes:
Response JSON Object:

  • expires (string) – (required)

  • id (integer) – (read only)

  • name (string) – (required)

  • token (string) – (read only)

GET /user/{id}/token/{token_id}/

Oauth2Token(id, session, name, user, token)

Parameters:

  • id (integer) – A unique integer value identifying this user.

  • token_id (string)

Status Codes:
Response JSON Object:

  • expires (string) – (read only)

  • id (integer) – (read only)

  • name (string) – (required)

  • token (string) – (read only)

DELETE /user/{id}/token/{token_id}/

Oauth2Token(id, session, name, user, token)

Parameters:

  • id (integer) – A unique integer value identifying this user.

  • token_id (string)

Status Codes:
GET /user/{id}/twofa/

Manage users.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Status Codes:
Response JSON Object:

  • enabled (boolean) – (read only)

  • pin (string)

  • recovery (string)

  • secret (string)

PUT /user/{id}/twofa/

Manage users.

Parameters:

  • id (integer) – A unique integer value identifying this user.

Request JSON Object:

  • enabled (boolean) – (read only)

  • pin (string)

  • recovery (string)

  • secret (string)

Status Codes:
Response JSON Object:

  • enabled (boolean) – (read only)

  • pin (string)

  • recovery (string)

  • secret (string)