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/v3/openapi/.

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

  • 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 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 project based on this template.

Parameters

  • id (integer) – A unique value identifying this project 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[].from_project (boolean) – (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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[].from_project (boolean) – (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Return a group instance.

Parameters

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

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update a group.

Parameters

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

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update one or more fields on an existing group.

Parameters

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

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Remove an existing group.

Parameters

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

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

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

Endpoint which copy instance with deps.

Parameters

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

  • 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/{groups_id}/hosts/

Return all hosts.

Parameters

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

  • 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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

  • results[].type (string) –

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

Create a new host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

  • 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.

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

  • 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.

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

  • 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.

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

  • 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.

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

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

Endpoint which copy instance with deps.

Parameters

  • 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.

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

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

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

Change instance owner.

Parameters

  • 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.

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

  • 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.

  • 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}/groups/{groups_id}/hosts/{hosts_id}/variables/

Create a new variable of instance.

Parameters

  • 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.

  • 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}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

  • 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.

  • 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}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters

  • 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.

  • 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}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

  • 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.

  • 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}/groups/{groups_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

  • 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.

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

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

Status Codes
POST /group/{id}/groups/{groups_id}/set_owner/

Change instance owner.

Parameters

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

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

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

  • 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}/groups/{groups_id}/variables/

Create a new variable of instance.

Parameters

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

  • 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}/groups/{groups_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

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

  • 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}/groups/{groups_id}/variables/{variables_id}/

Update variable value.

Parameters

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

  • 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}/groups/{groups_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • 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}/groups/{groups_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

  • 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 /group/{id}/hosts/

Return all hosts.

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

  • results[].type (string) –

POST /group/{id}/hosts/

Create a new host.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

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

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

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

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

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

Endpoint which copy instance with deps.

Parameters

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

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

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

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

Change instance owner.

Parameters

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

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/

Create a new variable of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

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

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

Status Codes
POST /group/{id}/set_owner/

Change instance owner.

Parameters

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

GET /group/{id}/variables/

Return all variables of instance.

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/

Create a new variable of instance.

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

Return a variable of instance.

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

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

Update one or more fields on an existing variable.

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

Remove an existing variable.

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 of executions.

Query Parameters

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

  • mode (string) – Module or playbook name.

  • kind (string) – Kind of execution.

  • status (string) – Status of execution.

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

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

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

  • older (string) – Older then this time

  • newer (string) – Newer then this time

  • 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 (integer) – (read only)

  • results[].kind (string) –

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

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

  • results[].project (integer) –

  • results[].start_time (string) –

  • results[].status (string) –

  • results[].stop_time (string) –

GET /history/{id}/

Return a execution history instance.

Parameters

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

Status Codes
Response JSON Object

  • execute_args (string) – (read only)

  • execution_time (integer) – (required)

  • executor (string) – (required)

  • id (integer) – (read only)

  • initiator (integer) –

  • initiator_type (string) –

  • inventory (integer) – (read only)

  • 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) –

  • stop_time (string) –

DELETE /history/{id}/

Remove an existing history record.

Parameters

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

Status Codes
POST /history/{id}/cancel/

Cencel working task.

Parameters

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

Status Codes
Response JSON Object

  • detail (string) – (required)

DELETE /history/{id}/clear/

Clear history output.

Parameters

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

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

Get compilated history facts (only for execution ‘module’ with module ‘setup’).

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.

  • 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) – (required)

  • type (string) – (required)

  • when (string) –

Status Codes
Response JSON Object

  • enable (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • recipients (string) – (required)

  • type (string) – (required)

  • when (string) –

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) – (required)

  • type (string) – (required)

  • when (string) –

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) – (required)

  • type (string) – (required)

  • when (string) –

Status Codes
Response JSON Object

  • enable (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • recipients (string) – (required)

  • type (string) – (required)

  • when (string) –

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) – (required)

  • type (string) – (required)

  • when (string) –

Status Codes
Response JSON Object

  • enable (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • recipients (string) – (required)

  • type (string) – (required)

  • when (string) –

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

POST /host/{id}/set_owner/

Change instance owner.

Parameters

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

GET /host/{id}/variables/

Return all variables of instance.

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/

Create a new variable of instance.

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

Return a variable of instance.

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

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

Update one or more fields on an existing variable.

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

Remove an existing variable.

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

POST /inventory/

Create a new inventory.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

POST /inventory/import_inventory/
Request JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (string) – (required)

Status Codes
Response JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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.

  • 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.

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

  • 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[].from_project (boolean) – (required)

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

  • results[].name (string) –

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

Return a group instance.

Parameters

  • all_groups_id (string) –

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

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /inventory/{id}/all_hosts/

Return all hosts.

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

  • results[].type (string) –

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

Return a host instance.

Parameters

  • all_hosts_id (string) –

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • 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.

  • 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.

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

  • 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[].from_project (boolean) – (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Return a group instance.

Parameters

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

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

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update a group.

Parameters

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

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

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update one or more fields on an existing group.

Parameters

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

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

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Remove an existing group.

Parameters

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

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

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

Endpoint which copy instance with deps.

Parameters

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

  • 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/{group_id}/groups/

Return all groups.

Parameters

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

  • 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.

  • children (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[].children (boolean) –

  • results[].from_project (boolean) – (required)

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

  • results[].name (string) –

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

Create a new group.

Parameters

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

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

Request JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Return a group instance.

Parameters

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

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

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

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update a group.

Parameters

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

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

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

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update one or more fields on an existing group.

Parameters

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

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

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

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Remove an existing group.

Parameters

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

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

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

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

Return all hosts.

Parameters

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

  • 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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

  • results[].type (string) –

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

Create a new host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

  • group_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.

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

  • group_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.

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

  • group_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.

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

  • group_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.

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

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

Endpoint which copy instance with deps.

Parameters

  • group_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.

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

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

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

Change instance owner.

Parameters

  • group_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.

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

  • group_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.

  • 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}/group/{group_id}/hosts/{hosts_id}/variables/

Create a new variable of instance.

Parameters

  • group_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.

  • 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}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

  • group_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.

  • 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}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters

  • group_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.

  • 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}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

  • group_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.

  • 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}/group/{group_id}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

  • group_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.

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

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

Status Codes
POST /inventory/{id}/group/{group_id}/set_owner/

Change instance owner.

Parameters

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

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

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

  • 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}/group/{group_id}/variables/

Create a new variable of instance.

Parameters

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

  • 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}/group/{group_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

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

  • 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}/group/{group_id}/variables/{variables_id}/

Update variable value.

Parameters

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

  • 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}/group/{group_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • 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}/group/{group_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

  • 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 /inventory/{id}/hosts/

Return all hosts.

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

  • results[].type (string) –

POST /inventory/{id}/hosts/

Create a new host.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

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

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

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

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

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

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

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

Endpoint which copy instance with deps.

Parameters

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

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

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

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

Change instance owner.

Parameters

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

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/

Create a new variable of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Return a variable of instance.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Update variable value.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • 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}/hosts/{hosts_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

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

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

Status Codes
POST /inventory/{id}/set_owner/

Change instance owner.

Parameters

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

GET /inventory/{id}/variables/

Return all variables of instance.

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/

Create a new variable of instance.

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

Return a variable of instance.

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

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

Update one or more fields on an existing variable.

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

Remove an existing variable.

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.

  • 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.

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

  • status__not (array) – Project sync status.

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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
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_module/

Execute 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=smart)

  • 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 @

  • 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

  • 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)

  • syntax_check (boolean) – perform a syntax check on the playbook, but do not execute it

  • timeout (integer) – override the connection timeout in seconds (default=10)

  • tree (string) – log output to this directory

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

  • vault_password_file (string) – vault password file

  • verbose (integer) – verbose mode (-vvv for more, -vvvv to enable connection debugging)

Status Codes
Response JSON Object

  • detail (string) – (required)

  • executor (integer) –

  • history_id (integer) –

POST /project/{id}/execute_playbook/

Execute 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=smart)

  • 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 @

  • 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

  • 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 (string) – only run plays and tasks whose tags do not match these values

  • 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 (string) – only run plays and tasks tagged with these values

  • timeout (integer) – override the connection timeout in seconds (default=10)

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

  • vault_password_file (string) – vault password file

  • verbose (integer) – verbose mode (-vvv for more, -vvvv to enable connection debugging)

Status Codes
Response JSON Object

  • detail (string) – (required)

  • executor (integer) –

  • history_id (integer) –

GET /project/{id}/execution_templates/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

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.

  • kind (string) – A kind of template.

  • inventory (string) – The inventory id or path in project.

  • 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[].kind (string) –

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

POST /project/{id}/execution_templates/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

Parameters

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

Request JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • name (string) – (required)

  • notes (string) –

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • name (string) – (required)

  • notes (string) –

GET /project/{id}/execution_templates/{execution_templates_id}/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) – (read only)

  • name (string) – (required)

  • notes (string) –

PUT /project/{id}/execution_templates/{execution_templates_id}/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Request JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) – (read only)

  • name (string) – (required)

  • notes (string) –

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) – (read only)

  • name (string) – (required)

  • notes (string) –

PATCH /project/{id}/execution_templates/{execution_templates_id}/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Request JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) – (read only)

  • name (string) – (required)

  • notes (string) –

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) – (read only)

  • name (string) – (required)

  • notes (string) –

DELETE /project/{id}/execution_templates/{execution_templates_id}/

Template(id, hidden, notes, owner, name, kind, template_data, options_data, inventory, project)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Status Codes
POST /project/{id}/execution_templates/{execution_templates_id}/execute/

Execute template with option.

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Request JSON Object

  • option (string) –

Status Codes
Response JSON Object

  • detail (string) – (required)

  • executor (integer) –

  • history_id (integer) –

GET /project/{id}/execution_templates/{execution_templates_id}/option/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

  • 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.

  • 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) – (read only)

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

POST /project/{id}/execution_templates/{execution_templates_id}/option/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

Request JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (required)

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (required)

GET /project/{id}/execution_templates/{execution_templates_id}/option/{option_id}/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

  • option_id (string) –

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (read only)

PUT /project/{id}/execution_templates/{execution_templates_id}/option/{option_id}/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

  • option_id (string) –

Request JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (read only)

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (read only)

PATCH /project/{id}/execution_templates/{execution_templates_id}/option/{option_id}/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

  • option_id (string) –

Request JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (read only)

Status Codes
Response JSON Object

  • data (string) – (required)

  • id (string) – (read only)

  • kind (string) – (read only)

  • name (string) – (read only)

DELETE /project/{id}/execution_templates/{execution_templates_id}/option/{option_id}/

TemplateOption(template, id, name, data)

Parameters

  • execution_templates_id (integer) – A unique integer value identifying instance of this template sublist.

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

  • option_id (string) –

Status Codes
GET /project/{id}/history/

History(id, hidden, project, inventory, mode, revision, kind, start_time, stop_time, raw_args, json_args, raw_inventory, status, initiator, initiator_type, executor, json_options)

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.

  • mode (string) – Module or playbook name.

  • kind (string) – Kind of execution.

  • status (string) – Status of execution.

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

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

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

  • older (string) – Older then this time

  • newer (string) – Newer then this time

  • 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 (integer) – (read only)

  • results[].kind (string) –

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

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

  • results[].revision (string) –

  • results[].start_time (string) –

  • results[].status (string) –

  • results[].stop_time (string) –

GET /project/{id}/history/{history_id}/

History(id, hidden, project, inventory, mode, revision, kind, start_time, stop_time, raw_args, json_args, raw_inventory, status, initiator, initiator_type, executor, json_options)

Parameters

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

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

Status Codes
Response JSON Object

  • execute_args (string) – (read only)

  • execution_time (integer) – (required)

  • executor (string) – (required)

  • id (integer) – (read only)

  • initiator (integer) –

  • initiator_type (string) –

  • inventory (integer) – (read only)

  • 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) –

  • stop_time (string) –

DELETE /project/{id}/history/{history_id}/

History(id, hidden, project, inventory, mode, revision, kind, start_time, stop_time, raw_args, json_args, raw_inventory, status, initiator, initiator_type, executor, json_options)

Parameters

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

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

Status Codes
POST /project/{id}/history/{history_id}/cancel/

Cencel working task.

Parameters

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

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

Status Codes
Response JSON Object

  • detail (string) – (required)

DELETE /project/{id}/history/{history_id}/clear/

Clear history output.

Parameters

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

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

Status Codes
GET /project/{id}/history/{history_id}/facts/

Get compilated history facts (only for execution ‘module’ with module ‘setup’).

Parameters

  • history_id (integer) – A unique integer value identifying instance of this history sublist.

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

Status Codes
Response JSON Object

  • facts (string) – (read only)

GET /project/{id}/inventory/

Return all inventories.

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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

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

  • results[].name (string) –

POST /project/{id}/inventory/

Create a new inventory.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

POST /project/{id}/inventory/file_import_inventory/

Create a new inventory.

Parameters

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

Request JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (string) – (read only)

Status Codes
Response JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (string) – (read only)

POST /project/{id}/inventory/import_inventory/

Create a new inventory.

Parameters

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

Request JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (string) – (required)

Status Codes
Response JSON Object

  • inventory_id (integer) – (read only)

  • name (string) – (required)

  • raw_data (string) – (required)

GET /project/{id}/inventory/{inventory_id}/

Return a inventory instance.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PUT /project/{id}/inventory/{inventory_id}/

Update a inventory.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PATCH /project/{id}/inventory/{inventory_id}/

Update one or more fields on an existing inventory.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

DELETE /project/{id}/inventory/{inventory_id}/

Remove an existing inventory.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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 (integer) – A unique integer value identifying instance of this inventories sublist.

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.

  • 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.

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

  • 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[].from_project (boolean) – (required)

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

  • results[].name (string) –

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

Return a group instance.

Parameters

  • all_groups_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /project/{id}/inventory/{inventory_id}/all_hosts/

Return all hosts.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

  • 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

  • all_hosts_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • 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 (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • 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 (integer) – A unique integer value identifying instance of this inventories sublist.

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.

  • 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.

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

  • 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[].from_project (boolean) – (required)

  • 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 (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Return a group instance.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update a group.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update one or more fields on an existing group.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Remove an existing group.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/copy/

Endpoint which copy instance with deps.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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/

Return all groups.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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.

  • children (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[].children (boolean) –

  • results[].from_project (boolean) – (required)

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

  • results[].name (string) –

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

Create a new group.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) –

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Return a group instance.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update a group.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Update one or more fields on an existing group.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • children (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

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

Remove an existing group.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
GET /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/

Return all hosts.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

  • 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

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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

Endpoint which copy instance with deps.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

POST /project/{id}/inventory/{inventory_id}/group/{group_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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 instance.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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 instance.

Parameters

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

  • group_id (string) –

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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

Status Codes
POST /project/{id}/inventory/{inventory_id}/group/{group_id}/set_owner/

Change instance owner.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/

Create a new variable of instance.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Return a variable of instance.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Update variable value.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Remove an existing variable.

Parameters

  • group_id (string) –

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

  • 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 (integer) – A unique integer value identifying instance of this inventories 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.

  • 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.

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

  • 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[].from_project (boolean) – (read only)

  • 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 (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Return a host instance.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update a host.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Update one or more fields on an existing host.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

  • type (string) –

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

Remove an existing host.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Status Codes
POST /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

Status Codes
Response JSON Object

  • from_project (boolean) – (read only)

  • id (integer) – (read only)

  • name (string) –

  • type (string) –

POST /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/set_owner/

Change instance owner.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

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

Return all variables of instance.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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 instance.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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 instance.

Parameters

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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

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

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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

Status Codes
POST /project/{id}/inventory/{inventory_id}/set_owner/

Change instance owner.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

GET /project/{id}/inventory/{inventory_id}/variables/

Return all variables of instance.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/

Create a new variable of instance.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Return a variable of instance.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Update variable value.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories 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}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

  • inventory_id (integer) – A unique integer value identifying instance of this inventories sublist.

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

Status Codes
GET /project/{id}/module/

Return all available modules of project.

Parameters

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

Query Parameters

  • path (string) – Full path to module.

  • name (string) – Name of module.

  • path__not (string) – Full path to module.

  • 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) – (read only)

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

GET /project/{id}/module/{module_id}/

Return a module details of project instance.

Parameters

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

  • module_id (string) –

Status Codes
Response JSON Object

  • data (string) – (read only)

  • id (integer) – (read only)

  • name (string) – (read only)

  • path (string) – (required)

GET /project/{id}/periodic_task/

Return all periodic tasks in project.

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.

  • mode (string) – Periodic task module or playbook name.

  • kind (string) – Kind of periodic task.

  • type (string) – Instance type.

  • template (number) – A unique integer id of template used in periodic task.

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

  • name (string) – A name string value (or comma separated list) of 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[].inventory (string) –

  • results[].kind (string) –

  • results[].mode (string) –

  • results[].name (string) –

  • results[].save_result (boolean) –

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

  • results[].template (string) –

  • results[].template_opt (string) –

  • results[].type (string) –

POST /project/{id}/periodic_task/

Create a new periodic task.

Parameters

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

Request JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

Status Codes
Response JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

GET /project/{id}/periodic_task/{periodic_task_id}/

Return a perodic task instance.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Status Codes
Response JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

PUT /project/{id}/periodic_task/{periodic_task_id}/

Update a periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Request JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

Status Codes
Response JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

PATCH /project/{id}/periodic_task/{periodic_task_id}/

Update one or more fields on an existing periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Request JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

Status Codes
Response JSON Object

  • enabled (boolean) –

  • id (integer) – (read only)

  • inventory (string) –

  • kind (string) –

  • mode (string) –

  • name (string) –

  • notes (string) –

  • save_result (boolean) –

  • schedule (string) – (required)

  • template (string) –

  • template_opt (string) –

  • type (string) –

DELETE /project/{id}/periodic_task/{periodic_task_id}/

Remove an existing periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Status Codes
POST /project/{id}/periodic_task/{periodic_task_id}/execute/

Ad-hoc execute periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Status Codes
Response JSON Object

  • detail (string) – (required)

  • executor (integer) –

  • history_id (integer) –

GET /project/{id}/periodic_task/{periodic_task_id}/variables/

Return all variables of periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task 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[].kind (string) – (read only)

  • results[].value (string) –

POST /project/{id}/periodic_task/{periodic_task_id}/variables/

Create a new variable of periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

Request JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

GET /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Return a variable of periodic task.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task 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)

  • kind (string) – (read only)

  • value (string) –

PUT /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Update variable value.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

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

Request JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

PATCH /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

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

Request JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • key (string) – (required)

  • kind (string) – (read only)

  • value (string) –

DELETE /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Remove an existing variable.

Parameters

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

  • periodic_task_id (integer) – A unique integer value identifying instance of this periodic_task sublist.

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

Status Codes
GET /project/{id}/playbook/

Return all playbooks of project.

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.

  • playbook (string) – Playbook filename.

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

  • 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.

  • playbook__not (string) – Playbook filename.

  • 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}/playbook/{playbook_id}/

Return a playbook of project instance.

Parameters

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

  • playbook_id (integer) – A unique integer value identifying instance of this playbook sublist.

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) –

  • playbook (string) – (read only)

POST /project/{id}/set_owner/

Change instance owner.

Parameters

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

POST /project/{id}/sync/

Sync project with repository.

Parameters

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

Status Codes
Response JSON Object

  • detail (string) – (required)

GET /project/{id}/variables/

Return all variables of instance.

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/

Create a new variable of instance.

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

Return a variable of instance.

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

Update variable 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}/

Update one or more fields on an existing variable.

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

Remove an existing variable.

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 /team/

Return all teams.

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 (integer) – (read only)

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

POST /team/

Create a new team.

Request JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

GET /team/{id}/

Return a team instance.

Parameters

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

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PUT /team/{id}/

Update a team.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

PATCH /team/{id}/

Update one or more fields on an existing team.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

  • notes (string) –

  • owner.email (string) –

  • owner.id (integer) – (read only)

  • owner.is_active (boolean) –

  • owner.username (string) – Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (required)

DELETE /team/{id}/

Remove an existing team.

Parameters

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

Status Codes
POST /team/{id}/copy/

Endpoint which copy instance with deps.

Parameters

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

Request JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

Status Codes
Response JSON Object

  • id (integer) – (read only)

  • name (string) – (required)

POST /team/{id}/set_owner/

Change instance owner.

Parameters

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

Request JSON Object

  • user_id (integer) – (required)

Status Codes
Response JSON Object

  • user_id (integer) – (required)

GET /team/{id}/user/

Return all users.

Parameters

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

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 /team/{id}/user/

Create a new user.

Parameters

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

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 /team/{id}/user/{user_id}/

Return a user instance.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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 /team/{id}/user/{user_id}/

Update a user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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 /team/{id}/user/{user_id}/

Update one or more fields on an existing user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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 /team/{id}/user/{user_id}/

Remove an existing user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

Status Codes
GET /team/{id}/user/{user_id}/_settings/

Return all users.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

Status Codes
Response JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

PUT /team/{id}/user/{user_id}/_settings/

Update a user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

Request JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

Status Codes
Response JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

POST /team/{id}/user/{user_id}/change_password/

Create a new user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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 /team/{id}/user/{user_id}/copy/

Endpoint which copy instance with deps.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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 /team/{id}/user/{user_id}/twofa/

Return all users.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

Status Codes
Response JSON Object

  • enabled (boolean) – (read only)

  • pin (string) –

  • recovery (string) –

  • secret (string) –

PUT /team/{id}/user/{user_id}/twofa/

Update a user.

Parameters

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

  • user_id (integer) – A unique integer value identifying instance of this users sublist.

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) –

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/
Parameters

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

Status Codes
Response JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

PUT /user/{id}/_settings/
Parameters

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

Request JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

Status Codes
Response JSON Object

  • custom (string) –

  • main.dark_mode (boolean) –

  • main.language (string) –

POST /user/{id}/change_password/
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}/twofa/
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/
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) –