Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-04193459793.6 KB
RolloutService

Pause a rollout

Requests a running or stabilizing rollout to pause and records an optional reason. The response returns the PAUSING snapshot; poll GetRollout until state is PAUSED to confirm the executor has parked.

post/projects/{projectId}/endpoints/{endpointId}/rollouts/{id}/pause

Path parameters

projectIdstring required

Project identifier.

endpointIdstring required

Endpoint identifier.

idstring required

Rollout identifier.

Request body

etagstring

Optional etag for optimistic concurrency.

reasonstring

Optional human-readable reason recorded on the rollout pause metadata.

Response

OK

idstring required

Output only. Unique rollout identifier.

endpointIdstring required

Output only. Endpoint this rollout belongs to.

sourceDeploymentIdstring required

Output only. Deployment that traffic is shifting away from.

targetDeploymentIdstring required

Output only. Deployment that traffic is shifting toward.

strategy'ROLLOUT_STRATEGY_TYPE_ROLLING' | 'ROLLOUT_STRATEGY_TYPE_CANARY' | 'ROLLOUT_STRATEGY_TYPE_BLUE_GREEN' required

Output only. Rollout strategy selected at creation.

state'ROLLOUT_STATE_RUNNING' | 'ROLLOUT_STATE_PAUSED' | 'ROLLOUT_STATE_STABILIZING' | 'ROLLOUT_STATE_ABORTING' | 'ROLLOUT_STATE_COMPLETED' | 'ROLLOUT_STATE_ABORTED' | 'ROLLOUT_STATE_PENDING' | 'ROLLOUT_STATE_SYSTEM_PAUSED' | 'ROLLOUT_STATE_CANCELLING' | 'ROLLOUT_STATE_CANCELED' | 'ROLLOUT_STATE_PAUSING' required

Output only. High-level rollout lifecycle state.

currentStepinteger

Output only. Zero-based index of the current step. Unset while PENDING; step 0 is reported explicitly after start.

currentTrafficPercentinteger

Output only. Applied percentage of traffic on the target deployment.

createdAtstring date-time required

Output only. Timestamp when the rollout was created.

startedAtstring date-time

Output only. Timestamp when the rollout started running.

completedAtstring date-time

Output only. Timestamp when the rollout reached a terminal state.

etagstring

Output only. Opaque version tag for optimistic concurrency control.