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 entites:

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([(‘operation_name’, ‘project’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), 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 /groups/¶

Group(id, hidden, notes, owner, name, master_project, children)

Example Response

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


{
    "count": 2,
    "next": "http://localhost:8080/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 Schema)

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 separeted “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 /groups/¶

Group(id, hidden, notes, owner, name, master_project, children)

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

data(required) (schema) – GroupCreateMaster Schema

GET /groups/{id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /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",
    "children": true,
    "from_project": true
}

JSON Parameters

id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
children (boolean) – Children
from_project (boolean) – Project based

param integer id(required)

A unique integer value identifying this group.

query schema data(required): Group Schema

GET /groups/{id}/groups/¶

Group(id, hidden, notes, owner, name, master_project, children)

Example Response

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


{
    "count": 2,
    "next": "http://localhost:8080/groups/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 Schema)

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 separeted “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 /groups/{id}/groups/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/groups/{groups_id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/groups/{groups_id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/groups/{groups_id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{id}/groups/{groups_id}/¶

Group(id, hidden, notes, owner, name, master_project, children)

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 /groups/{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",
    "children": true,
    "from_project": true
}

JSON Parameters

id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
children (boolean) – Children
from_project (boolean) – Project based

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): Group Schema

GET /groups/{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/groups/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 separeted “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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 /groups/{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/groups/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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 /groups/{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/groups/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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /groups/{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 /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/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 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 separeted “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 /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 id(required)

A unique integer value identifying this group.

query schema data(required): OneHost Schema

GET /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 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 /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 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 /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 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 /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 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 /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 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 /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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 /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/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 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 /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 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 /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 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 /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 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 /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 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 /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 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 /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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

param integer id(required)

A unique integer value identifying this group.

query schema data(required): SetOwner Schema

GET /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/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 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 /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 id(required)

A unique integer value identifying this group.

query schema data(required): InventoryVariable Schema

GET /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 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 /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 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 /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 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 /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 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": 1,
            "initiator": 1,
            "initiator_type": "example initiator_type",
            "project": 1,
            "inventory": 1,
            "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__not: A name string value (or comma separated list) of instance.
query string name: 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": 1,
    "project": 1,
    "revision": "example revision",
    "inventory": 1,
    "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 (integer) – Executor(x-nullable=True)
project (integer) – Project(x-nullable=True)
revision (string) – Revision(maxLength=256, x-nullable=True)
inventory (integer) – 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


{}

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

data(required) (schema) – Hook Schema

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 separeted “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

data(required) (schema) – OneHost Schema

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 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 string variables: List of variables to filter. Comma separeted “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

data(required) (schema) – OneInventory Schema

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": "example raw_data"
}

JSON Parameters

inventory_id (integer) – Inventory id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘operation_name’, ‘inventory’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), x-nullable=True)
name (string) – Name(minLength=1)
raw_data (string) – Raw data(minLength=1)

Query Parameters

data(required) (schema) – InventoryImport Schema

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

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.

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 separeted “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 Schema

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

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

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",
    "children": true,
    "from_project": true
}

JSON Parameters

id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
children (boolean) – Children
from_project (boolean) – Project based

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): Group Schema

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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 separeted “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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 separeted “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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 separeted “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 (string) – Repo url(default=MANUAL, minLength=1)
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

data(required) (schema) – ProjectCreateMaster Schema

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([(‘operation_name’, ‘history’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), 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([(‘operation_name’, ‘history’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), 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": "example inventory",
    "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 (string) – Inventory(maxLength=128, x-nullable=True)
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": "example inventory",
    "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 (string) – Inventory(maxLength=128, x-nullable=True)
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": "example inventory",
    "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 (string) – Inventory(maxLength=128, x-nullable=True)
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": "example inventory",
    "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 (string) – Inventory(maxLength=128, x-nullable=True)
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([(‘operation_name’, ‘history’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), 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": 1,
            "initiator": 1,
            "initiator_type": "example initiator_type",
            "revision": "example revision",
            "inventory": 1,
            "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__not: A name string value (or comma separated list) of instance.
query string name: 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": 1,
    "project": 1,
    "revision": "example revision",
    "inventory": 1,
    "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 (integer) – Executor(x-nullable=True)
project (integer) – Project(x-nullable=True)
revision (string) – Revision(maxLength=256, x-nullable=True)
inventory (integer) – 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


{}

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 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 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 separeted “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([(‘operation_name’, ‘inventory’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), x-nullable=True)
name (string) – Name(pattern=(^[^.]+?$)|(^([.][\//])?([.]*[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": "example raw_data"
}

JSON Parameters

inventory_id (integer) – Inventory id(readOnly=True, x-options=OrderedDict([(‘redirect’, OrderedDict([(‘operation_name’, ‘inventory’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), x-nullable=True)
name (string) – Name(minLength=1)
raw_data (string) – Raw data(minLength=1)

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

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 separeted “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 Schema

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

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",
    "children": true,
    "from_project": true
}

JSON Parameters

id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
children (boolean) – Children
from_project (boolean) – Project based

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): Group Schema

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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

Group(id, hidden, notes, owner, name, master_project, children)

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 separeted “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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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 separeted “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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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": "test_dynamic",
            "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__not: A name string value (or comma separated list) of instance.
query string name: 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": "test_dynamic",
    "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 (dynamic) – 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": "test_dynamic",
    "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 (dynamic) – 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": "test_dynamic",
    "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 (dynamic) – 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": "test_dynamic",
    "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 (dynamic) – 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([(‘operation_name’, ‘history’), (‘depend_field’, None), (‘concat_field_name’, False)]))]), 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": "example key",
            "value": "example value"
        }
    ]
}

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": "example key",
    "value": "example value"
}

JSON Parameters

id (integer) – Id(readOnly=True)
key (string) – Key(maxLength=512, minLength=1)
value (string) – Value(default=)

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": "example key",
    "value": "example value"
}

JSON Parameters

id (integer) – Id(readOnly=True)
key (string) – Key(maxLength=512, minLength=1)
value (string) – Value(default=)

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": "example key",
    "value": "example value"
}

JSON Parameters

id (integer) – Id(readOnly=True)
key (string) – Key(maxLength=512, minLength=1)
value (string) – Value(default=)

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": "example key",
    "value": "example value"
}

JSON Parameters

id (integer) – Id(readOnly=True)
key (string) – Key(maxLength=512, minLength=1)
value (string) – Value(default=)

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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

data(required) (schema) – OneTeam Schema

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([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’), (‘usePrefetch’, True), (‘makeLink’, True), (‘dependence’, None), (‘filters’, None)]))

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,
    "is_staff": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com",
    "password": "example password",
    "password2": "example password2"
}

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)
is_staff (boolean) – Is staff(default=False)
first_name (string) – First name(maxLength=150)
last_name (string) – Last name(maxLength=150)
email (email) – Email(minLength=1)
password (string) – Password(minLength=1)
password2 (string) – Repeat password(minLength=1)

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

from rest_framework.settings import api_settings print(api_settings.DEFAULT_RENDERER_CLASSES) Any setting with string import paths will be automatically resolved and return the class, rather than the string literal. Note: This is an internal class that is only compatible with settings namespaced under the REST_FRAMEWORK name. It is not intended to be used by 3rd-party apps, and test helpers like override_settings may not work as expected.

Example Response

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


{
    "lang": "en",
    "autoupdateInterval": 15000,
    "chartLineSettings": {
        "all_tasks": {
            "active": true
        },
        "delay": {
            "active": true
        },
        "ok": {
            "active": true
        },
        "error": {
            "active": true
        },
        "interrupted": {
            "active": true
        },
        "offline": {
            "active": true
        }
    },
    "widgetSettings": {
        "pmwUsersCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwProjectsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwTemplatesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwInventoriesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwGroupsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwHostsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwChartWidget": {
            "active": true,
            "collapse": true,
            "sort": 1
        }
    },
    "selectedSkin": "example selectedSkin",
    "skinsSettings": {}
}

JSON Parameters

lang (string) – Lang(enum=[‘en’, ‘ru’, ‘cn’, ‘vi’], default=en)
autoupdateInterval (integer) – Autoupdateinterval(default=15000)
chartLineSettings (object) – (ChartLineSettings Schema)
widgetSettings (object) – (WidgetSettings Schema)
selectedSkin (string) – Selectedskin(minLength=1)
skinsSettings (object) – (Data Schema)

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.

POST /team/{id}/user/{user_id}/settings/¶

Example Response

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


{
    "lang": "en",
    "autoupdateInterval": 15000,
    "chartLineSettings": {
        "all_tasks": {
            "active": true
        },
        "delay": {
            "active": true
        },
        "ok": {
            "active": true
        },
        "error": {
            "active": true
        },
        "interrupted": {
            "active": true
        },
        "offline": {
            "active": true
        }
    },
    "widgetSettings": {
        "pmwUsersCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwProjectsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwTemplatesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwInventoriesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwGroupsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwHostsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwChartWidget": {
            "active": true,
            "collapse": true,
            "sort": 1
        }
    },
    "selectedSkin": "example selectedSkin",
    "skinsSettings": {}
}

JSON Parameters

lang (string) – Lang(enum=[‘en’, ‘ru’, ‘cn’, ‘vi’], default=en)
autoupdateInterval (integer) – Autoupdateinterval(default=15000)
chartLineSettings (object) – (ChartLineSettings Schema)
widgetSettings (object) – (WidgetSettings Schema)
selectedSkin (string) – Selectedskin(minLength=1)
skinsSettings (object) – (Data Schema)

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 Schema

DELETE /team/{id}/user/{user_id}/settings/¶

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}/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,
    "is_staff": true,
    "first_name": "example first_name",
    "last_name": "example last_name",
    "email": "example@mail.com",
    "password": "example password",
    "password2": "example password2"
}

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)
is_staff (boolean) – Is staff(default=False)
first_name (string) – First name(maxLength=150)
last_name (string) – Last name(maxLength=150)
email (email) – Email(minLength=1)
password (string) – Password(minLength=1)
password2 (string) – Repeat password(minLength=1)

Query Parameters

data(required) (schema) – CreateUser Schema

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

Return user settings.

Example Response

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


{
    "lang": "en",
    "autoupdateInterval": 15000,
    "chartLineSettings": {
        "all_tasks": {
            "active": true
        },
        "delay": {
            "active": true
        },
        "ok": {
            "active": true
        },
        "error": {
            "active": true
        },
        "interrupted": {
            "active": true
        },
        "offline": {
            "active": true
        }
    },
    "widgetSettings": {
        "pmwUsersCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwProjectsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwTemplatesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwInventoriesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwGroupsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwHostsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwChartWidget": {
            "active": true,
            "collapse": true,
            "sort": 1
        }
    },
    "selectedSkin": "example selectedSkin",
    "skinsSettings": {}
}

JSON Parameters

lang (string) – Lang(enum=[‘en’, ‘ru’, ‘cn’, ‘vi’], default=en)
autoupdateInterval (integer) – Autoupdateinterval(default=15000)
chartLineSettings (object) – (ChartLineSettings Schema)
widgetSettings (object) – (WidgetSettings Schema)
selectedSkin (string) – Selectedskin(minLength=1)
skinsSettings (object) – (Data Schema)

param integer id(required): A unique integer value identifying this user.

POST /user/{id}/settings/¶

Return user settings.

Example Response

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


{
    "lang": "en",
    "autoupdateInterval": 15000,
    "chartLineSettings": {
        "all_tasks": {
            "active": true
        },
        "delay": {
            "active": true
        },
        "ok": {
            "active": true
        },
        "error": {
            "active": true
        },
        "interrupted": {
            "active": true
        },
        "offline": {
            "active": true
        }
    },
    "widgetSettings": {
        "pmwUsersCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwProjectsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwTemplatesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwInventoriesCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwGroupsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwHostsCounter": {
            "active": true,
            "collapse": true,
            "sort": 1
        },
        "pmwChartWidget": {
            "active": true,
            "collapse": true,
            "sort": 1
        }
    },
    "selectedSkin": "example selectedSkin",
    "skinsSettings": {}
}

JSON Parameters

lang (string) – Lang(enum=[‘en’, ‘ru’, ‘cn’, ‘vi’], default=en)
autoupdateInterval (integer) – Autoupdateinterval(default=15000)
chartLineSettings (object) – (ChartLineSettings Schema)
widgetSettings (object) – (WidgetSettings Schema)
selectedSkin (string) – Selectedskin(minLength=1)
skinsSettings (object) – (Data Schema)

param integer id(required)

A unique integer value identifying this user.

query schema data(required): UserSettings Schema

DELETE /user/{id}/settings/¶

Return user settings.

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}/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": {
                "operation_name": "project",
                "depend_field": null,
                "concat_field_name": false
            }
        },
        "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
        },
        "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
        }
    }
}

OneGroup 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",
        "readOnly": true
    },
    "owner": {
        "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
        }
    }
}

Host Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "type": {
        "title": "Type",
        "type": "string",
        "enum": [
            "HOST",
            "RANGE"
        ],
        "default": "HOST"
    },
    "from_project": {
        "title": "Project Based",
        "type": "boolean",
        "readOnly": true
    }
}

OneHost Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "format": "textarea"
    },
    "type": {
        "title": "Type",
        "type": "string",
        "enum": [
            "HOST",
            "RANGE"
        ],
        "default": "HOST"
    },
    "owner": {
        "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
        }
    }
}

SetOwner Schema¶

{
    "user_id": {
        "title": "New owner",
        "type": "integer",
        "format": "fk",
        "x-options": {
            "model": {
                "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
                }
            },
            "value_field": "id",
            "view_field": "username",
            "usePrefetch": true,
            "makeLink": true,
            "dependence": null,
            "filters": null
        }
    }
}

InventoryVariable Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "key": {
        "title": "Key",
        "type": "string",
        "format": "autocomplete",
        "enum": [
            "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": {
        "title": "Value",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "key",
            "choices": {},
            "types": {
                "ansible_ssh_pass": "password",
                "ansible_ssh_private_key_file": "secretfile",
                "ansible_become": "boolean",
                "ansible_port": "integer",
                "ansible_become_pass": "password"
            }
        }
    }
}

History Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "start_time": {
        "title": "Start time",
        "type": "string",
        "format": "date-time"
    },
    "executor": {
        "title": "Executor",
        "type": "integer",
        "x-nullable": true
    },
    "initiator": {
        "title": "Initiator",
        "type": "integer"
    },
    "initiator_type": {
        "title": "Initiator type",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "project": {
        "title": "Project",
        "type": "integer",
        "x-nullable": true
    },
    "inventory": {
        "title": "Inventory",
        "type": "integer",
        "x-nullable": true
    },
    "kind": {
        "title": "Kind",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "mode": {
        "title": "Mode",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    },
    "options": {
        "title": "Options",
        "type": "string",
        "readOnly": true
    },
    "status": {
        "title": "Status",
        "type": "string",
        "enum": [
            "DELAY",
            "RUN",
            "OK",
            "ERROR",
            "OFFLINE",
            "INTERRUPTED"
        ]
    },
    "stop_time": {
        "title": "Stop time",
        "type": "string",
        "format": "date-time",
        "x-nullable": true
    }
}

OneHistory Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "status": {
        "title": "Status",
        "type": "string",
        "enum": [
            "DELAY",
            "RUN",
            "OK",
            "ERROR",
            "OFFLINE",
            "INTERRUPTED"
        ]
    },
    "executor": {
        "title": "Executor",
        "type": "integer",
        "x-nullable": true
    },
    "project": {
        "title": "Project",
        "type": "integer",
        "x-nullable": true
    },
    "revision": {
        "title": "Revision",
        "type": "string",
        "maxLength": 256,
        "x-nullable": true
    },
    "inventory": {
        "title": "Inventory",
        "type": "integer",
        "x-nullable": true
    },
    "kind": {
        "title": "Kind",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "mode": {
        "title": "Mode",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    },
    "execute_args": {
        "title": "Execute args",
        "type": "string",
        "readOnly": true
    },
    "execution_time": {
        "title": "Execution time",
        "type": "integer",
        "format": "uptime"
    },
    "start_time": {
        "title": "Start time",
        "type": "string",
        "format": "date-time"
    },
    "stop_time": {
        "title": "Stop time",
        "type": "string",
        "format": "date-time",
        "x-nullable": true
    },
    "initiator": {
        "title": "Initiator",
        "type": "integer"
    },
    "initiator_type": {
        "title": "Initiator type",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "options": {
        "title": "Options",
        "type": "string",
        "readOnly": true
    },
    "raw_args": {
        "title": "Raw args",
        "type": "string",
        "minLength": 1
    },
    "raw_stdout": {
        "title": "Raw stdout",
        "type": "string",
        "readOnly": true
    },
    "raw_inventory": {
        "title": "Raw inventory",
        "type": "string",
        "minLength": 1
    }
}

Empty Schema¶

{}

ActionResponse Schema¶

{
    "detail": {
        "title": "Detail",
        "type": "string",
        "minLength": 1
    }
}

Data Schema¶

{}

Hook Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "type": {
        "title": "Type",
        "type": "string",
        "enum": [
            "HTTP",
            "SCRIPT"
        ]
    },
    "when": {
        "title": "When",
        "type": "string",
        "enum": [
            "on_execution",
            "after_execution",
            "on_user_add",
            "on_user_upd",
            "on_user_del",
            "on_object_add",
            "on_object_upd",
            "on_object_del"
        ]
    },
    "enable": {
        "title": "Enable",
        "type": "boolean"
    },
    "recipients": {
        "title": "Recipients",
        "type": "string",
        "minLength": 1
    }
}

Inventory Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "from_project": {
        "title": "Project Based",
        "type": "boolean",
        "readOnly": true
    }
}

OneInventory Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "format": "textarea"
    },
    "owner": {
        "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
        }
    }
}

InventoryImport Schema¶

{
    "inventory_id": {
        "title": "Inventory id",
        "type": "integer",
        "readOnly": true,
        "x-options": {
            "redirect": {
                "operation_name": "inventory",
                "depend_field": null,
                "concat_field_name": false
            }
        },
        "x-nullable": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "minLength": 1
    },
    "raw_data": {
        "title": "Raw data",
        "type": "string",
        "minLength": 1
    }
}

Project Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "type": {
        "title": "Type",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "status": {
        "title": "Status",
        "type": "string",
        "enum": [
            "NEW",
            "ERROR",
            "OK",
            "WAIT_SYNC",
            "SYNC"
        ],
        "readOnly": true
    }
}

ProjectCreateMaster Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "status": {
        "title": "Status",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "type": {
        "title": "Repo type",
        "type": "string",
        "enum": [
            "MANUAL",
            "GIT",
            "TAR"
        ],
        "default": "MANUAL"
    },
    "repository": {
        "title": "Repo url",
        "type": "string",
        "default": "MANUAL",
        "minLength": 1
    },
    "repo_auth": {
        "title": "Repo auth type",
        "type": "string",
        "format": "dynamic",
        "default": "NONE",
        "x-options": {
            "field": "type",
            "choices": {
                "GIT": [
                    "NONE",
                    "KEY",
                    "PASSWORD"
                ]
            },
            "types": {
                "MANUAL": "hidden",
                "GIT": "string",
                "TAR": "hidden"
            }
        }
    },
    "auth_data": {
        "title": "Repo auth data",
        "type": "string",
        "format": "dynamic",
        "default": "",
        "x-options": {
            "field": "repo_auth",
            "choices": {},
            "types": {
                "KEY": "secretfile",
                "PASSWORD": "password",
                "NONE": "hidden"
            }
        }
    },
    "branch": {
        "title": "Branch for GIT(branch/tag/SHA) or TAR(subdir)",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "type",
            "choices": {},
            "types": {
                "MANUAL": "hidden",
                "GIT": "string",
                "TAR": "string"
            }
        },
        "x-nullable": true
    },
    "additional_playbook_path": {
        "title": "Directory with playbooks",
        "type": "string",
        "minLength": 1,
        "x-nullable": true
    }
}

OneProject Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "repository": {
        "title": "Repository",
        "type": "string",
        "default": "MANUAL",
        "minLength": 1
    },
    "status": {
        "title": "Status",
        "type": "string",
        "enum": [
            "NEW",
            "ERROR",
            "OK",
            "WAIT_SYNC",
            "SYNC"
        ],
        "readOnly": true
    },
    "revision": {
        "title": "Revision",
        "type": "string",
        "readOnly": true
    },
    "branch": {
        "title": "Branch",
        "type": "string",
        "readOnly": true
    },
    "owner": {
        "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
        }
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "format": "textarea"
    },
    "readme_content": {
        "title": "Information",
        "type": "string",
        "format": "html",
        "readOnly": true
    },
    "execute_view_data": {}
}

AnsibleModule Schema¶

{
    "module": {
        "title": "Module",
        "type": "string",
        "format": "fk_autocomplete",
        "x-options": {
            "model": {
                "id": {
                    "title": "Id",
                    "type": "integer",
                    "readOnly": true
                },
                "path": {
                    "title": "Path",
                    "type": "string",
                    "maxLength": 1024,
                    "minLength": 1
                },
                "name": {
                    "title": "Name",
                    "type": "string",
                    "readOnly": true
                }
            },
            "value_field": "name",
            "view_field": "path",
            "usePrefetch": true
        }
    },
    "args": {
        "title": "Args",
        "description": "host pattern",
        "type": "string"
    },
    "background": {
        "title": "Background",
        "description": "run asynchronously, failing after X seconds (default=N/A)",
        "type": "integer"
    },
    "become": {
        "title": "Become",
        "description": "run operations with become (does not imply password prompting)",
        "type": "boolean",
        "default": false
    },
    "become_method": {
        "title": "Become method",
        "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
        "type": "string"
    },
    "check": {
        "title": "Check",
        "description": "don't make any changes; instead, try to predict some of the changes that may occur",
        "type": "boolean",
        "default": false
    },
    "connection": {
        "title": "Connection",
        "description": "connection type to use (default=smart)",
        "type": "string"
    },
    "diff": {
        "title": "Diff",
        "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
        "type": "boolean",
        "default": false
    },
    "extra_vars": {
        "title": "Extra vars",
        "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
        "type": "string"
    },
    "forks": {
        "title": "Forks",
        "description": "specify number of parallel processes to use (default=5)",
        "type": "integer"
    },
    "inventory": {
        "title": "Inventory",
        "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
        "type": "string",
        "format": "fk_autocomplete",
        "x-options": {
            "model": {
                "id": {
                    "title": "Id",
                    "type": "integer",
                    "readOnly": true
                },
                "name": {
                    "title": "Name",
                    "type": "string",
                    "maxLength": 512,
                    "minLength": 1
                },
                "from_project": {
                    "title": "Project Based",
                    "type": "boolean",
                    "readOnly": true
                }
            },
            "value_field": "id",
            "view_field": "name",
            "usePrefetch": true
        }
    },
    "limit": {
        "title": "Limit",
        "description": "further limit selected hosts to an additional pattern",
        "type": "string"
    },
    "list_hosts": {
        "title": "List hosts",
        "description": "outputs a list of matching hosts; does not execute anything else",
        "type": "boolean",
        "default": false
    },
    "one_line": {
        "title": "One line",
        "description": "condense output",
        "type": "boolean",
        "default": false
    },
    "playbook_dir": {
        "title": "Playbook dir",
        "description": "Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.",
        "type": "string"
    },
    "poll": {
        "title": "Poll",
        "description": "set the poll interval if using -B (default=15)",
        "type": "integer"
    },
    "private_key": {
        "title": "Private key",
        "description": "use this file to authenticate the connection",
        "type": "string",
        "format": "secretfile"
    },
    "scp_extra_args": {
        "title": "Scp extra args",
        "description": "specify extra arguments to pass to scp only (e.g. -l)",
        "type": "string"
    },
    "sftp_extra_args": {
        "title": "Sftp extra args",
        "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
        "type": "string"
    },
    "ssh_common_args": {
        "title": "Ssh common args",
        "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
        "type": "string"
    },
    "ssh_extra_args": {
        "title": "Ssh extra args",
        "description": "specify extra arguments to pass to ssh only (e.g. -R)",
        "type": "string"
    },
    "syntax_check": {
        "title": "Syntax check",
        "description": "perform a syntax check on the playbook, but do not execute it",
        "type": "boolean",
        "default": false
    },
    "timeout": {
        "title": "Timeout",
        "description": "override the connection timeout in seconds (default=10)",
        "type": "integer"
    },
    "tree": {
        "title": "Tree",
        "description": "log output to this directory",
        "type": "string"
    },
    "user": {
        "title": "User",
        "description": "connect as this user (default=None)",
        "type": "string"
    },
    "vault_password_file": {
        "title": "Vault password file",
        "description": "vault password file",
        "type": "string",
        "format": "secretfile"
    },
    "verbose": {
        "title": "Verbose",
        "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
        "type": "integer",
        "default": 0,
        "maximum": 4
    },
    "group": {
        "title": "Group",
        "type": "string",
        "default": "all"
    }
}

ExecuteResponse Schema¶

{
    "detail": {
        "title": "Detail",
        "type": "string",
        "minLength": 1
    },
    "history_id": {
        "title": "History id",
        "type": "integer",
        "x-options": {
            "redirect": {
                "operation_name": "history",
                "depend_field": null,
                "concat_field_name": false
            }
        },
        "x-nullable": true
    },
    "executor": {
        "title": "Executor",
        "type": "integer",
        "x-nullable": true
    }
}

AnsiblePlaybook Schema¶

{
    "playbook": {
        "title": "Playbook",
        "type": "string",
        "format": "fk_autocomplete",
        "x-options": {
            "model": {
                "id": {
                    "title": "Id",
                    "type": "integer",
                    "readOnly": true
                },
                "name": {
                    "title": "Name",
                    "type": "string",
                    "maxLength": 251,
                    "minLength": 1
                },
                "playbook": {
                    "title": "Playbook",
                    "type": "string",
                    "maxLength": 256,
                    "minLength": 1
                }
            },
            "value_field": "playbook",
            "view_field": "name",
            "usePrefetch": true
        }
    },
    "args": {
        "title": "Args",
        "description": "Playbook(s)",
        "type": "string"
    },
    "become": {
        "title": "Become",
        "description": "run operations with become (does not imply password prompting)",
        "type": "boolean",
        "default": false
    },
    "become_method": {
        "title": "Become method",
        "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
        "type": "string"
    },
    "check": {
        "title": "Check",
        "description": "don't make any changes; instead, try to predict some of the changes that may occur",
        "type": "boolean",
        "default": false
    },
    "connection": {
        "title": "Connection",
        "description": "connection type to use (default=smart)",
        "type": "string"
    },
    "diff": {
        "title": "Diff",
        "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
        "type": "boolean",
        "default": false
    },
    "extra_vars": {
        "title": "Extra vars",
        "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
        "type": "string"
    },
    "flush_cache": {
        "title": "Flush cache",
        "description": "clear the fact cache for every host in inventory",
        "type": "boolean",
        "default": false
    },
    "force_handlers": {
        "title": "Force handlers",
        "description": "run handlers even if a task fails",
        "type": "boolean",
        "default": false
    },
    "forks": {
        "title": "Forks",
        "description": "specify number of parallel processes to use (default=5)",
        "type": "integer"
    },
    "inventory": {
        "title": "Inventory",
        "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
        "type": "string",
        "format": "fk_autocomplete",
        "x-options": {
            "model": {
                "id": {
                    "title": "Id",
                    "type": "integer",
                    "readOnly": true
                },
                "name": {
                    "title": "Name",
                    "type": "string",
                    "maxLength": 512,
                    "minLength": 1
                },
                "from_project": {
                    "title": "Project Based",
                    "type": "boolean",
                    "readOnly": true
                }
            },
            "value_field": "id",
            "view_field": "name",
            "usePrefetch": true
        }
    },
    "limit": {
        "title": "Limit",
        "description": "further limit selected hosts to an additional pattern",
        "type": "string"
    },
    "list_hosts": {
        "title": "List hosts",
        "description": "outputs a list of matching hosts; does not execute anything else",
        "type": "boolean",
        "default": false
    },
    "list_tags": {
        "title": "List tags",
        "description": "list all available tags",
        "type": "boolean",
        "default": false
    },
    "list_tasks": {
        "title": "List tasks",
        "description": "list all tasks that would be executed",
        "type": "boolean",
        "default": false
    },
    "private_key": {
        "title": "Private key",
        "description": "use this file to authenticate the connection",
        "type": "string",
        "format": "secretfile"
    },
    "scp_extra_args": {
        "title": "Scp extra args",
        "description": "specify extra arguments to pass to scp only (e.g. -l)",
        "type": "string"
    },
    "sftp_extra_args": {
        "title": "Sftp extra args",
        "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
        "type": "string"
    },
    "skip_tags": {
        "title": "Skip tags",
        "description": "only run plays and tasks whose tags do not match these values",
        "type": "string"
    },
    "ssh_common_args": {
        "title": "Ssh common args",
        "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
        "type": "string"
    },
    "ssh_extra_args": {
        "title": "Ssh extra args",
        "description": "specify extra arguments to pass to ssh only (e.g. -R)",
        "type": "string"
    },
    "start_at_task": {
        "title": "Start at task",
        "description": "start the playbook at the task matching this name",
        "type": "string"
    },
    "step": {
        "title": "Step",
        "description": "one-step-at-a-time: confirm each task before running",
        "type": "boolean",
        "default": false
    },
    "syntax_check": {
        "title": "Syntax check",
        "description": "perform a syntax check on the playbook, but do not execute it",
        "type": "boolean",
        "default": false
    },
    "tags": {
        "title": "Tags",
        "description": "only run plays and tasks tagged with these values",
        "type": "string"
    },
    "timeout": {
        "title": "Timeout",
        "description": "override the connection timeout in seconds (default=10)",
        "type": "integer"
    },
    "user": {
        "title": "User",
        "description": "connect as this user (default=None)",
        "type": "string"
    },
    "vault_password_file": {
        "title": "Vault password file",
        "description": "vault password file",
        "type": "string",
        "format": "secretfile"
    },
    "verbose": {
        "title": "Verbose",
        "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
        "type": "integer",
        "default": 0,
        "maximum": 4
    }
}

ExecutionTemplate Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "kind": {
        "title": "Type",
        "type": "string",
        "enum": [
            "Task",
            "Module"
        ],
        "default": "Task"
    }
}

CreateExecutionTemplate Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "kind": {
        "title": "Type",
        "type": "string",
        "enum": [
            "Task",
            "Module"
        ],
        "default": "Task"
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "minLength": 1
    },
    "inventory": {
        "title": "Inventory",
        "type": "string",
        "maxLength": 128,
        "x-nullable": true
    },
    "data": {
        "title": "Data",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "Task": {
                    "required": [
                        "playbook"
                    ],
                    "type": "object",
                    "properties": {
                        "playbook": {
                            "title": "Playbook",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "maxLength": 251,
                                        "minLength": 1
                                    },
                                    "playbook": {
                                        "title": "Playbook",
                                        "type": "string",
                                        "maxLength": 256,
                                        "minLength": 1
                                    }
                                },
                                "value_field": "playbook",
                                "view_field": "playbook",
                                "usePrefetch": true
                            }
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "Playbook(s)",
                                    "type": "string"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "flush_cache": {
                                    "title": "Flush cache",
                                    "description": "clear the fact cache for every host in inventory",
                                    "type": "boolean"
                                },
                                "force_handlers": {
                                    "title": "Force handlers",
                                    "description": "run handlers even if a task fails",
                                    "type": "boolean"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "list_tags": {
                                    "title": "List tags",
                                    "description": "list all available tags",
                                    "type": "boolean"
                                },
                                "list_tasks": {
                                    "title": "List tasks",
                                    "description": "list all tasks that would be executed",
                                    "type": "boolean"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "skip_tags": {
                                    "title": "Skip tags",
                                    "description": "only run plays and tasks whose tags do not match these values",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "start_at_task": {
                                    "title": "Start at task",
                                    "description": "start the playbook at the task matching this name",
                                    "type": "string"
                                },
                                "step": {
                                    "title": "Step",
                                    "description": "one-step-at-a-time: confirm each task before running",
                                    "type": "boolean"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "tags": {
                                    "title": "Tags",
                                    "description": "only run plays and tasks tagged with these values",
                                    "type": "string"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                }
                            }
                        }
                    }
                },
                "Module": {
                    "required": [
                        "module"
                    ],
                    "type": "object",
                    "properties": {
                        "group": {
                            "title": "Group",
                            "type": "string",
                            "default": "all",
                            "minLength": 1
                        },
                        "module": {
                            "title": "Module",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "path": {
                                        "title": "Path",
                                        "type": "string",
                                        "maxLength": 1024,
                                        "minLength": 1
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "readOnly": true
                                    }
                                },
                                "value_field": "name",
                                "view_field": "path",
                                "usePrefetch": true
                            }
                        },
                        "args": {
                            "title": "Arguments",
                            "type": "string",
                            "default": ""
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "host pattern",
                                    "type": "string"
                                },
                                "background": {
                                    "title": "Background",
                                    "description": "run asynchronously, failing after X seconds (default=N/A)",
                                    "type": "integer"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "one_line": {
                                    "title": "One line",
                                    "description": "condense output",
                                    "type": "boolean"
                                },
                                "playbook_dir": {
                                    "title": "Playbook dir",
                                    "description": "Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.",
                                    "type": "string"
                                },
                                "poll": {
                                    "title": "Poll",
                                    "description": "set the poll interval if using -B (default=15)",
                                    "type": "integer"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "tree": {
                                    "title": "Tree",
                                    "description": "log output to this directory",
                                    "type": "string"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                },
                                "group": {
                                    "title": "Group",
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

OneExecutionTemplate Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "kind": {
        "title": "Type",
        "type": "string",
        "enum": [
            "Task",
            "Module"
        ],
        "readOnly": true
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "minLength": 1
    },
    "inventory": {
        "title": "Inventory",
        "type": "string",
        "maxLength": 128,
        "x-nullable": true
    },
    "data": {
        "title": "Data",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "Task": {
                    "required": [
                        "playbook"
                    ],
                    "type": "object",
                    "properties": {
                        "playbook": {
                            "title": "Playbook",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "maxLength": 251,
                                        "minLength": 1
                                    },
                                    "playbook": {
                                        "title": "Playbook",
                                        "type": "string",
                                        "maxLength": 256,
                                        "minLength": 1
                                    }
                                },
                                "value_field": "playbook",
                                "view_field": "playbook",
                                "usePrefetch": true
                            }
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "Playbook(s)",
                                    "type": "string"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "flush_cache": {
                                    "title": "Flush cache",
                                    "description": "clear the fact cache for every host in inventory",
                                    "type": "boolean"
                                },
                                "force_handlers": {
                                    "title": "Force handlers",
                                    "description": "run handlers even if a task fails",
                                    "type": "boolean"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "list_tags": {
                                    "title": "List tags",
                                    "description": "list all available tags",
                                    "type": "boolean"
                                },
                                "list_tasks": {
                                    "title": "List tasks",
                                    "description": "list all tasks that would be executed",
                                    "type": "boolean"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "skip_tags": {
                                    "title": "Skip tags",
                                    "description": "only run plays and tasks whose tags do not match these values",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "start_at_task": {
                                    "title": "Start at task",
                                    "description": "start the playbook at the task matching this name",
                                    "type": "string"
                                },
                                "step": {
                                    "title": "Step",
                                    "description": "one-step-at-a-time: confirm each task before running",
                                    "type": "boolean"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "tags": {
                                    "title": "Tags",
                                    "description": "only run plays and tasks tagged with these values",
                                    "type": "string"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                }
                            }
                        }
                    }
                },
                "Module": {
                    "required": [
                        "module"
                    ],
                    "type": "object",
                    "properties": {
                        "group": {
                            "title": "Group",
                            "type": "string",
                            "default": "all",
                            "minLength": 1
                        },
                        "module": {
                            "title": "Module",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "path": {
                                        "title": "Path",
                                        "type": "string",
                                        "maxLength": 1024,
                                        "minLength": 1
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "readOnly": true
                                    }
                                },
                                "value_field": "name",
                                "view_field": "path",
                                "usePrefetch": true
                            }
                        },
                        "args": {
                            "title": "Arguments",
                            "type": "string",
                            "default": ""
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "host pattern",
                                    "type": "string"
                                },
                                "background": {
                                    "title": "Background",
                                    "description": "run asynchronously, failing after X seconds (default=N/A)",
                                    "type": "integer"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "one_line": {
                                    "title": "One line",
                                    "description": "condense output",
                                    "type": "boolean"
                                },
                                "playbook_dir": {
                                    "title": "Playbook dir",
                                    "description": "Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.",
                                    "type": "string"
                                },
                                "poll": {
                                    "title": "Poll",
                                    "description": "set the poll interval if using -B (default=15)",
                                    "type": "integer"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "tree": {
                                    "title": "Tree",
                                    "description": "log output to this directory",
                                    "type": "string"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                },
                                "group": {
                                    "title": "Group",
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

TemplateExec Schema¶

{
    "option": {
        "title": "Option",
        "type": "integer",
        "format": "fk",
        "x-options": {
            "model": {
                "id": {
                    "title": "Id",
                    "type": "string",
                    "readOnly": true,
                    "minLength": 1
                },
                "name": {
                    "title": "Name",
                    "type": "string",
                    "maxLength": 256,
                    "minLength": 1
                }
            },
            "value_field": "name",
            "view_field": "name",
            "usePrefetch": true,
            "makeLink": true,
            "dependence": null,
            "filters": null
        },
        "x-nullable": true
    }
}

TemplateOption Schema¶

{
    "id": {
        "title": "Id",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    }
}

CreateTemplateOption Schema¶

{
    "id": {
        "title": "Id",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    },
    "kind": {
        "title": "Kind",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "data": {
        "title": "Data",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "Task": {
                    "required": [
                        "playbook"
                    ],
                    "type": "object",
                    "properties": {
                        "playbook": {
                            "title": "Playbook",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "maxLength": 251,
                                        "minLength": 1
                                    },
                                    "playbook": {
                                        "title": "Playbook",
                                        "type": "string",
                                        "maxLength": 256,
                                        "minLength": 1
                                    }
                                },
                                "value_field": "playbook",
                                "view_field": "playbook",
                                "usePrefetch": true
                            }
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "Playbook(s)",
                                    "type": "string"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "flush_cache": {
                                    "title": "Flush cache",
                                    "description": "clear the fact cache for every host in inventory",
                                    "type": "boolean"
                                },
                                "force_handlers": {
                                    "title": "Force handlers",
                                    "description": "run handlers even if a task fails",
                                    "type": "boolean"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "list_tags": {
                                    "title": "List tags",
                                    "description": "list all available tags",
                                    "type": "boolean"
                                },
                                "list_tasks": {
                                    "title": "List tasks",
                                    "description": "list all tasks that would be executed",
                                    "type": "boolean"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "skip_tags": {
                                    "title": "Skip tags",
                                    "description": "only run plays and tasks whose tags do not match these values",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "start_at_task": {
                                    "title": "Start at task",
                                    "description": "start the playbook at the task matching this name",
                                    "type": "string"
                                },
                                "step": {
                                    "title": "Step",
                                    "description": "one-step-at-a-time: confirm each task before running",
                                    "type": "boolean"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "tags": {
                                    "title": "Tags",
                                    "description": "only run plays and tasks tagged with these values",
                                    "type": "string"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                }
                            }
                        }
                    }
                },
                "Module": {
                    "required": [
                        "module"
                    ],
                    "type": "object",
                    "properties": {
                        "group": {
                            "title": "Group",
                            "type": "string",
                            "default": "all",
                            "minLength": 1
                        },
                        "module": {
                            "title": "Module",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "path": {
                                        "title": "Path",
                                        "type": "string",
                                        "maxLength": 1024,
                                        "minLength": 1
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "readOnly": true
                                    }
                                },
                                "value_field": "name",
                                "view_field": "path",
                                "usePrefetch": true
                            }
                        },
                        "args": {
                            "title": "Arguments",
                            "type": "string",
                            "default": ""
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "host pattern",
                                    "type": "string"
                                },
                                "background": {
                                    "title": "Background",
                                    "description": "run asynchronously, failing after X seconds (default=N/A)",
                                    "type": "integer"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "one_line": {
                                    "title": "One line",
                                    "description": "condense output",
                                    "type": "boolean"
                                },
                                "playbook_dir": {
                                    "title": "Playbook dir",
                                    "description": "Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.",
                                    "type": "string"
                                },
                                "poll": {
                                    "title": "Poll",
                                    "description": "set the poll interval if using -B (default=15)",
                                    "type": "integer"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "tree": {
                                    "title": "Tree",
                                    "description": "log output to this directory",
                                    "type": "string"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                },
                                "group": {
                                    "title": "Group",
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

OneTemplateOption Schema¶

{
    "id": {
        "title": "Id",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "name": {
        "title": "Name",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "kind": {
        "title": "Kind",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    },
    "data": {
        "title": "Data",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "Task": {
                    "required": [
                        "playbook"
                    ],
                    "type": "object",
                    "properties": {
                        "playbook": {
                            "title": "Playbook",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "maxLength": 251,
                                        "minLength": 1
                                    },
                                    "playbook": {
                                        "title": "Playbook",
                                        "type": "string",
                                        "maxLength": 256,
                                        "minLength": 1
                                    }
                                },
                                "value_field": "playbook",
                                "view_field": "playbook",
                                "usePrefetch": true
                            }
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "Playbook(s)",
                                    "type": "string"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "flush_cache": {
                                    "title": "Flush cache",
                                    "description": "clear the fact cache for every host in inventory",
                                    "type": "boolean"
                                },
                                "force_handlers": {
                                    "title": "Force handlers",
                                    "description": "run handlers even if a task fails",
                                    "type": "boolean"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "list_tags": {
                                    "title": "List tags",
                                    "description": "list all available tags",
                                    "type": "boolean"
                                },
                                "list_tasks": {
                                    "title": "List tasks",
                                    "description": "list all tasks that would be executed",
                                    "type": "boolean"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "skip_tags": {
                                    "title": "Skip tags",
                                    "description": "only run plays and tasks whose tags do not match these values",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "start_at_task": {
                                    "title": "Start at task",
                                    "description": "start the playbook at the task matching this name",
                                    "type": "string"
                                },
                                "step": {
                                    "title": "Step",
                                    "description": "one-step-at-a-time: confirm each task before running",
                                    "type": "boolean"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "tags": {
                                    "title": "Tags",
                                    "description": "only run plays and tasks tagged with these values",
                                    "type": "string"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                }
                            }
                        }
                    }
                },
                "Module": {
                    "required": [
                        "module"
                    ],
                    "type": "object",
                    "properties": {
                        "group": {
                            "title": "Group",
                            "type": "string",
                            "default": "all",
                            "minLength": 1
                        },
                        "module": {
                            "title": "Module",
                            "type": "string",
                            "format": "fk_autocomplete",
                            "x-options": {
                                "model": {
                                    "id": {
                                        "title": "Id",
                                        "type": "integer",
                                        "readOnly": true
                                    },
                                    "path": {
                                        "title": "Path",
                                        "type": "string",
                                        "maxLength": 1024,
                                        "minLength": 1
                                    },
                                    "name": {
                                        "title": "Name",
                                        "type": "string",
                                        "readOnly": true
                                    }
                                },
                                "value_field": "name",
                                "view_field": "path",
                                "usePrefetch": true
                            }
                        },
                        "args": {
                            "title": "Arguments",
                            "type": "string",
                            "default": ""
                        },
                        "vars": {
                            "type": "object",
                            "properties": {
                                "args": {
                                    "title": "Args",
                                    "description": "host pattern",
                                    "type": "string"
                                },
                                "background": {
                                    "title": "Background",
                                    "description": "run asynchronously, failing after X seconds (default=N/A)",
                                    "type": "integer"
                                },
                                "become": {
                                    "title": "Become",
                                    "description": "run operations with become (does not imply password prompting)",
                                    "type": "boolean"
                                },
                                "become_method": {
                                    "title": "Become method",
                                    "description": "privilege escalation method to use (default=sudo), use `ansible-doc -t become -l` to list valid choices.",
                                    "type": "string"
                                },
                                "check": {
                                    "title": "Check",
                                    "description": "don't make any changes; instead, try to predict some of the changes that may occur",
                                    "type": "boolean"
                                },
                                "connection": {
                                    "title": "Connection",
                                    "description": "connection type to use (default=smart)",
                                    "type": "string"
                                },
                                "diff": {
                                    "title": "Diff",
                                    "description": "when changing (small) files and templates, show the differences in those files; works great with --check",
                                    "type": "boolean"
                                },
                                "extra_vars": {
                                    "title": "Extra vars",
                                    "description": "set additional variables as key=value or YAML/JSON, if filename prepend with @",
                                    "type": "string"
                                },
                                "forks": {
                                    "title": "Forks",
                                    "description": "specify number of parallel processes to use (default=5)",
                                    "type": "integer"
                                },
                                "inventory": {
                                    "title": "Inventory",
                                    "description": "specify inventory host path or comma separated host list. --inventory-file is deprecated",
                                    "type": "string",
                                    "format": "fk_autocomplete",
                                    "x-options": {
                                        "model": {
                                            "id": {
                                                "title": "Id",
                                                "type": "integer",
                                                "readOnly": true
                                            },
                                            "name": {
                                                "title": "Name",
                                                "type": "string",
                                                "maxLength": 512,
                                                "minLength": 1
                                            },
                                            "from_project": {
                                                "title": "Project Based",
                                                "type": "boolean",
                                                "readOnly": true
                                            }
                                        },
                                        "value_field": "id",
                                        "view_field": "name",
                                        "usePrefetch": true
                                    }
                                },
                                "limit": {
                                    "title": "Limit",
                                    "description": "further limit selected hosts to an additional pattern",
                                    "type": "string"
                                },
                                "list_hosts": {
                                    "title": "List hosts",
                                    "description": "outputs a list of matching hosts; does not execute anything else",
                                    "type": "boolean"
                                },
                                "one_line": {
                                    "title": "One line",
                                    "description": "condense output",
                                    "type": "boolean"
                                },
                                "playbook_dir": {
                                    "title": "Playbook dir",
                                    "description": "Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.",
                                    "type": "string"
                                },
                                "poll": {
                                    "title": "Poll",
                                    "description": "set the poll interval if using -B (default=15)",
                                    "type": "integer"
                                },
                                "private_key": {
                                    "title": "Private key",
                                    "description": "use this file to authenticate the connection",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "scp_extra_args": {
                                    "title": "Scp extra args",
                                    "description": "specify extra arguments to pass to scp only (e.g. -l)",
                                    "type": "string"
                                },
                                "sftp_extra_args": {
                                    "title": "Sftp extra args",
                                    "description": "specify extra arguments to pass to sftp only (e.g. -f, -l)",
                                    "type": "string"
                                },
                                "ssh_common_args": {
                                    "title": "Ssh common args",
                                    "description": "specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)",
                                    "type": "string"
                                },
                                "ssh_extra_args": {
                                    "title": "Ssh extra args",
                                    "description": "specify extra arguments to pass to ssh only (e.g. -R)",
                                    "type": "string"
                                },
                                "syntax_check": {
                                    "title": "Syntax check",
                                    "description": "perform a syntax check on the playbook, but do not execute it",
                                    "type": "boolean"
                                },
                                "timeout": {
                                    "title": "Timeout",
                                    "description": "override the connection timeout in seconds (default=10)",
                                    "type": "integer"
                                },
                                "tree": {
                                    "title": "Tree",
                                    "description": "log output to this directory",
                                    "type": "string"
                                },
                                "user": {
                                    "title": "User",
                                    "description": "connect as this user (default=None)",
                                    "type": "string"
                                },
                                "vault_password_file": {
                                    "title": "Vault password file",
                                    "description": "vault password file",
                                    "type": "string",
                                    "format": "secretfile"
                                },
                                "verbose": {
                                    "title": "Verbose",
                                    "description": "verbose mode (-vvv for more, -vvvv to enable connection debugging)",
                                    "type": "integer",
                                    "maximum": 4
                                },
                                "group": {
                                    "title": "Group",
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

ProjectHistory Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "start_time": {
        "title": "Start time",
        "type": "string",
        "format": "date-time"
    },
    "executor": {
        "title": "Executor",
        "type": "integer",
        "x-nullable": true
    },
    "initiator": {
        "title": "Initiator",
        "type": "integer"
    },
    "initiator_type": {
        "title": "Initiator type",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "revision": {
        "title": "Revision",
        "type": "string",
        "maxLength": 256,
        "x-nullable": true
    },
    "inventory": {
        "title": "Inventory",
        "type": "integer",
        "x-nullable": true
    },
    "kind": {
        "title": "Kind",
        "type": "string",
        "maxLength": 50,
        "minLength": 1
    },
    "mode": {
        "title": "Mode",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    },
    "options": {
        "title": "Options",
        "type": "string",
        "readOnly": true
    },
    "status": {
        "title": "Status",
        "type": "string",
        "enum": [
            "DELAY",
            "RUN",
            "OK",
            "ERROR",
            "OFFLINE",
            "INTERRUPTED"
        ]
    },
    "stop_time": {
        "title": "Stop time",
        "type": "string",
        "format": "date-time",
        "x-nullable": true
    }
}

InventoryFileImport Schema¶

{
    "inventory_id": {
        "title": "Inventory id",
        "type": "integer",
        "readOnly": true,
        "x-options": {
            "redirect": {
                "operation_name": "inventory",
                "depend_field": null,
                "concat_field_name": false
            }
        },
        "x-nullable": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "pattern": "(^[^\\.]+?$)|(^([\\.][\\\\//])?([\\.]*[\\w\\d\\-_]+?[\\.]*[\\w\\d\\-_]*[\\\\//]*)+?$)",
        "minLength": 1
    },
    "raw_data": {
        "title": "Raw data",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    }
}

Module Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "path": {
        "title": "Path",
        "type": "string",
        "maxLength": 1024,
        "minLength": 1
    },
    "name": {
        "title": "Name",
        "type": "string",
        "readOnly": true
    }
}

OneModule Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "path": {
        "title": "Path",
        "type": "string",
        "maxLength": 1024,
        "minLength": 1
    },
    "name": {
        "title": "Name",
        "type": "string",
        "readOnly": true
    },
    "data": {
        "title": "Data",
        "type": "string",
        "format": "json",
        "readOnly": true
    }
}

Periodictask Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "kind": {
        "title": "Task type",
        "type": "string",
        "enum": [
            "PLAYBOOK",
            "MODULE",
            "TEMPLATE"
        ],
        "default": "PLAYBOOK"
    },
    "mode": {
        "title": "Mode",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "PLAYBOOK": {
                    "type": "string",
                    "format": "fk_autocomplete",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "maxLength": 251,
                                "minLength": 1
                            },
                            "playbook": {
                                "title": "Playbook",
                                "type": "string",
                                "maxLength": 256,
                                "minLength": 1
                            }
                        },
                        "value_field": "playbook",
                        "view_field": "playbook",
                        "usePrefetch": true
                    }
                },
                "MODULE": {
                    "type": "string",
                    "format": "fk_autocomplete",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "path": {
                                "title": "Path",
                                "type": "string",
                                "maxLength": 1024,
                                "minLength": 1
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "readOnly": true
                            }
                        },
                        "value_field": "name",
                        "view_field": "path",
                        "usePrefetch": true
                    }
                },
                "TEMPLATE": "hidden"
            }
        }
    },
    "inventory": {
        "title": "Inventory",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {}
        }
    },
    "save_result": {
        "title": "Save result",
        "type": "boolean"
    },
    "template": {
        "title": "Template",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "PLAYBOOK": "hidden",
                "MODULE": "hidden",
                "TEMPLATE": {
                    "type": "integer",
                    "format": "fk",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "maxLength": 512,
                                "minLength": 1
                            },
                            "kind": {
                                "title": "Type",
                                "type": "string",
                                "enum": [
                                    "Task",
                                    "Module"
                                ],
                                "default": "Task"
                            }
                        },
                        "value_field": "id",
                        "view_field": "name",
                        "usePrefetch": true,
                        "makeLink": true,
                        "dependence": null,
                        "filters": null
                    }
                }
            }
        },
        "x-nullable": true
    },
    "template_opt": {
        "title": "Template opt",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "template",
            "choices": {},
            "types": {}
        },
        "x-nullable": true
    },
    "enabled": {
        "title": "Enabled",
        "type": "boolean"
    },
    "type": {
        "title": "Interval type",
        "type": "string",
        "enum": [
            "CRONTAB",
            "INTERVAL"
        ],
        "default": "CRONTAB"
    },
    "schedule": {
        "title": "Schedule",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "type",
            "choices": {},
            "types": {
                "CRONTAB": "crontab",
                "INTERVAL": "integer"
            }
        }
    }
}

OnePeriodictask Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "kind": {
        "title": "Task type",
        "type": "string",
        "enum": [
            "PLAYBOOK",
            "MODULE",
            "TEMPLATE"
        ],
        "default": "PLAYBOOK"
    },
    "mode": {
        "title": "Mode",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "PLAYBOOK": {
                    "type": "string",
                    "format": "fk_autocomplete",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "maxLength": 251,
                                "minLength": 1
                            },
                            "playbook": {
                                "title": "Playbook",
                                "type": "string",
                                "maxLength": 256,
                                "minLength": 1
                            }
                        },
                        "value_field": "playbook",
                        "view_field": "playbook",
                        "usePrefetch": true
                    }
                },
                "MODULE": {
                    "type": "string",
                    "format": "fk_autocomplete",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "path": {
                                "title": "Path",
                                "type": "string",
                                "maxLength": 1024,
                                "minLength": 1
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "readOnly": true
                            }
                        },
                        "value_field": "name",
                        "view_field": "path",
                        "usePrefetch": true
                    }
                },
                "TEMPLATE": "hidden"
            }
        }
    },
    "inventory": {
        "title": "Inventory",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {}
        }
    },
    "save_result": {
        "title": "Save result",
        "type": "boolean"
    },
    "template": {
        "title": "Template",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "kind",
            "choices": {},
            "types": {
                "PLAYBOOK": "hidden",
                "MODULE": "hidden",
                "TEMPLATE": {
                    "type": "integer",
                    "format": "fk",
                    "x-options": {
                        "model": {
                            "id": {
                                "title": "Id",
                                "type": "integer",
                                "readOnly": true
                            },
                            "name": {
                                "title": "Name",
                                "type": "string",
                                "maxLength": 512,
                                "minLength": 1
                            },
                            "kind": {
                                "title": "Type",
                                "type": "string",
                                "enum": [
                                    "Task",
                                    "Module"
                                ],
                                "default": "Task"
                            }
                        },
                        "value_field": "id",
                        "view_field": "name",
                        "usePrefetch": true,
                        "makeLink": true,
                        "dependence": null,
                        "filters": null
                    }
                }
            }
        },
        "x-nullable": true
    },
    "template_opt": {
        "title": "Template opt",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "template",
            "choices": {},
            "types": {}
        },
        "x-nullable": true
    },
    "enabled": {
        "title": "Enabled",
        "type": "boolean"
    },
    "type": {
        "title": "Interval type",
        "type": "string",
        "enum": [
            "CRONTAB",
            "INTERVAL"
        ],
        "default": "CRONTAB"
    },
    "schedule": {
        "title": "Schedule",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "type",
            "choices": {},
            "types": {
                "CRONTAB": "crontab",
                "INTERVAL": "integer"
            }
        }
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "format": "textarea"
    }
}

PeriodicTaskVariable Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "key": {
        "title": "Key",
        "type": "string",
        "maxLength": 512,
        "minLength": 1
    },
    "value": {
        "title": "Value",
        "type": "string",
        "default": ""
    }
}

Playbook Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 251,
        "minLength": 1
    },
    "playbook": {
        "title": "Playbook",
        "type": "string",
        "maxLength": 256,
        "minLength": 1
    }
}

OnePlaybook Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 251,
        "minLength": 1
    },
    "playbook": {
        "title": "Playbook",
        "type": "string",
        "readOnly": true,
        "minLength": 1
    }
}

ProjectVariable Schema¶

{
    "id": {
        "title": "Id",
        "type": "integer",
        "readOnly": true
    },
    "key": {
        "title": "Key",
        "type": "string",
        "format": "autocomplete",
        "enum": [
            "repo_type",
            "repo_sync_on_run",
            "repo_sync_on_run_timeout",
            "repo_branch",
            "repo_password",
            "repo_key",
            "playbook_path",
            "ci_template"
        ]
    },
    "value": {
        "title": "Value",
        "type": "string",
        "format": "dynamic",
        "x-options": {
            "field": "key",
            "choices": {
                "repo_type": [
                    "MANUAL",
                    "GIT",
                    "TAR"
                ],
                "repo_sync_on_run": [
                    true,
                    false
                ]
            },
            "types": {
                "repo_password": "password",
                "repo_key": "secretfile",
                "repo_sync_on_run_timeout": "uptime",
                "ci_template": "fk"
            }
        }
    }
}

Team Schema¶

{
    "id": {
        "title": "ID",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 150,
        "minLength": 1
    }
}

OneTeam Schema¶

{
    "id": {
        "title": "ID",
        "type": "integer",
        "readOnly": true
    },
    "name": {
        "title": "Name",
        "type": "string",
        "maxLength": 150,
        "minLength": 1
    },
    "notes": {
        "title": "Notes",
        "type": "string",
        "format": "textarea"
    },
    "owner": {
        "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
        }
    }
}

CreateUser 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
    },
    "is_staff": {
        "title": "Is staff",
        "type": "boolean",
        "default": false
    },
    "first_name": {
        "title": "First name",
        "type": "string",
        "maxLength": 150
    },
    "last_name": {
        "title": "Last name",
        "type": "string",
        "maxLength": 150
    },
    "email": {
        "title": "Email",
        "type": "string",
        "format": "email",
        "minLength": 1
    },
    "password": {
        "title": "Password",
        "type": "string",
        "minLength": 1
    },
    "password2": {
        "title": "Repeat password",
        "type": "string",
        "minLength": 1
    }
}

OneUser 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
    },
    "first_name": {
        "title": "First name",
        "type": "string",
        "maxLength": 150
    },
    "last_name": {
        "title": "Last name",
        "type": "string",
        "maxLength": 150
    },
    "email": {
        "title": "Email",
        "type": "string",
        "format": "email",
        "minLength": 1
    }
}

_MainSettings Schema¶

{
    "language": {
        "title": "Language",
        "type": "string",
        "enum": [
            "en",
            "ru",
            "cn",
            "vi"
        ]
    },
    "dark_mode": {
        "title": "Dark mode",
        "type": "boolean",
        "default": false
    }
}

_UserSettings Schema¶

{
    "main": {
        "language": {
            "title": "Language",
            "type": "string",
            "enum": [
                "en",
                "ru",
                "cn",
                "vi"
            ]
        },
        "dark_mode": {
            "title": "Dark mode",
            "type": "boolean",
            "default": false
        }
    },
    "custom": {
        "title": "Custom",
        "type": "string",
        "format": "json",
        "default": {}
    }
}

ChangePassword Schema¶

{
    "old_password": {
        "title": "Old password",
        "type": "string",
        "format": "password"
    },
    "password": {
        "title": "New password",
        "type": "string",
        "format": "password"
    },
    "password2": {
        "title": "Confirm new password",
        "type": "string",
        "format": "password"
    }
}

ChartLineSetting Schema¶

{
    "active": {
        "title": "Active",
        "type": "boolean",
        "default": true
    }
}

ChartLineSettings Schema¶

{
    "all_tasks": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    },
    "delay": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    },
    "ok": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    },
    "error": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    },
    "interrupted": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    },
    "offline": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        }
    }
}

CounterWidgetSetting Schema¶

{
    "active": {
        "title": "Active",
        "type": "boolean",
        "default": true
    },
    "collapse": {
        "title": "Collapse",
        "type": "boolean",
        "readOnly": true,
        "default": false
    },
    "sort": {
        "title": "Sort",
        "type": "integer",
        "default": 0
    }
}

WidgetSetting Schema¶

{
    "active": {
        "title": "Active",
        "type": "boolean",
        "default": true
    },
    "collapse": {
        "title": "Collapse",
        "type": "boolean",
        "default": false
    },
    "sort": {
        "title": "Sort",
        "type": "integer",
        "default": 0
    }
}

WidgetSettings Schema¶

{
    "pmwUsersCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwProjectsCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwTemplatesCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwInventoriesCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwGroupsCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwHostsCounter": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "readOnly": true,
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    },
    "pmwChartWidget": {
        "active": {
            "title": "Active",
            "type": "boolean",
            "default": true
        },
        "collapse": {
            "title": "Collapse",
            "type": "boolean",
            "default": false
        },
        "sort": {
            "title": "Sort",
            "type": "integer",
            "default": 0
        }
    }
}

UserSettings Schema¶

{
    "lang": {
        "title": "Lang",
        "type": "string",
        "enum": [
            "en",
            "ru",
            "cn",
            "vi"
        ],
        "default": "en"
    },
    "autoupdateInterval": {
        "title": "Autoupdateinterval",
        "type": "integer",
        "default": 15000
    },
    "chartLineSettings": {
        "all_tasks": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        },
        "delay": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        },
        "ok": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        },
        "error": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        },
        "interrupted": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        },
        "offline": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            }
        }
    },
    "widgetSettings": {
        "pmwUsersCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwProjectsCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwTemplatesCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwInventoriesCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwGroupsCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwHostsCounter": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "readOnly": true,
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        },
        "pmwChartWidget": {
            "active": {
                "title": "Active",
                "type": "boolean",
                "default": true
            },
            "collapse": {
                "title": "Collapse",
                "type": "boolean",
                "default": false
            },
            "sort": {
                "title": "Sort",
                "type": "integer",
                "default": 0
            }
        }
    },
    "selectedSkin": {
        "title": "Selectedskin",
        "type": "string",
        "minLength": 1
    },
    "skinsSettings": {}
}

TwoFA Schema¶

{
    "enabled": {
        "title": "Enabled",
        "type": "boolean",
        "readOnly": true
    },
    "secret": {
        "title": "Secret",
        "type": "string",
        "minLength": 1,
        "x-nullable": true
    },
    "pin": {
        "title": "Enter the six-digit code from the application",
        "type": "string",
        "minLength": 1
    },
    "recovery": {
        "title": "Recovery",
        "type": "string",
        "minLength": 1
    }
}

'Polemarch' documentation

API¶

Structure¶

API Paths¶

Schemas Description¶

ProjectTemplate Schema¶

OneProjectTemplate Schema¶

ProjectTemplateCreate Schema¶

Group Schema¶

User Schema¶

GroupCreateMaster Schema¶

OneGroup Schema¶

Host Schema¶

OneHost Schema¶

SetOwner Schema¶

InventoryVariable Schema¶

History Schema¶

OneHistory Schema¶

Empty Schema¶

ActionResponse Schema¶

Data Schema¶

Hook Schema¶

Inventory Schema¶

OneInventory Schema¶

InventoryImport Schema¶

Project Schema¶

ProjectCreateMaster Schema¶

OneProject Schema¶

AnsibleModule Schema¶

ExecuteResponse Schema¶

AnsiblePlaybook Schema¶

ExecutionTemplate Schema¶

CreateExecutionTemplate Schema¶

OneExecutionTemplate Schema¶

TemplateExec Schema¶

TemplateOption Schema¶

CreateTemplateOption Schema¶

OneTemplateOption Schema¶

ProjectHistory Schema¶

InventoryFileImport Schema¶

Module Schema¶

OneModule Schema¶

Periodictask Schema¶

OnePeriodictask Schema¶

PeriodicTaskVariable Schema¶

Playbook Schema¶

OnePlaybook Schema¶

ProjectVariable Schema¶

Team Schema¶

OneTeam Schema¶

CreateUser Schema¶

OneUser Schema¶

_MainSettings Schema¶

_UserSettings Schema¶

ChangePassword Schema¶

ChartLineSetting Schema¶

ChartLineSettings Schema¶

CounterWidgetSetting Schema¶

WidgetSetting Schema¶

WidgetSettings Schema¶

UserSettings Schema¶

TwoFA Schema¶