Method: projects.locations.environments.saveSnapshot

Creates a snapshots of a Cloud Composer environment.

As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.

HTTP request

POST https://composer.googleapis.com/v1/{environment=projects/*/locations/*/environments/*}:saveSnapshot

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
environment

string

The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Authorization requires the following IAM permission on the specified resource environment:

  • composer.environments.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "snapshotLocation": string
}
Fields
snapshotLocation

string

Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots".

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.