2015-08-25 21:42:46 -04:00
|
|
|
# Builds API
|
|
|
|
|
|
2016-02-29 06:00:42 -05:00
|
|
|
API used by runners to receive and update builds.
|
2015-08-25 21:42:46 -04:00
|
|
|
|
2016-02-29 06:00:42 -05:00
|
|
|
_**Note:** This API is intended to be used only by Runners as their own
|
|
|
|
|
communication channel. For the consumer API see the
|
|
|
|
|
[Builds API](../../api/builds.md)._
|
|
|
|
|
|
|
|
|
|
## Authentication
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
This API uses two types of authentication:
|
2016-02-29 06:00:42 -05:00
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
1. Unique runner's token
|
|
|
|
|
|
|
|
|
|
Token assigned to runner after it has been registered.
|
|
|
|
|
|
|
|
|
|
2. Using build authorization token
|
|
|
|
|
|
|
|
|
|
This is project's CI token that can be found in Continuous Integration
|
|
|
|
|
project settings.
|
|
|
|
|
|
|
|
|
|
Build authorization token can be passed as a parameter or a value of
|
|
|
|
|
`BUILD-TOKEN` header. This method are interchangeable.
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
|
## Builds
|
|
|
|
|
|
|
|
|
|
### Runs oldest pending build by runner
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
POST /ci/api/v1/builds/register
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
* `token` (required) - Unique runner token
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### Update details of an existing build
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
PUT /ci/api/v1/builds/:id
|
2015-08-25 21:42:46 -04:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
|
|
* `id` (required) - The ID of a project
|
2016-03-01 04:57:12 -05:00
|
|
|
* `token` (required) - Unique runner token
|
2015-08-25 21:42:46 -04:00
|
|
|
* `state` (optional) - The state of a build
|
|
|
|
|
* `trace` (optional) - The trace of a build
|
2016-02-29 06:00:42 -05:00
|
|
|
|
|
|
|
|
### Upload artifacts to build
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
POST /ci/api/v1/builds/:id/artifacts
|
2016-02-29 06:00:42 -05:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
|
|
* `id` (required) - The ID of a build
|
|
|
|
|
* `token` (required) - The build authorization token
|
|
|
|
|
* `file` (required) - Artifacts file
|
|
|
|
|
|
|
|
|
|
### Download the artifacts file from build
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
GET /ci/api/v1/builds/:id/artifacts
|
2016-02-29 06:00:42 -05:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
|
|
* `id` (required) - The ID of a build
|
|
|
|
|
* `token` (required) - The build authorization token
|
|
|
|
|
|
|
|
|
|
### Remove the artifacts file from build
|
|
|
|
|
|
2016-03-01 04:57:12 -05:00
|
|
|
DELETE /ci/api/v1/builds/:id/artifacts
|
2016-02-29 06:00:42 -05:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
|
|
* ` id` (required) - The ID of a build
|
|
|
|
|
* `token` (required) - The build authorization token
|
