Required. The parent collection in which the Rollout must be created. The format is projects/{projectId}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
Query parameters
Parameters
rolloutId
string
Required. ID of the Rollout.
requestId
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly
boolean
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
overrideDeployPolicy[]
string
Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
startingPhaseId
string
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-13 UTC."],[[["\u003cp\u003eThis page details how to create a new Rollout within a specified project, location, delivery pipeline, and release using a POST HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the \u003ccode\u003eparent\u003c/code\u003e path parameter, which includes the project ID, location name, pipeline name, and release name.\u003c/p\u003e\n"],["\u003cp\u003eSeveral query parameters are available, such as \u003ccode\u003erolloutId\u003c/code\u003e (required), \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003evalidateOnly\u003c/code\u003e, \u003ccode\u003eoverrideDeployPolicy[]\u003c/code\u003e, and \u003ccode\u003estartingPhaseId\u003c/code\u003e, allowing for customization of the rollout creation process.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include an instance of the \u003ccode\u003eRollout\u003c/code\u003e resource, and upon successful creation, the response will contain an instance of the \u003ccode\u003eOperation\u003c/code\u003e resource.\u003c/p\u003e\n"],["\u003cp\u003eCreating a rollout necessitates the \u003ccode\u003eclouddeploy.rollouts.create\u003c/code\u003e IAM permission on the parent resource and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.deliveryPipelines.releases.rollouts.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nCreates a new Rollout in a given project and location.\n\n### HTTP request\n\n`POST https://clouddeploy.googleapis.com/v1/{parent=projects/*/locations/*/deliveryPipelines/*/releases/*}/rollouts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Rollout](/deploy/docs/api/reference/rest/v1/projects.locations.deliveryPipelines.releases.rollouts#Rollout).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/deploy/docs/api/reference/rest/v1/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `clouddeploy.rollouts.create`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
