Releases
Immutable project releases and artifacts.
Operations
Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.
List project releases
GET /api/v1/projects/{project}/releases
Operation ID: listReleases
Effect: read
Confirmation: never
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Create a draft project release
POST /api/v1/projects/{project}/releases
Operation ID: createRelease
Effect: write
Confirmation: conditional
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
201 |
The request has succeeded and a new resource has been created as a result. |
Get a project release
GET /api/v1/projects/{project}/releases/{release}
Operation ID: getRelease
Effect: read
Confirmation: never
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
release |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
List or stream release events
GET /api/v1/projects/{project}/releases/{release}/events
Operation ID: listReleaseEvents
Effect: read
Confirmation: never
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
release |
path | Yes | string | |
accept |
header | No | string | |
Last-Event-ID |
header | No | string | |
limit |
query | No | integer | |
pageToken |
query | No | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Finalize and validate a release
POST /api/v1/projects/{project}/releases/{release}/finalize
Operation ID: finalizeRelease
Effect: write
Confirmation: conditional
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
release |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Responses
| Status | Description |
|---|---|
202 |
The request has been accepted for processing, but processing has not yet completed. |
Upload an immutable workspace artifact
PUT /api/v1/projects/{project}/releases/{release}/workspaces/{workspace}/artifact
Operation ID: uploadReleaseArtifact
Effect: idempotent-write
Confirmation: conditional
Required privilege: DEPLOY
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
release |
path | Yes | string | |
workspace |
path | Yes | string | |
Content-Type |
header | Yes | string | |
Content-Digest |
header | Yes | string |
Request body
Content types: application/octet-stream.
Responses
| Status | Description |
|---|---|
201 |
The request has succeeded and a new resource has been created as a result. |
Common error responses
These error responses apply to every operation on this page.
| Status | Description |
|---|---|
400 |
The server could not understand the request due to invalid syntax. |
401 |
Access is unauthorized. |
403 |
Access is forbidden. |
404 |
The server cannot find the requested resource. |
409 |
The request conflicts with the current state of the server. |
412 |
Precondition failed. |
413 |
Client error |
415 |
Client error |
422 |
Client error |
429 |
Client error |
500 |
Server error |
502 |
Server error |
503 |
Service unavailable. |