Backend API manual¶
VST Utils framework consolidates such frameworks as Django, Django Rest Framework, drf-yasg and Celery. Below are descriptions of some features used in the development of projects based on vstutils.
Models¶
A model is the single, definitive source of truth about your data. It contains the essential fields and behaviors of the data you’re storing. The goal is to define your data model in one place and automatically derive things from it. You can also define everything you need to get the generated view from the model.
Also you can use custom models without using database:¶
Utils¶
This is some tested set of development utilities. Utilities include a collection of some code that will be useful in one way or another to develop the application. Most of the functions are used by vstutils itself.
Web API¶
Web API is based on Django Rest Framework with some nested functions.
Fields¶
There is additional fields which extends API and GUI. Also, it would be usefull for customizing frontend view without write any JS code.
There is useful validation classes for fields.
Serializers¶
Views¶
Filtersets¶
For greater development convenience, the framework provides additional classes and functions for filtering elements by fields.
Responses¶
DRF provides a standard set of variables whose names correspond to the human-readable name of the HTTP code. For convenience, we have dynamically wrapped this in a set of classes that have appropriate names and additionally provide the following capabilities:
String responses are wrapped in json like
{ "detail": "string response" }
.Keep attribute timings for further processing in middlewares.
Set status code from class name (e.g.
HTTP_200_OK
orResponse200
got code 200).
All classes inherit from:
Middlewares¶
By default, the Django assumes that the developer will develop itself Middleware class, but it is not always convenient. The vstutils library offers a convenient request handler class for elegant OOP development. Middlewares is needed to process incoming requests and sent responses before they reach the final destination.
Endpoint¶
Endpoint view has two purposes: bulk requests execution and providing openapi schema.
Endpoint url is /{API_URL}/endpoint/
, for example value with default settings is /api/endpoint/
.
API_URL
can be changed in settings.py
.
Bulk requests¶
Bulk request allows you send multiple request to api at once, it accepts json list of operations.
Method |
Transactional (all operations in one transaction) |
Synchronous (operations executed one by one in given order) |
---|---|---|
|
NO |
YES |
|
YES |
YES |
|
NO |
NO |
Parameters of one operation (* means that parameter is required):
method
* - http method of requestpath
* - path of request, can bestr
orlist
data
- data that needs to be sentquery
- query parameters asstr
headers
-dict
with headers which will be sent, names of headers must follow CGI specification (e.g.,CONTENT_TYPE
,GATEWAY_INTERFACE
,HTTP_*
).version
-str
with specified version of api, if not provided thenVST_API_VERSION
will be used
In any request parameter you can insert result value of previous operations
(<<{OPERATION_NUMBER}[path][to][value]>>
), for example:
[
{"method": "post", "path": "user", "data": {"name": "User 1"}),
{"method": "delete", "version": "v2", "path": ["user", "<<0[data][id]>>"]}
]
Result of bulk request is json list of objects for operation:
method
- http methodpath
- path of request, always strdata
- data that needs to be sentstatus
- response status code
Transactional bulk request returns 502 BAG GATEWAY
and make rollback if one of requests is failed.
Warning
If you send non-transactional bulk request, you will get 200
status and must
validate statuses on each operation responses.
Openapi schema¶
Request on GET /{API_URL}/endpoint/
returns Swagger UI.
Request on GET /{API_URL}/endpoint/?format=openapi
returns json openapi schema. Also you can specify required
version of schema using version
query parameter (e.g., GET /{API_URL}/endpoint/?format=openapi&version=v2
).
Applying hooks to the schema can also be helpful.
This functionality will help to change certain data in the schema before it will be sended to user.
In order to set some hooks, it is enough to specify in settings.py
the OPENAPI_HOOKS
which is an array with lines for importing functions.
Each function will take 2 named arguments:
request
- user request object.schema
- ordered dict with openapi schema.
Note
Sometimes hooks may raise an exception, and in order not to break the chain of data modification, such exceptions are handled. However, the changes made to the schema before the raised exception will be saved.
- Example hook:
def hook_add_username_to_guiname(request, schema): schema['info']['title'] = f"{request.username} - {schema['info']['title']}"
Testing Framework¶
VST Utils Framework includes a few helper in base testcase class and improve support for making API requests. That means if you want make bulk request to endpoint you dont need create and init test client, but just need to call:
endpoint_results = self.bulk([
# list of endpoint requests
])
Creating test case¶
After creating new project via vstutils
you can found test.py
module,
where you see testcase classes based on vstutils.tests.BaseTestCase
.
At the moment, we officially support two styles of writing tests:
through classic and simple query wrappers with run check and
through runtime optimized bulk queries with manual value checking.
Simple example with classic tests¶
For example, if you have api endpoint like /api/v1/project/
and model Project
you can write testcase like this:
from vstutils.tests import BaseTestCase
class ProjectTestCase(BaseTestCase):
def setUp(self):
super(ProjectTestCase, self).setUp()
# init demo project
self.initial_project = self.get_model_class('project.Test').objects.create(name="Test")
def tearDown(self)
super(ProjectTestCase, self).tearDown()
# remove it after test
self.initial_project.delete()
def test_project_endpoint(self):
# Test checks that api return valid values
self.list_test('/api/v1/project/', 1)
self.details_test(
["project", self.initial_project.id],
name=self.initial_project.name
)
# Try to create new projects and check list endpoint
test_data = [
{"name": f"TestProject{i}"}
for i in range(2)
]
id_list = self.mass_create("/api/v1/project/", test_data, 'name')
self.list_test('/api/v1/project/', 1 + len(id_list))
This simple example demonstrate functionality of default test case class. Default projects are initialized in such a way that for the fastest and most efficient result it is best to distribute testing of various entities into different classes. This example demonstrate classic style of testing, but you can use bulks in your test cases.
Bulk requests in tests¶
The bulk query system and its capabilities are very well suited for testing and executing valid queries. Returning to the previous example, it could be rewritten as follows:
from vstutils.tests import BaseTestCase
class ProjectTestCase(BaseTestCase):
def setUp(self):
super(ProjectTestCase, self).setUp()
# init demo project
self.initial_project = self.get_model_class('project.Test').objects.create(name="Test")
def tearDown(self)
super(ProjectTestCase, self).tearDown()
# remove it after test
self.initial_project.delete()
def test_project_endpoint(self):
test_data = [
{"name": f"TestProject{i}"}
for i in range(2)
]
bulk_data = [
{"method": "get", "path": ["project"]},
{"method": "get", "path": ["project", self.initial_project.id]}
]
bulk_data += [
{"method": "post", "path": ["project"], "data": i}
for i in test_data
]
bulk_data.append(
{"method": "get", "path": ["project"]}
)
results = self.bulk_transactional(bulk_data)
self.assertEqual(results[0]['status'], 200)
self.assertEqual(results[0]['data']['count'], 1)
self.assertEqual(results[1]['status'], 200)
self.assertEqual(results[1]['data']['name'], self.initial_project.name)
for pos, result in enumerate(results[2:-1]):
self.assertEqual(result['status'], 201)
self.assertEqual(result['data']['name'], test_data[pos]['name'])
self.assertEqual(results[-1]['status'], 200)
self.assertEqual(results[-1]['data']['count'], 1 + len(test_data))
In this case, you have more code rows, but your tests will be closer to GUI workflow,
because vstutils-projects uses /api/endpoint/
for requests.
Either way, bulk queries are much faster due to some optimizations,
so you can reduce testcase execution time.
Test case API¶
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 string ordering
Which field to use when ordering the results.
- 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, additionalProperties=OrderedDict([(‘redirect’, True)]), x-nullable=True)
name (string) – Name(minLength=1)
- param integer id(required)
A unique value identifying this project template.
- query schema data(required)
-
GET
/group/
¶ Return all groups.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/group/?limit=1&offset=1", "previous": null, "results": [ { "id": 1, "name": "example name", "children": true, "from_project": true } ] }
- JSON Parameters
count (integer) – None
next (uri) – (x-nullable=True)
previous (uri) – (x-nullable=True)
results (array) – (Group Schema)
- query string 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 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 string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/
¶ Create a new group.
Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Contains groups(default=False)
owner (object) – (User Schema)
- Query Parameters
data(required) (schema) – GroupCreateMaster Schema
-
GET
/group/{id}/
¶ Return a group instance.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(readOnly=True)
owner (object) – (User Schema)
- param integer id(required)
A unique integer value identifying this group.
-
PUT
/group/{id}/
¶ Update a group.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(readOnly=True)
owner (object) – (User Schema)
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
PATCH
/group/{id}/
¶ Update one or more fields on an existing group.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(readOnly=True)
owner (object) – (User Schema)
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
DELETE
/group/{id}/
¶ Remove an existing group.
Example Response
HTTP/1.1 204 No Content Vary: NO CONTENT Content-Type: application/json {}
- param integer id(required)
A unique integer value identifying this group.
-
POST
/group/{id}/copy/
¶ Endpoint which copy instance with deps.
Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "id": 1, "name": "example name", "children": true, "from_project": true }
- JSON Parameters
id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
children (boolean) – Children(readOnly=True)
from_project (boolean) – Project Based(readOnly=True)
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
GET
/group/{id}/group/
¶ Return all groups.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/group/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 group.
- query string 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 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 string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/{id}/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\ntext\narea\n", "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 (textarea) – Notes
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)
-
GET
/group/{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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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 group.
-
PUT
/group/{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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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 group.
- query schema data(required)
-
PATCH
/group/{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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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 group.
- query schema data(required)
-
DELETE
/group/{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 group.
-
POST
/group/{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(readOnly=True)
from_project (boolean) – Project Based(readOnly=True)
- 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 group.
- query schema data(required)
-
POST
/group/{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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer group_id(required)
A unique integer value identifying instance of this groups sublist.
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
GET
/group/{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/group/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 group.
- query string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/{id}/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 group.
- query schema data(required)
-
GET
/group/{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 group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
PUT
/group/{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 group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
- query schema data(required)
-
PATCH
/group/{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 group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
- query schema data(required)
-
DELETE
/group/{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 group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
GET
/group/{id}/host/
¶ Return all hosts.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/group/1/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)
- param integer id(required)
A unique integer value identifying this group.
- query string 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 string 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 string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/{id}/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)
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
GET
/group/{id}/host/{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 host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this group.
-
PUT
/group/{id}/host/{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 host_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)
-
PATCH
/group/{id}/host/{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 host_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)
-
DELETE
/group/{id}/host/{host_id}/
¶ Remove an existing host.
Example Response
HTTP/1.1 204 No Content Vary: NO CONTENT Content-Type: application/json {}
- param integer host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this group.
-
POST
/group/{id}/host/{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 host_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)
-
POST
/group/{id}/host/{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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer host_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)
-
GET
/group/{id}/host/{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/group/1/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 host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this group.
- query string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/{id}/host/{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 host_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)
-
GET
/group/{id}/host/{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 host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
PUT
/group/{id}/host/{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 host_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)
-
PATCH
/group/{id}/host/{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 host_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)
-
DELETE
/group/{id}/host/{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 host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
POST
/group/{id}/set_owner/
¶ Change instance owner.
Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "user_id": 1 }
- JSON Parameters
user_id (fk) – New owner(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
GET
/group/{id}/variables/
¶ Return all variables of instance.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/group/1/variables/?limit=1&offset=1", "previous": null, "results": [ { "id": 1, "key": "ansible_host", "value": "test_dynamic" } ] }
- JSON Parameters
count (integer) – None
next (uri) – (x-nullable=True)
previous (uri) – (x-nullable=True)
results (array) – (InventoryVariable Schema)
- param integer id(required)
A unique integer value identifying this group.
- query string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- query integer limit
Number of results to return per page.
- query integer offset
The initial index from which to return the results.
-
POST
/group/{id}/variables/
¶ Create a new variable of instance.
Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "id": 1, "key": "ansible_host", "value": "test_dynamic" }
- JSON Parameters
id (integer) – Id(readOnly=True)
key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)
value (dynamic) – Value
- param integer id(required)
A unique integer value identifying this group.
- query schema data(required)
-
GET
/group/{id}/variables/{variables_id}/
¶ Return a variable of instance.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "key": "ansible_host", "value": "test_dynamic" }
- JSON Parameters
id (integer) – Id(readOnly=True)
key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)
value (dynamic) – Value
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
PUT
/group/{id}/variables/{variables_id}/
¶ Update variable value.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "key": "ansible_host", "value": "test_dynamic" }
- JSON Parameters
id (integer) – Id(readOnly=True)
key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)
value (dynamic) – Value
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
- query schema data(required)
-
PATCH
/group/{id}/variables/{variables_id}/
¶ Update one or more fields on an existing variable.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "key": "ansible_host", "value": "test_dynamic" }
- JSON Parameters
id (integer) – Id(readOnly=True)
key (autocomplete) – Key(Example values: ansible_host, ansible_port, ansible_user, ansible_connection, ansible_ssh_pass, ansible_ssh_private_key_file, ansible_ssh_common_args, ansible_sftp_extra_args, ansible_scp_extra_args, ansible_ssh_extra_args, ansible_ssh_executable, ansible_ssh_pipelining, ansible_become, ansible_become_method, ansible_become_user, ansible_become_pass, ansible_become_exe, ansible_become_flags, ansible_shell_type, ansible_python_interpreter, ansible_ruby_interpreter, ansible_perl_interpreter, ansible_shell_executable)
value (dynamic) – Value
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
- query schema data(required)
-
DELETE
/group/{id}/variables/{variables_id}/
¶ Remove an existing variable.
Example Response
HTTP/1.1 204 No Content Vary: NO CONTENT Content-Type: application/json {}
- param integer id(required)
A unique integer value identifying this group.
- param integer variables_id(required)
A unique integer value identifying instance of this variables sublist.
-
GET
/history/
¶ Return all history of executions.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/history/?limit=1&offset=1", "previous": null, "results": [ { "id": 1, "start_time": "2019-01-07T06:10:31+10:00", "executor": 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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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)
-
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 string 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 string 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 ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this host.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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, additionalProperties=OrderedDict([(‘redirect’, True)]), 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)
-
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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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\ntext\narea\n", "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 (textarea) – Notes
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)
-
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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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)
-
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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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)
-
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(readOnly=True)
from_project (boolean) – Project Based(readOnly=True)
- 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)
-
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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer group_id(required)
A unique integer value identifying instance of this groups sublist.
- param integer id(required)
A unique integer value identifying this inventory.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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}/host/
¶ Return all hosts.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/inventory/1/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)
- param integer id(required)
A unique integer value identifying this inventory.
- query string 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 string 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 string ordering
Which field to use when ordering the results.
- 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}/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)
- param integer id(required)
A unique integer value identifying this inventory.
- query schema data(required)
-
GET
/inventory/{id}/host/{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 host_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}/host/{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 host_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)
-
PATCH
/inventory/{id}/host/{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 host_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)
-
DELETE
/inventory/{id}/host/{host_id}/
¶ Remove an existing host.
Example Response
HTTP/1.1 204 No Content Vary: NO CONTENT Content-Type: application/json {}
- param integer host_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}/host/{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 host_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)
-
POST
/inventory/{id}/host/{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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer host_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)
-
GET
/inventory/{id}/host/{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/inventory/1/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 host_id(required)
A unique integer value identifying instance of this hosts sublist.
- param integer id(required)
A unique integer value identifying this inventory.
- query string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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}/host/{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 host_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)
-
GET
/inventory/{id}/host/{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 host_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}/host/{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 host_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)
-
PATCH
/inventory/{id}/host/{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 host_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)
-
DELETE
/inventory/{id}/host/{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 host_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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this inventory.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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 string 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 status
Project sync status.
- query string 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 string status__not
Project sync status.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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(additionalProperties=OrderedDict([(‘redirect’, True)]), x-nullable=True)
executor (integer) – Executor(x-nullable=True)
- param integer id(required)
A unique integer value identifying this project.
- query schema data(required)
-
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(additionalProperties=OrderedDict([(‘redirect’, True)]), x-nullable=True)
executor (integer) – Executor(x-nullable=True)
- param integer id(required)
A unique integer value identifying this project.
- query schema data(required)
-
GET
/project/{id}/history/
¶ 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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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}/
¶ 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}/
¶ 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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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)
-
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, additionalProperties=OrderedDict([(‘redirect’, True)]), 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)
-
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, additionalProperties=OrderedDict([(‘redirect’, True)]), 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)
-
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)
-
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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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)
-
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 string 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 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 string ordering
Which field to use when ordering the results.
- 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\ntext\narea\n", "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 (textarea) – Notes
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)
-
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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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)
-
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\ntext\narea\n", "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 (textarea) – Notes
children (boolean) – Children(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)
-
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(readOnly=True)
from_project (boolean) – Project Based(readOnly=True)
- 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)
-
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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param string group_id(required)
- param integer id(required)
A unique integer value identifying this project.
- param integer inventory_id(required)
A unique integer value identifying instance of this inventories sublist.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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}/host/
¶ 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/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)
- 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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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}/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)
- 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)
-
GET
/project/{id}/inventory/{inventory_id}/host/{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 string host_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}/host/{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 string host_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)
-
PATCH
/project/{id}/inventory/{inventory_id}/host/{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 string host_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)
-
DELETE
/project/{id}/inventory/{inventory_id}/host/{host_id}/
¶ Remove an existing host.
Example Response
HTTP/1.1 204 No Content Vary: NO CONTENT Content-Type: application/json {}
- param string host_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}/host/{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 string host_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)
-
POST
/project/{id}/inventory/{inventory_id}/host/{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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param string host_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)
-
GET
/project/{id}/inventory/{inventory_id}/host/{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/project/1/inventory/1/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 string host_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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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}/host/{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 string host_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)
-
GET
/project/{id}/inventory/{inventory_id}/host/{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 string host_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}/host/{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 string host_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)
-
PATCH
/project/{id}/inventory/{inventory_id}/host/{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 string host_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)
-
DELETE
/project/{id}/inventory/{inventory_id}/host/{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 string host_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.
-
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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this project.
- param integer inventory_id(required)
A unique integer value identifying instance of this inventories sublist.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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 string ordering
Which field to use when ordering the results.
- 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": {} }
- JSON Parameters
id (integer) – Id(readOnly=True)
path (string) – Path(maxLength=1024, minLength=1)
name (string) – Name(readOnly=True)
data (object) – 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": 1, "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 string 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 string 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 ordering
Which field to use when ordering the results.
- 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": 1, "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 (integer) – Template(x-nullable=True)
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)
-
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": 1, "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 (integer) – Template(x-nullable=True)
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": 1, "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 (integer) – Template(x-nullable=True)
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)
-
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": 1, "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 (integer) – Template(x-nullable=True)
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)
-
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(additionalProperties=OrderedDict([(‘redirect’, True)]), 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)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this project.
- query schema data(required)
-
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)
-
GET
/project/{id}/template/
¶ Return all execute templates in project.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "count": 2, "next": "http://localhost:8080/project/1/template/?limit=1&offset=1", "previous": null, "results": [ { "id": 1, "name": "example name", "kind": "Task", "data": {}, "options": {}, "options_list": [ "array_example" ] } ] }
- JSON Parameters
count (integer) – None
next (uri) – (x-nullable=True)
previous (uri) – (x-nullable=True)
results (array) – (Template Schema)
- param integer id(required)
A unique integer value identifying this project.
- query string 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 string 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 ordering
Which field to use when ordering the results.
- 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}/template/
¶ Create a new execute template.
Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "kind": "Task", "data": {}, "options": {}, "options_list": [ "array_example" ] }
- JSON Parameters
id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
notes (textarea) – Notes
kind (string) – Type(enum=[‘Task’, ‘Module’], default=Task)
data (object) – (Data Schema)
options (object) – (Data Schema)
options_list (array) – (items=OrderedDict([(‘type’, ‘string’)]), readOnly=True)
- param integer id(required)
A unique integer value identifying this project.
- query schema data(required)
-
GET
/project/{id}/template/{template_id}/
¶ Return a execute template instance.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "kind": "Task", "data": {}, "options": {}, "options_list": [ "array_example" ] }
- JSON Parameters
id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
notes (textarea) – Notes
kind (string) – Type(enum=[‘Task’, ‘Module’], default=Task)
data (object) – (Data Schema)
options (object) – (Data Schema)
options_list (array) – (items=OrderedDict([(‘type’, ‘string’)]), readOnly=True)
- param integer id(required)
A unique integer value identifying this project.
- param integer template_id(required)
A unique integer value identifying instance of this template sublist.
-
PUT
/project/{id}/template/{template_id}/
¶ Update a execute template.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "kind": "Task", "data": {}, "options": {}, "options_list": [ "array_example" ] }
- JSON Parameters
id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
notes (textarea) – Notes
kind (string) – Type(enum=[‘Task’, ‘Module’], default=Task)
data (object) – (Data Schema)
options (object) – (Data Schema)
options_list (array) – (items=OrderedDict([(‘type’, ‘string’)]), readOnly=True)
- param integer id(required)
A unique integer value identifying this project.
- param integer template_id(required)
A unique integer value identifying instance of this template sublist.
- query schema data(required)
-
PATCH
/project/{id}/template/{template_id}/
¶ Update one or more fields on an existing execute template.
Example Response
HTTP/1.1 200 OK Vary: OK Content-Type: application/json { "id": 1, "name": "example name", "notes": "example\ntext\narea\n", "kind": "Task", "data": {}, "options": {}, "options_list": [ "array_example" ] }
- JSON Parameters
id (integer) – Id(readOnly=True)
name (string) – Name(maxLength=512, minLength=1)
notes (textarea) – Notes
kind (string) – Type(enum=[‘Task’, ‘Module’], default=Task)
data (object) – (Data Schema)
options (object) – (Data Schema)
options_list (array) – (items=OrderedDict([(‘type’, ‘string’)]), readOnly=True)
- param integer id(required)
A unique integer value identifying this project.
- param integer template_id(required)
A unique integer value identifying instance of this template sublist.
- query schema data(required)
-
DELETE
/project/{id}/template/{template_id}/
¶ Remove an existing execute template.
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 template_id(required)
A unique integer value identifying instance of this template sublist.
-
POST
/project/{id}/template/{template_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(additionalProperties=OrderedDict([(‘redirect’, True)]), x-nullable=True)
executor (integer) – Executor(x-nullable=True)
- param integer id(required)
A unique integer value identifying this project.
- param integer template_id(required)
A unique integer value identifying instance of this template sublist.
- query schema data(required)
-
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 string 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 string id__not
A unique integer value (or comma separated list) identifying this instance.
- query string ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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 string 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 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 ordering
Which field to use when ordering the results.
- 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)
-
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)
-
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)
-
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(additionalProperties=OrderedDict([(‘model’, OrderedDict([(‘$ref’, ‘#/definitions/User’)])), (‘value_field’, ‘id’), (‘view_field’, ‘username’)]))
- param integer id(required)
A unique integer value identifying this user group.
- query schema data(required)
-
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 string 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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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=30)
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)
-
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=30)
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=30)
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)
-
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=30)
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)
-
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.
-
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": "example old_password", "password": "example password", "password2": "example password2" }
- JSON Parameters
old_password (string) – Old password(minLength=1)
password (string) – New password(minLength=1)
password2 (string) – Confirm new password(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)
-
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)
-
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.
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’], 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/
¶ 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.
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’], 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)
-
DELETE
/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.
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
/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 string 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 string 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 string 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 string ordering
Which field to use when ordering the results.
- 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=30)
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=30)
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=30)
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)
-
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=30)
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)
-
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.
-
POST
/user/{id}/change_password/
¶ Example Response
HTTP/1.1 201 Created Vary: CREATED Content-Type: application/json { "old_password": "example old_password", "password": "example password", "password2": "example password2" }
- JSON Parameters
old_password (string) – Old password(minLength=1)
password (string) – New password(minLength=1)
password2 (string) – Confirm new password(minLength=1)
- param integer id(required)
A unique integer value identifying this user.
- query schema data(required)
-
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)
-
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’], 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’], 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)
-
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.
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, "additionalProperties": { "redirect": true }, "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", "readOnly": true }, "from_project": { "title": "Project Based", "type": "boolean", "readOnly": true } }
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", "format": "textarea" }, "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", "format": "textarea" }, "children": { "title": "Children", "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 } } }
SetOwner Schema¶
{ "user_id": { "title": "New owner", "type": "integer", "format": "fk", "additionalProperties": { "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" } } }
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", "additionalProperties": { "choices": {}, "field": "key", "types": { "ansible_become": "boolean", "ansible_become_pass": "password", "ansible_port": "integer", "ansible_ssh_pass": "password", "ansible_ssh_private_key_file": "secretfile" } } } }
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 } } }
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, "additionalProperties": { "redirect": true }, "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", "additionalProperties": { "choices": { "GIT": [ "NONE", "KEY", "PASSWORD" ] }, "field": "type", "types": { "GIT": "string", "MANUAL": "hidden", "TAR": "hidden" } } }, "auth_data": { "title": "Repo auth data", "type": "string", "format": "dynamic", "default": "", "additionalProperties": { "choices": {}, "field": "repo_auth", "types": { "KEY": "secretfile", "NONE": "hidden", "PASSWORD": "password" } } }, "branch": { "title": "Branch for GIT(branch/tag/SHA) or TAR(subdir)", "type": "string", "format": "dynamic", "additionalProperties": { "choices": {}, "field": "type", "types": { "GIT": "string", "MANUAL": "hidden", "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": "autocomplete", "additionalProperties": { "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" } }, "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" }, "become_user": { "title": "Become user", "description": "run operations as this user (default=root)", "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": "autocomplete", "additionalProperties": { "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" } }, "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 }, "module_path": { "title": "Module path", "description": "prepend colon-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)", "type": "string" }, "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_id": { "title": "Vault id", "description": "the vault identity to use", "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", "additionalProperties": { "redirect": true }, "x-nullable": true }, "executor": { "title": "Executor", "type": "integer", "x-nullable": true } }
AnsiblePlaybook Schema¶
{ "playbook": { "title": "Playbook", "type": "string", "format": "autocomplete", "additionalProperties": { "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" } }, "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" }, "become_user": { "title": "Become user", "description": "run operations as this user (default=root)", "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": "autocomplete", "additionalProperties": { "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" } }, "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 }, "module_path": { "title": "Module path", "description": "prepend colon-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)", "type": "string" }, "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_id": { "title": "Vault id", "description": "the vault identity to use", "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 } }
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, "additionalProperties": { "redirect": true }, "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": "object", "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", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "fk_autocomplete", "PLAYBOOK": "fk_autocomplete", "TEMPLATE": "hidden" } } }, "inventory": { "title": "Inventory", "type": "string", "format": "dynamic", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "fk_autocomplete", "PLAYBOOK": "fk_autocomplete", "TEMPLATE": "hidden" } } }, "save_result": { "title": "Save result", "type": "boolean" }, "template": { "title": "Template", "type": "integer", "x-nullable": true }, "template_opt": { "title": "Template opt", "type": "string", "format": "dynamic", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "hidden", "PLAYBOOK": "hidden", "TEMPLATE": "autocomplete" } }, "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", "additionalProperties": { "choices": {}, "field": "type", "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", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "fk_autocomplete", "PLAYBOOK": "fk_autocomplete", "TEMPLATE": "hidden" } } }, "inventory": { "title": "Inventory", "type": "string", "format": "dynamic", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "fk_autocomplete", "PLAYBOOK": "fk_autocomplete", "TEMPLATE": "hidden" } } }, "save_result": { "title": "Save result", "type": "boolean" }, "template": { "title": "Template", "type": "integer", "x-nullable": true }, "template_opt": { "title": "Template opt", "type": "string", "format": "dynamic", "additionalProperties": { "choices": {}, "field": "kind", "types": { "MODULE": "hidden", "PLAYBOOK": "hidden", "TEMPLATE": "autocomplete" } }, "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", "additionalProperties": { "choices": {}, "field": "type", "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 } }
Template 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" }, "data": {}, "options": {}, "options_list": { "type": "array", "items": { "type": "string" }, "readOnly": true } }
OneTemplate Schema¶
{ "id": { "title": "Id", "type": "integer", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 512, "minLength": 1 }, "notes": { "title": "Notes", "type": "string", "format": "textarea" }, "kind": { "title": "Type", "type": "string", "enum": [ "Task", "Module" ], "default": "Task" }, "data": {}, "options": {}, "options_list": { "type": "array", "items": { "type": "string" }, "readOnly": true } }
TemplateExec Schema¶
{ "option": { "title": "Option", "description": "Option name from template options.", "type": "string", "minLength": 0 } }
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", "additionalProperties": { "choices": { "repo_sync_on_run": [ true, false ], "repo_type": [ "MANUAL", "GIT", "TAR" ] }, "field": "key", "types": { "ci_template": "fk", "repo_key": "secretfile", "repo_password": "password", "repo_sync_on_run_timeout": "uptime" } } } }
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": 30 }, "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": 30 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email", "type": "string", "format": "email", "minLength": 1 } }
ChangePassword Schema¶
{ "old_password": { "title": "Old password", "type": "string", "minLength": 1 }, "password": { "title": "New password", "type": "string", "minLength": 1 }, "password2": { "title": "Confirm new password", "type": "string", "minLength": 1 } }
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" ], "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": {} }