mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 10:00:01 -03:30
9358d59f20
fix the api-lint fix the api-lint add the descrition to the bulk job launch module params add the description for the description field add the description for the description field add docs for the bulk api fix the models on the bulk api serializers fix some of the issues highlighted in the code review better use of role model remove comments better error message revert the PrimaryKeyRelatedField for unified_job_template and inventory
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# Bulk API Overview
|
|
|
|
Bulk API endpoints allows to perform bulk operations in single web request. There are currently following bulk api actions:
|
|
- /api/v2/bulk/job_launch
|
|
- /api/v2/bulk/host_create
|
|
|
|
## Bulk Job Launch
|
|
|
|
Provides feature in the API that allows a single web request to achieve multiple job launches. It creates a workflow job with individual jobs as nodes within the workflow job. It also supports providing promptable fields like inventory, credential etc.
|
|
|
|
Following is an example of a post request at the /api/v2/bulk/job_launch
|
|
|
|
```commandline
|
|
{
|
|
"name": "Bulk Job Launch",
|
|
"jobs": [
|
|
{"unified_job_template": 7, "identifier":"foo", "limit": "kansas", "credentials": [1]},
|
|
{"unified_job_template": 8, "identifier":"bar", "inventory": 1, "execution_environment": 3},
|
|
{"unified_job_template": 9}
|
|
]
|
|
}
|
|
```
|
|
|
|
The above will launch a workflow job with 3 nodes in it.
|
|
|
|
## Bulk Host Create
|
|
|
|
Provides feature in the API that allows a single web request to create multiple hosts in an inventory.
|
|
|
|
Following is an example of a post request at the /api/v2/bulk/host_create:
|
|
|
|
```commandline
|
|
{
|
|
"inventory": 1,
|
|
"hosts": [{"name": "host1", "variables": "ansible_connection: local"}, {"name": "host2"}, {"name": "host3"}, {"name": "host4"}, {"name": "host5"}, {"name": "host6"}]
|
|
}
|
|
```
|
|
|
|
The above will add 6 hosts in the inventory. |