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

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

API Paths

GET /community_template/

List of community project templates.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/community_template/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "example type"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (ProjectTemplate Schema)

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

GET /community_template/{id}/

Return a community project template instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "description": "example description",
    "type": "example type",
    "repository": "example repository"
}
JSON Parameters
  • id (integer) – Id

  • name (string) – Name(maxLength=1024, minLength=1)

  • description (string) – Description(minLength=1)

  • type (string) – Type(enum=[‘GIT’, ‘TAR’])

  • repository (string) – Repository(maxLength=2048, minLength=1)

param integer id(required)

A unique value identifying this project template.

POST /community_template/{id}/use_it/

Create project based on this template.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "project_id": 1,
    "name": "example name"
}
JSON Parameters
  • project_id (integer) – Project id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘project’)]))]), x-nullable=True)

  • name (string) – Name(minLength=1)

param integer id(required)

A unique value identifying this project template.

query schema data(required)

ProjectTemplateCreate Schema

GET /group/

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /group/

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

Query Parameters
GET /group/{id}/

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this group.

PUT /group/{id}/

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneGroup Schema

PATCH /group/{id}/

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneGroup Schema

DELETE /group/{id}/

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this group.

POST /group/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

GroupCopy Schema

GET /group/{id}/groups/

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/groups/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer id(required)

A unique integer value identifying this group.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /group/{id}/groups/

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

GroupCreateMaster Schema

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

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

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneGroup Schema

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

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneGroup Schema

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

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

GroupCopy Schema

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

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/groups/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/groups/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/groups/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /group/{id}/hosts/

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /group/{id}/hosts/

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

POST /group/{id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

SetOwner Schema

GET /group/{id}/variables/

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/group/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer id(required)

A unique integer value identifying this group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /group/{id}/variables/

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this group.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this group.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /history/

Return all history of executions.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/history/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "start_time": "2019-01-07T06:10:31+10:00",
            "executor": "test_dynamic",
            "initiator": 1,
            "initiator_type": "example initiator_type",
            "project": 1,
            "inventory": null,
            "kind": "example kind",
            "mode": "example mode",
            "options": "example options",
            "status": "example status",
            "stop_time": "2019-01-07T06:10:31+10:00"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (History Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string mode

Module or playbook name.

query string kind

Kind of execution.

query string status

Status of execution.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string name__not

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

query string older

Older then this time

query string newer

Newer then this time

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

GET /history/{id}/

Return a execution history instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "status": "example status",
    "executor": "test_dynamic",
    "project": 1,
    "revision": "example revision",
    "inventory": null,
    "kind": "example kind",
    "mode": "example mode",
    "execute_args": "example execute_args",
    "execution_time": "22:11:34",
    "start_time": "2019-01-07T06:10:31+10:00",
    "stop_time": "2019-01-07T06:10:31+10:00",
    "initiator": 1,
    "initiator_type": "example initiator_type",
    "options": "example options",
    "raw_args": "example raw_args",
    "raw_stdout": "example raw_stdout",
    "raw_inventory": "example raw_inventory"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • status (string) – Status(enum=[‘DELAY’, ‘RUN’, ‘OK’, ‘ERROR’, ‘OFFLINE’, ‘INTERRUPTED’])

  • executor (dynamic) – Executor

  • project (integer) – Project(x-nullable=True)

  • revision (string) – Revision(maxLength=256, x-nullable=True)

  • inventory (inventory) – Inventory(x-nullable=True)

  • kind (string) – Kind(maxLength=50, minLength=1)

  • mode (string) – Mode(maxLength=256, minLength=1)

  • execute_args (string) – Execute args(readOnly=True)

  • execution_time (uptime) – Execution time

  • start_time (date-time) – Start time

  • stop_time (date-time) – Stop time(x-nullable=True)

  • initiator (integer) – Initiator

  • initiator_type (string) – Initiator type(maxLength=50, minLength=1)

  • options (string) – Options(readOnly=True)

  • raw_args (string) – Raw args(minLength=1)

  • raw_stdout (string) – Raw stdout(readOnly=True)

  • raw_inventory (string) – Raw inventory(minLength=1)

param integer id(required)

A unique integer value identifying this history.

DELETE /history/{id}/

Remove an existing history record.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this history.

POST /history/{id}/cancel/

Cencel working task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "detail": "example detail"
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

param integer id(required)

A unique integer value identifying this history.

query schema data(required)

Empty Schema

DELETE /history/{id}/clear/

Clear history output.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this history.

GET /history/{id}/facts/

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "facts": null
}
JSON Parameters
  • facts (json) – Facts(readOnly=True)

param integer id(required)

A unique integer value identifying this history.

GET /hook/

Return all hooks.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/hook/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "example type",
            "when": "example when",
            "enable": true,
            "recipients": "example recipients"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Hook Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /hook/

Create a new hook.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "example type",
    "when": "example when",
    "enable": true,
    "recipients": "example recipients"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HTTP’, ‘SCRIPT’])

  • when (string) – When(enum=[‘on_execution’, ‘after_execution’, ‘on_user_add’, ‘on_user_upd’, ‘on_user_del’, ‘on_object_add’, ‘on_object_upd’, ‘on_object_del’])

  • enable (boolean) – Enable

  • recipients (string) – Recipients(minLength=1)

Query Parameters
GET /hook/{id}/

Return a hook instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "example type",
    "when": "example when",
    "enable": true,
    "recipients": "example recipients"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HTTP’, ‘SCRIPT’])

  • when (string) – When(enum=[‘on_execution’, ‘after_execution’, ‘on_user_add’, ‘on_user_upd’, ‘on_user_del’, ‘on_object_add’, ‘on_object_upd’, ‘on_object_del’])

  • enable (boolean) – Enable

  • recipients (string) – Recipients(minLength=1)

param integer id(required)

A unique integer value identifying this hook.

PUT /hook/{id}/

Update a hook.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "example type",
    "when": "example when",
    "enable": true,
    "recipients": "example recipients"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HTTP’, ‘SCRIPT’])

  • when (string) – When(enum=[‘on_execution’, ‘after_execution’, ‘on_user_add’, ‘on_user_upd’, ‘on_user_del’, ‘on_object_add’, ‘on_object_upd’, ‘on_object_del’])

  • enable (boolean) – Enable

  • recipients (string) – Recipients(minLength=1)

param integer id(required)

A unique integer value identifying this hook.

query schema data(required)

Hook Schema

PATCH /hook/{id}/

Update one or more fields on an existing hook.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "example type",
    "when": "example when",
    "enable": true,
    "recipients": "example recipients"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HTTP’, ‘SCRIPT’])

  • when (string) – When(enum=[‘on_execution’, ‘after_execution’, ‘on_user_add’, ‘on_user_upd’, ‘on_user_del’, ‘on_object_add’, ‘on_object_upd’, ‘on_object_del’])

  • enable (boolean) – Enable

  • recipients (string) – Recipients(minLength=1)

param integer id(required)

A unique integer value identifying this hook.

query schema data(required)

Hook Schema

DELETE /hook/{id}/

Remove an existing hook.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this hook.

GET /host/

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/host/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /host/

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

Query Parameters
GET /host/{id}/

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this host.

PUT /host/{id}/

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this host.

query schema data(required)

OneHost Schema

PATCH /host/{id}/

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this host.

query schema data(required)

OneHost Schema

DELETE /host/{id}/

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this host.

POST /host/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer id(required)

A unique integer value identifying this host.

query schema data(required)

Host Schema

POST /host/{id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this host.

query schema data(required)

SetOwner Schema

GET /host/{id}/variables/

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/host/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer id(required)

A unique integer value identifying this host.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /host/{id}/variables/

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this host.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this host.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this host.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this host.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this host.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /inventory/

Return all inventories.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Inventory)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /inventory/

Create a new inventory.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

Query Parameters
POST /inventory/import_inventory/

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "inventory_id": 1,
    "name": "example name",
    "raw_data": "value data"
}
JSON Parameters
  • inventory_id (integer) – Inventory id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘inventory’)]))]), x-nullable=True)

  • name (string) – Name(minLength=1)

  • raw_data (file) – Raw data(x-options=OrderedDict([(‘media_types’, [’/’])]))

Query Parameters
GET /inventory/{id}/

Return a inventory instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this inventory.

PUT /inventory/{id}/

Update a inventory.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneInventory Schema

PATCH /inventory/{id}/

Update one or more fields on an existing inventory.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneInventory Schema

DELETE /inventory/{id}/

Remove an existing inventory.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this inventory.

GET /inventory/{id}/all_groups/

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/all_groups/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer id(required)

A unique integer value identifying this inventory.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string all_groups_id(required)

param integer id(required)

A unique integer value identifying this inventory.

GET /inventory/{id}/all_hosts/

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/all_hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string all_hosts_id(required)

param integer id(required)

A unique integer value identifying this inventory.

POST /inventory/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • from_project (boolean) – Project based(readOnly=True)

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

Inventory

GET /inventory/{id}/group/

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/group/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer id(required)

A unique integer value identifying this inventory.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /inventory/{id}/group/

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

GroupCreateMaster Schema

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneGroup Schema

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

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneGroup Schema

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

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

GroupCopy Schema

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

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/group/1/groups/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query boolean children

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

GroupCreateMaster Schema

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneGroup Schema

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

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneGroup Schema

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

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/group/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/group/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/group/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer group_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /inventory/{id}/hosts/

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /inventory/{id}/hosts/

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

POST /inventory/{id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

SetOwner Schema

GET /inventory/{id}/variables/

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/inventory/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer id(required)

A unique integer value identifying this inventory.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /inventory/{id}/variables/

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this inventory.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this inventory.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /project/

Return all projects.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "example type",
            "status": "example status"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Project Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array status

Project sync status.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array status__not

Project sync status.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/

Create a new project.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "status": "example status",
    "type": "MANUAL",
    "repository": "MANUAL",
    "repo_auth": "NONE",
    "auth_data": "test_dynamic",
    "branch": "test_dynamic",
    "additional_playbook_path": "example additional_playbook_path"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • status (string) – Status(readOnly=True, minLength=1)

  • type (string) – Repo type(enum=[‘MANUAL’, ‘GIT’, ‘TAR’], default=MANUAL)

  • repository (dynamic) – Repo url

  • repo_auth (dynamic) – Repo auth type

  • auth_data (dynamic) – Repo auth data

  • branch (dynamic) – Branch for GIT (branch/tag/SHA) or TAR (subdir)

  • additional_playbook_path (string) – Directory with playbooks(minLength=1, x-nullable=True)

Query Parameters
GET /project/{id}/

Return a project instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "repository": "MANUAL",
    "status": "example status",
    "revision": "example revision",
    "branch": "example branch",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    },
    "notes": "example\ntext\narea\n",
    "readme_content": "test_html",
    "execute_view_data": {}
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • repository (string) – Repository(default=MANUAL, minLength=1)

  • status (string) – Status(enum=[‘NEW’, ‘ERROR’, ‘OK’, ‘WAIT_SYNC’, ‘SYNC’], readOnly=True)

  • revision (string) – Revision(readOnly=True)

  • branch (string) – Branch(readOnly=True)

  • owner (object) – (User Schema)

  • notes (textarea) – Notes

  • readme_content (html) – Information(readOnly=True)

  • execute_view_data (object) – (Data Schema)

param integer id(required)

A unique integer value identifying this project.

PUT /project/{id}/

Update a project.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "repository": "MANUAL",
    "status": "example status",
    "revision": "example revision",
    "branch": "example branch",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    },
    "notes": "example\ntext\narea\n",
    "readme_content": "test_html",
    "execute_view_data": {}
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • repository (string) – Repository(default=MANUAL, minLength=1)

  • status (string) – Status(enum=[‘NEW’, ‘ERROR’, ‘OK’, ‘WAIT_SYNC’, ‘SYNC’], readOnly=True)

  • revision (string) – Revision(readOnly=True)

  • branch (string) – Branch(readOnly=True)

  • owner (object) – (User Schema)

  • notes (textarea) – Notes

  • readme_content (html) – Information(readOnly=True)

  • execute_view_data (object) – (Data Schema)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OneProject Schema

PATCH /project/{id}/

Update one or more fields on an existing project.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "repository": "MANUAL",
    "status": "example status",
    "revision": "example revision",
    "branch": "example branch",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    },
    "notes": "example\ntext\narea\n",
    "readme_content": "test_html",
    "execute_view_data": {}
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • repository (string) – Repository(default=MANUAL, minLength=1)

  • status (string) – Status(enum=[‘NEW’, ‘ERROR’, ‘OK’, ‘WAIT_SYNC’, ‘SYNC’], readOnly=True)

  • revision (string) – Revision(readOnly=True)

  • branch (string) – Branch(readOnly=True)

  • owner (object) – (User Schema)

  • notes (textarea) – Notes

  • readme_content (html) – Information(readOnly=True)

  • execute_view_data (object) – (Data Schema)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OneProject Schema

DELETE /project/{id}/

Remove an existing project.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

POST /project/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "example type",
    "status": "example status"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(readOnly=True, minLength=1)

  • status (string) – Status(enum=[‘NEW’, ‘ERROR’, ‘OK’, ‘WAIT_SYNC’, ‘SYNC’], readOnly=True)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

Project Schema

POST /project/{id}/execute_module/

Execute ansible -m [module] with arguments.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "detail": "example detail",
    "history_id": 1,
    "executor": 1
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

  • history_id (integer) – History id(x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘history’)]))]), x-nullable=True)

  • executor (integer) – Executor(x-nullable=True)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

AnsibleModule Schema

POST /project/{id}/execute_playbook/

Execute ansible-playbook with arguments.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "detail": "example detail",
    "history_id": 1,
    "executor": 1
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

  • history_id (integer) – History id(x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘history’)]))]), x-nullable=True)

  • executor (integer) – Executor(x-nullable=True)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

AnsiblePlaybook Schema

GET /project/{id}/execution_templates/

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/execution_templates/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "kind": "Task"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (ExecutionTemplate Schema)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string kind

A kind of template.

query string inventory

The inventory id or path in project.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/execution_templates/

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

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "Task",
    "notes": "example notes",
    "inventory": null,
    "data": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Type(enum=[‘Task’, ‘Module’], default=Task)

  • notes (string) – Notes(minLength=1)

  • inventory (inventory) – Inventory

  • data (dynamic) – Data

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

CreateExecutionTemplate Schema

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

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "example kind",
    "notes": "example notes",
    "inventory": null,
    "data": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Type(enum=[‘Task’, ‘Module’], readOnly=True)

  • notes (string) – Notes(minLength=1)

  • inventory (inventory) – Inventory

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

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

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "example kind",
    "notes": "example notes",
    "inventory": null,
    "data": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Type(enum=[‘Task’, ‘Module’], readOnly=True)

  • notes (string) – Notes(minLength=1)

  • inventory (inventory) – Inventory

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OneExecutionTemplate Schema

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

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "example kind",
    "notes": "example notes",
    "inventory": null,
    "data": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Type(enum=[‘Task’, ‘Module’], readOnly=True)

  • notes (string) – Notes(minLength=1)

  • inventory (inventory) – Inventory

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OneExecutionTemplate Schema

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

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

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

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

Execute template with option.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "detail": "example detail",
    "history_id": 1,
    "executor": 1
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

  • history_id (integer) – History id(x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘history’)]))]), x-nullable=True)

  • executor (integer) – Executor(x-nullable=True)

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

TemplateExec Schema

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/execution_templates/1/option/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": "example id",
            "name": "example name"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (TemplateOption Schema)

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": "example id",
    "name": "example name",
    "kind": "example kind",
    "data": "test_dynamic"
}
JSON Parameters
  • id (string) – Id(readOnly=True, minLength=1)

  • name (string) – Name(maxLength=256, minLength=1)

  • kind (string) – Kind(readOnly=True, minLength=1)

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

CreateTemplateOption Schema

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": "example id",
    "name": "example name",
    "kind": "example kind",
    "data": "test_dynamic"
}
JSON Parameters
  • id (string) – Id(readOnly=True, minLength=1)

  • name (string) – Name(readOnly=True, minLength=1)

  • kind (string) – Kind(readOnly=True, minLength=1)

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

param string option_id(required)

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": "example id",
    "name": "example name",
    "kind": "example kind",
    "data": "test_dynamic"
}
JSON Parameters
  • id (string) – Id(readOnly=True, minLength=1)

  • name (string) – Name(readOnly=True, minLength=1)

  • kind (string) – Kind(readOnly=True, minLength=1)

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

param string option_id(required)
query schema data(required)

OneTemplateOption Schema

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": "example id",
    "name": "example name",
    "kind": "example kind",
    "data": "test_dynamic"
}
JSON Parameters
  • id (string) – Id(readOnly=True, minLength=1)

  • name (string) – Name(readOnly=True, minLength=1)

  • kind (string) – Kind(readOnly=True, minLength=1)

  • data (dynamic) – Data

param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

param string option_id(required)
query schema data(required)

OneTemplateOption Schema

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

TemplateOption(template, id, name, data)

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer execution_templates_id(required)

A unique integer value identifying instance of this template sublist.

param integer id(required)

A unique integer value identifying this project.

param string option_id(required)

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)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/history/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "start_time": "2019-01-07T06:10:31+10:00",
            "executor": "test_dynamic",
            "initiator": 1,
            "initiator_type": "example initiator_type",
            "revision": "example revision",
            "inventory": null,
            "kind": "example kind",
            "mode": "example mode",
            "options": "example options",
            "status": "example status",
            "stop_time": "2019-01-07T06:10:31+10:00"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (ProjectHistory Schema)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string mode

Module or playbook name.

query string kind

Kind of execution.

query string status

Status of execution.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string name__not

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

query string older

Older then this time

query string newer

Newer then this time

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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)

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "status": "example status",
    "executor": "test_dynamic",
    "project": 1,
    "revision": "example revision",
    "inventory": null,
    "kind": "example kind",
    "mode": "example mode",
    "execute_args": "example execute_args",
    "execution_time": "22:11:34",
    "start_time": "2019-01-07T06:10:31+10:00",
    "stop_time": "2019-01-07T06:10:31+10:00",
    "initiator": 1,
    "initiator_type": "example initiator_type",
    "options": "example options",
    "raw_args": "example raw_args",
    "raw_stdout": "example raw_stdout",
    "raw_inventory": "example raw_inventory"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • status (string) – Status(enum=[‘DELAY’, ‘RUN’, ‘OK’, ‘ERROR’, ‘OFFLINE’, ‘INTERRUPTED’])

  • executor (dynamic) – Executor

  • project (integer) – Project(x-nullable=True)

  • revision (string) – Revision(maxLength=256, x-nullable=True)

  • inventory (inventory) – Inventory(x-nullable=True)

  • kind (string) – Kind(maxLength=50, minLength=1)

  • mode (string) – Mode(maxLength=256, minLength=1)

  • execute_args (string) – Execute args(readOnly=True)

  • execution_time (uptime) – Execution time

  • start_time (date-time) – Start time

  • stop_time (date-time) – Stop time(x-nullable=True)

  • initiator (integer) – Initiator

  • initiator_type (string) – Initiator type(maxLength=50, minLength=1)

  • options (string) – Options(readOnly=True)

  • raw_args (string) – Raw args(minLength=1)

  • raw_stdout (string) – Raw stdout(readOnly=True)

  • raw_inventory (string) – Raw inventory(minLength=1)

param integer history_id(required)

A unique integer value identifying instance of this history sublist.

param integer id(required)

A unique integer value identifying this project.

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)

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer history_id(required)

A unique integer value identifying instance of this history sublist.

param integer id(required)

A unique integer value identifying this project.

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

Cencel working task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "detail": "example detail"
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

param integer history_id(required)

A unique integer value identifying instance of this history sublist.

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

Empty Schema

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

Clear history output.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer history_id(required)

A unique integer value identifying instance of this history sublist.

param integer id(required)

A unique integer value identifying this project.

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

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

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "facts": null
}
JSON Parameters
  • facts (json) – Facts(readOnly=True)

param integer history_id(required)

A unique integer value identifying instance of this history sublist.

param integer id(required)

A unique integer value identifying this project.

GET /project/{id}/inventory/

Return all inventories.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Inventory)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/inventory/

Create a new inventory.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OneInventory Schema

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

Create a new inventory.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "inventory_id": 1,
    "name": "example name",
    "raw_data": "example raw_data"
}
JSON Parameters
  • inventory_id (integer) – Inventory id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘inventory’)]))]), x-nullable=True)

  • name (string) – Name(pattern=^([wd_-]+|[.][/wd_-+=^,])(.?[wd-/\_()+=^,]+)+$, minLength=1)

  • raw_data (string) – Raw data(readOnly=True, minLength=1)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

InventoryFileImport Schema

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

Create a new inventory.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "inventory_id": 1,
    "name": "example name",
    "raw_data": "value data"
}
JSON Parameters
  • inventory_id (integer) – Inventory id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘inventory’)]))]), x-nullable=True)

  • name (string) – Name(minLength=1)

  • raw_data (file) – Raw data(x-options=OrderedDict([(‘media_types’, [’/’])]))

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

InventoryImport Schema

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

Return a inventory instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Update a inventory.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneInventory Schema

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

Update one or more fields on an existing inventory.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneInventory Schema

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

Remove an existing inventory.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/all_groups/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string all_groups_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/all_hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string all_hosts_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

POST /project/{id}/inventory/{inventory_id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • from_project (boolean) – Project based(readOnly=True)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

Inventory

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

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/group/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

GroupCreateMaster Schema

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneGroup Schema

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

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneGroup Schema

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

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

GroupCopy Schema

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

Return all groups.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/group/1/groups/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "children": true,
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Group)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query integer __deep_parent

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query boolean children

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new group.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(default=False)

  • owner (object) – (User Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

GroupCreateMaster Schema

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

Return a group instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Update a group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneGroup Schema

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

Update one or more fields on an existing group.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example notes",
    "children": true,
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (string) – Notes(minLength=1)

  • children (boolean) – Contains groups(readOnly=True)

  • owner (object) – (User Schema)

param string group_id(required)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneGroup Schema

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

Remove an existing group.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param string group_id(required)

param integer groups_id(required)

A unique integer value identifying instance of this groups sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/group/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/group/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param string group_id(required)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/group/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param string group_id(required)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Return all hosts.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/hosts/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "type": "HOST",
            "from_project": true
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Host Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string type

Instance type.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string variables

List of variables to filter. Comma separated “key:value” list.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/inventory/{inventory_id}/hosts/

Create a new host.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Return a host instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

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

Update a host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Update one or more fields on an existing host.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "type": "HOST",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • notes (textarea) – Notes

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • owner (object) – (User Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

OneHost Schema

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

Remove an existing host.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

POST /project/{id}/inventory/{inventory_id}/hosts/{hosts_id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "type": "HOST",
    "from_project": true
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • type (string) – Type(enum=[‘HOST’, ‘RANGE’], default=HOST)

  • from_project (boolean) – Project based(readOnly=True)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

Host Schema

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

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/hosts/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

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

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer hosts_id(required)

A unique integer value identifying instance of this hosts sublist.

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

POST /project/{id}/inventory/{inventory_id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

SetOwner Schema

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

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/inventory/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "ansible_host",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (InventoryVariable Schema)

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/inventory/{inventory_id}/variables/

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

query schema data(required)

InventoryVariable Schema

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

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

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

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "ansible_host",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

InventoryVariable Schema

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

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

param integer inventory_id(required)

A unique integer value identifying instance of this inventories sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /project/{id}/module/

Return all available modules of project.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/module/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "path": "example path",
            "name": "example name"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Module Schema)

param integer id(required)

A unique integer value identifying this project.

query string path

Full path to module.

query string name

Name of module.

query string path__not

Full path to module.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

GET /project/{id}/module/{module_id}/

Return a module details of project instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "path": "example path",
    "name": "example name",
    "data": null
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • path (string) – Path(maxLength=1024, minLength=1)

  • name (string) – Name(readOnly=True)

  • data (json) – Data(readOnly=True)

param integer id(required)

A unique integer value identifying this project.

param string module_id(required)

GET /project/{id}/periodic_task/

Return all periodic tasks in project.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/periodic_task/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "kind": "PLAYBOOK",
            "mode": "test_dynamic",
            "inventory": null,
            "save_result": true,
            "template": "test_dynamic",
            "template_opt": "test_dynamic",
            "enabled": true,
            "type": "CRONTAB",
            "schedule": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Periodictask Schema)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string mode

Periodic task module or playbook name.

query string kind

Kind of periodic task.

query string type

Instance type.

query number template

A unique integer id of template used in periodic task.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/periodic_task/

Create a new periodic task.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "PLAYBOOK",
    "mode": "test_dynamic",
    "inventory": null,
    "save_result": true,
    "template": "test_dynamic",
    "template_opt": "test_dynamic",
    "enabled": true,
    "type": "CRONTAB",
    "schedule": "test_dynamic",
    "notes": "example\ntext\narea\n"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Task type(enum=[‘PLAYBOOK’, ‘MODULE’, ‘TEMPLATE’], default=PLAYBOOK)

  • mode (dynamic) – Mode

  • inventory (inventory) – Inventory

  • save_result (boolean) – Save result

  • template (dynamic) – Template

  • template_opt (dynamic) – Template opt

  • enabled (boolean) – Enabled

  • type (string) – Interval type(enum=[‘CRONTAB’, ‘INTERVAL’], default=CRONTAB)

  • schedule (dynamic) – Schedule

  • notes (textarea) – Notes

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

OnePeriodictask Schema

GET /project/{id}/periodic_task/{periodic_task_id}/

Return a perodic task instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "PLAYBOOK",
    "mode": "test_dynamic",
    "inventory": null,
    "save_result": true,
    "template": "test_dynamic",
    "template_opt": "test_dynamic",
    "enabled": true,
    "type": "CRONTAB",
    "schedule": "test_dynamic",
    "notes": "example\ntext\narea\n"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Task type(enum=[‘PLAYBOOK’, ‘MODULE’, ‘TEMPLATE’], default=PLAYBOOK)

  • mode (dynamic) – Mode

  • inventory (inventory) – Inventory

  • save_result (boolean) – Save result

  • template (dynamic) – Template

  • template_opt (dynamic) – Template opt

  • enabled (boolean) – Enabled

  • type (string) – Interval type(enum=[‘CRONTAB’, ‘INTERVAL’], default=CRONTAB)

  • schedule (dynamic) – Schedule

  • notes (textarea) – Notes

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

PUT /project/{id}/periodic_task/{periodic_task_id}/

Update a periodic task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "PLAYBOOK",
    "mode": "test_dynamic",
    "inventory": null,
    "save_result": true,
    "template": "test_dynamic",
    "template_opt": "test_dynamic",
    "enabled": true,
    "type": "CRONTAB",
    "schedule": "test_dynamic",
    "notes": "example\ntext\narea\n"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Task type(enum=[‘PLAYBOOK’, ‘MODULE’, ‘TEMPLATE’], default=PLAYBOOK)

  • mode (dynamic) – Mode

  • inventory (inventory) – Inventory

  • save_result (boolean) – Save result

  • template (dynamic) – Template

  • template_opt (dynamic) – Template opt

  • enabled (boolean) – Enabled

  • type (string) – Interval type(enum=[‘CRONTAB’, ‘INTERVAL’], default=CRONTAB)

  • schedule (dynamic) – Schedule

  • notes (textarea) – Notes

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

query schema data(required)

OnePeriodictask Schema

PATCH /project/{id}/periodic_task/{periodic_task_id}/

Update one or more fields on an existing periodic task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "kind": "PLAYBOOK",
    "mode": "test_dynamic",
    "inventory": null,
    "save_result": true,
    "template": "test_dynamic",
    "template_opt": "test_dynamic",
    "enabled": true,
    "type": "CRONTAB",
    "schedule": "test_dynamic",
    "notes": "example\ntext\narea\n"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=512, minLength=1)

  • kind (string) – Task type(enum=[‘PLAYBOOK’, ‘MODULE’, ‘TEMPLATE’], default=PLAYBOOK)

  • mode (dynamic) – Mode

  • inventory (inventory) – Inventory

  • save_result (boolean) – Save result

  • template (dynamic) – Template

  • template_opt (dynamic) – Template opt

  • enabled (boolean) – Enabled

  • type (string) – Interval type(enum=[‘CRONTAB’, ‘INTERVAL’], default=CRONTAB)

  • schedule (dynamic) – Schedule

  • notes (textarea) – Notes

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

query schema data(required)

OnePeriodictask Schema

DELETE /project/{id}/periodic_task/{periodic_task_id}/

Remove an existing periodic task.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

POST /project/{id}/periodic_task/{periodic_task_id}/execute/

Ad-hoc execute periodic task.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "detail": "example detail",
    "history_id": 1,
    "executor": 1
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

  • history_id (integer) – History id(x-options=OrderedDict([(‘redirect’, OrderedDict([(‘concat_field_name’, False), (‘depend_field’, None), (‘operation_name’, ‘history’)]))]), x-nullable=True)

  • executor (integer) – Executor(x-nullable=True)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

query schema data(required)

Empty Schema

GET /project/{id}/periodic_task/{periodic_task_id}/variables/

Return all variables of periodic task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/periodic_task/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "test_dynamic",
            "value": "test_dynamic",
            "kind": "example kind"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (PeriodicTaskVariable Schema)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/periodic_task/{periodic_task_id}/variables/

Create a new variable of periodic task.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "test_dynamic",
    "value": "test_dynamic",
    "kind": "example kind"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (dynamic) – Key

  • value (dynamic) – Value

  • kind (string) – (name=kind, readOnly=True, x-hidden=True)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

query schema data(required)

PeriodicTaskVariable Schema

GET /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Return a variable of periodic task.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "test_dynamic",
    "value": "test_dynamic",
    "kind": "example kind"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (dynamic) – Key

  • value (dynamic) – Value

  • kind (string) – (name=kind, readOnly=True, x-hidden=True)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

PUT /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "test_dynamic",
    "value": "test_dynamic",
    "kind": "example kind"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (dynamic) – Key

  • value (dynamic) – Value

  • kind (string) – (name=kind, readOnly=True, x-hidden=True)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

PeriodicTaskVariable Schema

PATCH /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "test_dynamic",
    "value": "test_dynamic",
    "kind": "example kind"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (dynamic) – Key

  • value (dynamic) – Value

  • kind (string) – (name=kind, readOnly=True, x-hidden=True)

param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

PeriodicTaskVariable Schema

DELETE /project/{id}/periodic_task/{periodic_task_id}/variables/{variables_id}/

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

param integer periodic_task_id(required)

A unique integer value identifying instance of this periodic_task sublist.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /project/{id}/playbook/

Return all playbooks of project.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/playbook/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name",
            "playbook": "example playbook"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Playbook Schema)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query string playbook

Playbook filename.

query string pb_filter

Playbook filename - filter for prefetch.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query string playbook__not

Playbook filename.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

GET /project/{id}/playbook/{playbook_id}/

Return a playbook of project instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "playbook": "example playbook"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • name (string) – Name(maxLength=251, minLength=1)

  • playbook (string) – Playbook(readOnly=True, minLength=1)

param integer id(required)

A unique integer value identifying this project.

param integer playbook_id(required)

A unique integer value identifying instance of this playbook sublist.

POST /project/{id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

SetOwner Schema

POST /project/{id}/sync/

Sync project with repository.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "detail": "example detail"
}
JSON Parameters
  • detail (string) – Detail(minLength=1)

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

Empty Schema

GET /project/{id}/variables/

Return all variables of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/project/1/variables/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "key": "repo_type",
            "value": "test_dynamic"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (ProjectVariable Schema)

param integer id(required)

A unique integer value identifying this project.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string key

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

query string value

A value of instance.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /project/{id}/variables/

Create a new variable of instance.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "key": "repo_type",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: repo_type, repo_sync_on_run, repo_sync_on_run_timeout, repo_branch, repo_password, repo_key, playbook_path, ci_template)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

query schema data(required)

ProjectVariable Schema

GET /project/{id}/variables/{variables_id}/

Return a variable of instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "repo_type",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: repo_type, repo_sync_on_run, repo_sync_on_run_timeout, repo_branch, repo_password, repo_key, playbook_path, ci_template)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

PUT /project/{id}/variables/{variables_id}/

Update variable value.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "repo_type",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: repo_type, repo_sync_on_run, repo_sync_on_run_timeout, repo_branch, repo_password, repo_key, playbook_path, ci_template)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

ProjectVariable Schema

PATCH /project/{id}/variables/{variables_id}/

Update one or more fields on an existing variable.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "key": "repo_type",
    "value": "test_dynamic"
}
JSON Parameters
  • id (integer) – Id(readOnly=True)

  • key (autocomplete) – Key(Example values: repo_type, repo_sync_on_run, repo_sync_on_run_timeout, repo_branch, repo_password, repo_key, playbook_path, ci_template)

  • value (dynamic) – Value

param integer id(required)

A unique integer value identifying this project.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

query schema data(required)

ProjectVariable Schema

DELETE /project/{id}/variables/{variables_id}/

Remove an existing variable.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this project.

param integer variables_id(required)

A unique integer value identifying instance of this variables sublist.

GET /team/

Return all teams.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/team/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "example name"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (Team Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string name

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

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string name__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /team/

Create a new team.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • name (string) – Name(maxLength=150, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

Query Parameters
GET /team/{id}/

Return a team instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • name (string) – Name(maxLength=150, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this user group.

PUT /team/{id}/

Update a team.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • name (string) – Name(maxLength=150, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this user group.

query schema data(required)

OneTeam Schema

PATCH /team/{id}/

Update one or more fields on an existing team.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "name": "example name",
    "notes": "example\ntext\narea\n",
    "owner": {
        "id": 1,
        "username": "example username",
        "is_active": true,
        "email": "example@mail.com"
    }
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • name (string) – Name(maxLength=150, minLength=1)

  • notes (textarea) – Notes

  • owner (object) – (User Schema)

param integer id(required)

A unique integer value identifying this user group.

query schema data(required)

OneTeam Schema

DELETE /team/{id}/

Remove an existing team.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this user group.

POST /team/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "name": "example name"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • name (string) – Name(maxLength=150, minLength=1)

param integer id(required)

A unique integer value identifying this user group.

query schema data(required)

Team Schema

POST /team/{id}/set_owner/

Change instance owner.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "user_id": 1
}
JSON Parameters
  • user_id (fk) – New owner(x-options=OrderedDict([(‘dependence’, None), (‘filters’, None), (‘makeLink’, True), (‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘usePrefetch’, True), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))

param integer id(required)

A unique integer value identifying this user group.

query schema data(required)

SetOwner Schema

GET /team/{id}/user/

Return all users.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/team/1/user/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "username": "example username",
            "is_active": true,
            "email": "example@mail.com"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (User Schema)

param integer id(required)

A unique integer value identifying this user group.

query array id

A unique integer value (or comma separated list) identifying this instance.

query string username

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

query boolean is_active

Boolean value meaning status of user.

query string first_name

Users first name.

query string last_name

Users last name.

query string email

Users e-mail value.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string username__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /team/{id}/user/

Create a new user.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com",
    "password": null,
    "password2": null
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

  • password (password) – Password

  • password2 (password) – Repeat password

param integer id(required)

A unique integer value identifying this user group.

query schema data(required)

CreateUser Schema

GET /team/{id}/user/{user_id}/

Return a user instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

PUT /team/{id}/user/{user_id}/

Update a user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

OneUser Schema

PATCH /team/{id}/user/{user_id}/

Update one or more fields on an existing user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

OneUser Schema

DELETE /team/{id}/user/{user_id}/

Remove an existing user.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

GET /team/{id}/user/{user_id}/_settings/

Return all users.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "main": {
        "language": "example language",
        "dark_mode": true
    },
    "custom": null
}
JSON Parameters
  • main (object) – (_MainSettings)

  • custom (json) – Custom(default=OrderedDict())

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

PUT /team/{id}/user/{user_id}/_settings/

Update a user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "main": {
        "language": "example language",
        "dark_mode": true
    },
    "custom": null
}
JSON Parameters
  • main (object) – (_MainSettings)

  • custom (json) – Custom(default=OrderedDict())

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

_UserSettings

POST /team/{id}/user/{user_id}/change_password/

Create a new user.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "old_password": null,
    "password": null,
    "password2": null
}
JSON Parameters
  • old_password (password) – Old password

  • password (password) – New password

  • password2 (password) – Confirm new password

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

ChangePassword Schema

POST /team/{id}/user/{user_id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

User Schema

GET /team/{id}/user/{user_id}/twofa/

Return all users.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "enabled": true,
    "secret": "example secret",
    "pin": "example pin",
    "recovery": "example recovery"
}
JSON Parameters
  • enabled (boolean) – Enabled(readOnly=True)

  • secret (string) – Secret(minLength=1, x-nullable=True)

  • pin (string) – Enter the six-digit code from the application(minLength=1)

  • recovery (string) – Recovery(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

PUT /team/{id}/user/{user_id}/twofa/

Update a user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "enabled": true,
    "secret": "example secret",
    "pin": "example pin",
    "recovery": "example recovery"
}
JSON Parameters
  • enabled (boolean) – Enabled(readOnly=True)

  • secret (string) – Secret(minLength=1, x-nullable=True)

  • pin (string) – Enter the six-digit code from the application(minLength=1)

  • recovery (string) – Recovery(minLength=1)

param integer id(required)

A unique integer value identifying this user group.

param integer user_id(required)

A unique integer value identifying instance of this users sublist.

query schema data(required)

TwoFA Schema

GET /user/

Return all users.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "count": 2,
    "next": "http://localhost:8080/user/?limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 1,
            "username": "example username",
            "is_active": true,
            "email": "example@mail.com"
        }
    ]
}
JSON Parameters
  • count (integer) – None

  • next (uri) – (x-nullable=True)

  • previous (uri) – (x-nullable=True)

  • results (array) – (User Schema)

query array id

A unique integer value (or comma separated list) identifying this instance.

query string username

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

query boolean is_active

Boolean value meaning status of user.

query string first_name

Users first name.

query string last_name

Users last name.

query string email

Users e-mail value.

query array id__not

A unique integer value (or comma separated list) identifying this instance.

query string username__not

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

query array ordering

Which field to use when ordering the results.

query string __search

A search term.

query integer limit

Number of results to return per page.

query integer offset

The initial index from which to return the results.

POST /user/

Create a new user.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com",
    "password": null,
    "password2": null
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

  • password (password) – Password

  • password2 (password) – Repeat password

Query Parameters
GET /user/{id}/

Return a user instance.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user.

PUT /user/{id}/

Update a user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

OneUser Schema

PATCH /user/{id}/

Update one or more fields on an existing user.

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • first_name (string) – First name(maxLength=150)

  • last_name (string) – Last name(maxLength=150)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

OneUser Schema

DELETE /user/{id}/

Remove an existing user.

Example Response

HTTP/1.1 204 No Content
Vary: NO CONTENT
Content-Type: application/json

{}
param integer id(required)

A unique integer value identifying this user.

GET /user/{id}/_settings/

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "main": {
        "language": "example language",
        "dark_mode": true
    },
    "custom": null
}
JSON Parameters
  • main (object) – (_MainSettings)

  • custom (json) – Custom(default=OrderedDict())

param integer id(required)

A unique integer value identifying this user.

PUT /user/{id}/_settings/

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "main": {
        "language": "example language",
        "dark_mode": true
    },
    "custom": null
}
JSON Parameters
  • main (object) – (_MainSettings)

  • custom (json) – Custom(default=OrderedDict())

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

_UserSettings

POST /user/{id}/change_password/

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "old_password": null,
    "password": null,
    "password2": null
}
JSON Parameters
  • old_password (password) – Old password

  • password (password) – New password

  • password2 (password) – Confirm new password

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

ChangePassword Schema

POST /user/{id}/copy/

Endpoint which copy instance with deps.

Example Response

HTTP/1.1 201 Created
Vary: CREATED
Content-Type: application/json


{
    "id": 1,
    "username": "example username",
    "is_active": true,
    "email": "example@mail.com"
}
JSON Parameters
  • id (integer) – ID(readOnly=True)

  • username (string) – Username(description=Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only., pattern=^[w.@+-]+$, maxLength=150, minLength=1)

  • is_active (boolean) – Is active(default=True)

  • email (email) – Email(minLength=1)

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

User Schema

GET /user/{id}/twofa/

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "enabled": true,
    "secret": "example secret",
    "pin": "example pin",
    "recovery": "example recovery"
}
JSON Parameters
  • enabled (boolean) – Enabled(readOnly=True)

  • secret (string) – Secret(minLength=1, x-nullable=True)

  • pin (string) – Enter the six-digit code from the application(minLength=1)

  • recovery (string) – Recovery(minLength=1)

param integer id(required)

A unique integer value identifying this user.

PUT /user/{id}/twofa/

Example Response

HTTP/1.1 200 OK
Vary: OK
Content-Type: application/json


{
    "enabled": true,
    "secret": "example secret",
    "pin": "example pin",
    "recovery": "example recovery"
}
JSON Parameters
  • enabled (boolean) – Enabled(readOnly=True)

  • secret (string) – Secret(minLength=1, x-nullable=True)

  • pin (string) – Enter the six-digit code from the application(minLength=1)

  • recovery (string) – Recovery(minLength=1)

param integer id(required)

A unique integer value identifying this user.

query schema data(required)

TwoFA Schema

Schemas Description

ProjectTemplate Schema

{
    "id": {
        "title": "Id",
        "type": "integer"
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 1024,
        "minLength": 1
    },
    "type": {
        "title": "Type",
        "type": "string",
        "enum": [
            "GIT",
            "TAR"
        ]
    }
}

OneProjectTemplate Schema

{
    "id": {
        "title": "Id",
        "type": "integer"
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 1024,
        "minLength": 1
    },
    "description": {
        "title": "Description",
        "type": "string",
        "minLength": 1
    },
    "type": {
        "title": "Type",
        "type": "string",
        "enum": [
            "GIT",
            "TAR"
        ]
    },
    "repository": {
        "title": "Repository",
        "type": "string",
        "maxLength": 2048,
        "minLength": 1
    }
}

ProjectTemplateCreate Schema

{
    "project_id": {
        "title": "Project id",
        "type": "integer",
        "readOnly": true,
        "x-options": {
            "redirect": {
                "concat_field_name": false,
                "depend_field": null,
                "operation_name": "project"
            }
        },
        "x-nullable": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "minLength": 1
    }
}

Group Schema

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "children": {
        "title": "Children",
        "type": "boolean"
    },
    "from_project": {
        "title": "Project based",
        "type": "boolean"
    }
}

User Schema

{
    "id": {
        "title": "ID",
        "type": "integer",
        "readOnly": true
    },
    "username": {
        "title": "Username",
        "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
        "type": "string",
        "pattern": "^[\\w.@+-]+$",
        "maxLength": 150,
        "minLength": 1
    },
    "is_active": {
        "title": "Is active",
        "type": "boolean",
        "default": true
    },
    "email": {
        "title": "Email",
        "type": "string",
        "format": "email",
        "minLength": 1
    }
}

GroupCreateMaster Schema

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "minLength": 1
    },
    "children": {
        "title": "Contains groups",
        "type": "boolean",
        "default": false
    },
    "owner": {
        "id": {
            "title": "ID",
            "type": "integer",
            "readOnly": true
        },