API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. CompositeTypes
  2. Deployments
  3. Manifests
  4. Operations
  5. Resources
  6. TypeProviders
  7. Types

CompositeTypes

For CompositeTypes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
delete DELETE  /project/global/compositeTypes/compositeType Deletes a composite type.
get GET  /project/global/compositeTypes/compositeType Gets information about a specific composite type.
insert POST  /project/global/compositeTypes Creates a composite type.
list GET  /project/global/compositeTypes Lists all composite types for Deployment Manager.
patch PATCH  /project/global/compositeTypes/compositeType Patches a composite type.
update PUT  /project/global/compositeTypes/compositeType Updates a composite type.

Deployments

For Deployments Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
cancelPreview POST  /project/global/deployments/deployment/cancelPreview Cancels and removes the preview currently associated with the deployment.
delete DELETE  /project/global/deployments/deployment Deletes a deployment and all of the resources in the deployment.
get GET  /project/global/deployments/deployment Gets information about a specific deployment.
getIamPolicy GET  /project/global/deployments/resource/getIamPolicy Gets the access control policy for a resource. May be empty if no such policy or resource exists.
insert POST  /project/global/deployments Creates a deployment and all of the resources described by the deployment manifest.
list GET  /project/global/deployments Lists all deployments for a given project.
patch PATCH  /project/global/deployments/deployment Patches a deployment and all of the resources described by the deployment manifest.
setIamPolicy POST  /project/global/deployments/resource/setIamPolicy Sets the access control policy on the specified resource. Replaces any existing policy.
stop POST  /project/global/deployments/deployment/stop Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
testIamPermissions POST  /project/global/deployments/resource/testIamPermissions Returns permissions that a caller has on the specified resource.
update PUT  /project/global/deployments/deployment Updates a deployment and all of the resources described by the deployment manifest.

Manifests

For Manifests Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
get GET  /project/global/deployments/deployment/manifests/manifest Gets information about a specific manifest.
list GET  /project/global/deployments/deployment/manifests Lists all manifests for a given deployment.

Operations

For Operations Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
get GET  /project/global/operations/operation Gets information about a specific operation.
list GET  /project/global/operations Lists all operations for a project.

Resources

For Resources Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
get GET  /project/global/deployments/deployment/resources/resource Gets information about a single resource.
list GET  /project/global/deployments/deployment/resources Lists all resources in a given deployment.

TypeProviders

For TypeProviders Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
delete DELETE  /project/global/typeProviders/typeProvider Deletes a type provider.
get GET  /project/global/typeProviders/typeProvider Gets information about a specific type provider.
getType GET  /project/global/typeProviders/typeProvider/types/type Gets a type info for a type provided by a TypeProvider.
insert POST  /project/global/typeProviders Creates a type provider.
list GET  /project/global/typeProviders Lists all resource type providers for Deployment Manager.
listTypes GET  /project/global/typeProviders/typeProvider/types Lists all the type info for a TypeProvider.
patch PATCH  /project/global/typeProviders/typeProvider Patches a type provider.
update PUT  /project/global/typeProviders/typeProvider Updates a type provider.

Types

For Types Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/deploymentmanager/v2beta/projects, unless otherwise noted
list GET  /project/global/types Lists all resource types for Deployment Manager.