Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131843102.5 KB
deployments

Updates a deployment and all of the resources described by the deployment manifest.

put/deploymentmanager/v2/projects/{project}/global/deployments/{deployment}

Path parameters

projectstring required

The project ID for this request.

deploymentstring required

The name of the deployment for this request.

Query parameters

createPolicy'CREATE_OR_ACQUIRE' | 'ACQUIRE'

Sets the policy to use for creating new resources.

deletePolicy'DELETE' | 'ABANDON'

Sets the policy to use for deleting resources.

header.bypassBillingFilterboolean
previewboolean

If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Request body

idstring uint64
namestring

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

descriptionstring

An optional user-provided description of the deployment.

fingerprintstring byte

Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.

manifeststring

Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

insertTimestring

Output only. Creation timestamp in RFC3339 text format.

updateTimestring

Output only. Update timestamp in RFC3339 text format.

selfLinkstring

Output only. Server defined URL for the resource.

Response

Successful response