Method: projects.locations.pipelines.stop

Freezes pipeline execution permanently.

If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • datapipelines.pipelines.stop

For more information, see the IAM documentation.