Sign in

v1

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

Creates a Deployment.

post/v1/{+parent}/deployments

Path parameters

parentstring required

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

Query parameters

deploymentIdstring

Required. The Deployment ID.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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).

Request body

namestring

Identifier. Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

createTimestring google-datetime

Output only. Time when the deployment was created.

updateTimestring google-datetime

Output only. Time when the deployment was last modified.

labelsobject

Optional. User-defined metadata for the deployment.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'FAILED' | 'SUSPENDED' | 'DELETED'

Output only. Current state of the deployment.

latestRevisionstring

Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}

stateDetailstring

Output only. Additional information regarding the current state.

errorCode'ERROR_CODE_UNSPECIFIED' | 'REVISION_FAILED' | 'CLOUD_BUILD_PERMISSION_DENIED' | 'DELETE_BUILD_API_FAILED' | 'DELETE_BUILD_RUN_FAILED' | 'BUCKET_CREATION_PERMISSION_DENIED' | 'BUCKET_CREATION_FAILED' | 'EXTERNAL_VALUE_SOURCE_IMPORT_FAILED'

Output only. Error code describing errors that may have occurred.

deleteBuildstring

Output only. Cloud Build instance UUID associated with deleting this deployment.

deleteLogsstring

Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.

errorLogsstring

Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.

artifactsGcsBucketstring

User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: gs://{bucket}/{folder} A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: gs://--blueprint-config Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of gcs_source - The field cannot be updated, including changing its presence

serviceAccountstring

Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

importExistingResourcesboolean

By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.

workerPoolstring

The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.

lockState'LOCK_STATE_UNSPECIFIED' | 'LOCKED' | 'UNLOCKED' | 'LOCKING' | 'UNLOCKING' | 'LOCK_FAILED' | 'UNLOCK_FAILED'

Output only. Current lock state of the deployment.

tfVersionConstraintstring

The user-specified Terraform version constraint. Example: "=1.3.10".

tfVersionstring

Output only. The current Terraform version set on the deployment. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

quotaValidation'QUOTA_VALIDATION_UNSPECIFIED' | 'ENABLED' | 'ENFORCED'

Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

annotationsobject

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

Response

Successful response