Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1332185209.7 KB
projects

Creates a new Release in a given project and location.

post/v1/{+parent}/releases

Path parameters

parentstring required

Required. The parent collection in which the Release is created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Query parameters

overrideDeployPolicystring[]

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

releaseIdstring

Required. ID of the Release.

requestIdstring

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).

validateOnlyboolean

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Request body

renderStartTimestring google-datetime

Output only. Time at which the render began.

skaffoldConfigPathstring

Optional. Filepath of the Skaffold config inside of the config URI.

etagstring

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

deployParametersobject

Optional. The deploy parameters to use for all targets in this release.

uidstring

Output only. Unique identifier of the Release.

renderEndTimestring google-datetime

Output only. Time at which the render completed.

labelsobject

Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

namestring

Identifier. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}. The release component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

annotationsobject

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

createTimestring google-datetime

Output only. Time at which the Release was created.

skaffoldVersionstring

Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.

targetArtifactsobject

Output only. Map from target ID to the target artifacts created during the render operation.

descriptionstring

Optional. Description of the Release. Max length is 255 characters.

renderState'RENDER_STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'IN_PROGRESS'

Output only. Current state of the render operation.

targetRendersobject

Output only. Map from target ID to details of the render operation for that target.

abandonedboolean

Output only. Indicates whether this is an abandoned release.

skaffoldConfigUristring

Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.

Response

Successful response