2026-03-27
▼ ▲ config.projects.locations.deploymentGroups.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the deployment group to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a DeploymentGroup for a given project and location.
▼ ▲ config.projects.locations.deploymentGroups.create
Path : v1/{+parent}/deploymentGroups
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups
HTTP Method : POST
Parameters :
parent
Description : Required. The parent in whose context the Deployment Group is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
deploymentGroupId
Description : Required. The deployment group ID.
Location : query
Type : string
requestId
Description : 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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a DeploymentGroup The newly created DeploymentGroup will be in the `CREATING` state and can be retrieved via Get and List calls.
▼ ▲ config.projects.locations.deploymentGroups.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a DeploymentGroup
▼ ▲ config.projects.locations.deploymentGroups.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of DeploymentGroup in the format projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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 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).
Location : query
Type : string
force
Description : Optional. If set to true, any revisions for this deployment group will also be deleted. (Otherwise, the request will only work if the deployment group has no revisions.)
Location : query
Type : boolean
deploymentReferencePolicy
Description : Optional. Policy on how to handle referenced deployments when deleting the DeploymentGroup. If unspecified, the default behavior is to fail the deletion if any deployments currently referenced in the `deployment_units` of the DeploymentGroup or in the latest revision are not deleted.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a DeploymentGroup
▼ ▲ config.projects.locations.deploymentGroups.list
Path : v1/{+parent}/deploymentGroups
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of deployment groups. Format: 'projects/{project_id}/locations/{location}'.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.
Location : query
Type : string
filter
Description : Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deploymentGroups/bar" - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - DeploymentGroups in CREATING state. state=CREATING
Location : query
Type : string
orderBy
Description : Optional. Field to use to sort the list.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List DeploymentGroups for a given project and location.
▼ ▲ config.projects.locations.deploymentGroups.provision
Path : v1/{+name}:provision
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}:provision
HTTP Method : POST
Parameters :
name
Description : Required. The name of the deployment group to provision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Provisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* DeploymentGroup definition (e.g., following an `UpdateDeploymentGroup` call), along with their actuated resources.
▼ ▲ config.projects.locations.deploymentGroups.deprovision
Path : v1/{+name}:deprovision
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}:deprovision
HTTP Method : POST
Parameters :
name
Description : Required. The name of the deployment group to deprovision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deprovisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* DeploymentGroup definition (e.g., following an `UpdateDeploymentGroup` call), along with their actuated resources.
▼ ▲ config.projects.locations.deploymentGroups.revisions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}/revisions/{revisionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the deployment group revision to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+/revisions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details about a DeploymentGroupRevision.
▼ ▲ config.projects.locations.deploymentGroups.revisions.list
Path : v1/{+parent}/revisions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}/revisions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of deployment group revisions. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, a sensible default will be used by the server. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Token returned by previous call to 'ListDeploymentGroupRevisions' which specifies the position in the list from where to continue listing the deployment group revisions. All other parameters provided to `ListDeploymentGroupRevisions` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists DeploymentGroupRevisions in a given DeploymentGroup.