Deployments
Atomic project release deployment.
Operations
Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.
List project deployments
GET /api/v1/projects/{project}/deployments
Operation ID: listDeployments
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
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. |
Deploy a ready project release
POST /api/v1/projects/{project}/deployments
Operation ID: createDeployment
Effect: write
Confirmation: conditional
Required privilege: ACTIVATE_DEPLOYMENT
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 |
|---|---|
202 |
The request has been accepted for processing, but processing has not yet completed. |
Get a project deployment
GET /api/v1/projects/{project}/deployments/{deployment}
Operation ID: getDeployment
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
deployment |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Cancel a deployment before cutover
POST /api/v1/projects/{project}/deployments/{deployment}/cancel
Operation ID: cancelDeployment
Effect: write
Confirmation: conditional
Required privilege: ACTIVATE_DEPLOYMENT
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
deployment |
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. |
List or stream deployment events
GET /api/v1/projects/{project}/deployments/{deployment}/events
Operation ID: listDeploymentEvents
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
deployment |
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. |
Roll back by creating a deployment of the prior release
POST /api/v1/projects/{project}/deployments/{deployment}/rollback
Operation ID: rollbackDeployment
Effect: write
Confirmation: conditional
Required privilege: ACTIVATE_DEPLOYMENT
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
deployment |
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. |
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. |