Jef Roosens
ab81eebd87
All checks were successful
ci/woodpecker/pr/docs Pipeline was successful
ci/woodpecker/pr/lint Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/man Pipeline was successful
ci/woodpecker/pr/docker Pipeline was successful
ci/woodpecker/pr/test Pipeline was successful
78 lines
1.4 KiB
Markdown
78 lines
1.4 KiB
Markdown
# Jobs
|
|
|
|
<aside class="notice">
|
|
|
|
All routes in this section require authentication.
|
|
|
|
</aside>
|
|
|
|
## Manually schedule a job
|
|
|
|
```shell
|
|
curl \
|
|
-H 'X-Api-Key: secret' \
|
|
https://example.com/api/v1/jobs/queue?target=10&force&arch=x86_64
|
|
```
|
|
|
|
Manually schedule a job on the server.
|
|
|
|
### HTTP Request
|
|
|
|
`POST /api/v1/jobs/queue`
|
|
|
|
### Query Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
target | Id of target to schedule build for
|
|
arch | Architecture to build on
|
|
force | Whether it's a forced build (true if present)
|
|
|
|
## Poll for new jobs
|
|
|
|
<aside class="warning">
|
|
|
|
This endpoint is used by the agents and should not be used manually. It's just
|
|
here for completeness. Requests to this endpoint modify the build queue,
|
|
meaning manual requests can cause builds to be skipped.
|
|
|
|
</aside>
|
|
|
|
```shell
|
|
curl \
|
|
-H 'X-Api-Key: secret' \
|
|
https://example.com/api/v1/jobs/poll?arch=x86_64&max=2
|
|
```
|
|
|
|
> JSON output format
|
|
|
|
```json
|
|
{
|
|
"message": "",
|
|
"data": [
|
|
{
|
|
"target_id": 1,
|
|
"kind": "git",
|
|
"url": "https://aur.archlinux.org/discord-ptb.git",
|
|
"branch": "master",
|
|
"path": "",
|
|
"repo": "bur",
|
|
"base_image": "archlinux:base-devel",
|
|
"force": true
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Poll the server for new builds.
|
|
|
|
### HTTP Request
|
|
|
|
`GET /api/v1/jobs/poll`
|
|
|
|
### Query Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
arch | For which architecture to receive jobs
|
|
max | How many jobs to receive at most
|