[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-30 UTC."],[[["\u003cp\u003eThis endpoint permanently freezes pipeline execution and changes the pipeline state to "ARCHIVED," while retaining pipeline metadata.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003ePOST\u003c/code\u003e method to the specified URL format, requiring a pipeline name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty, and on success, the response will include a \u003ccode\u003ePipeline\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eTo authorize the request, you need the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003edatapipelines.pipelines.stop\u003c/code\u003e IAM permission on the pipeline resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.pipelines.stop\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nFreezes pipeline execution permanently.\n\nIf there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to \"ARCHIVED\". However, pipeline metadata is retained.\n\n### HTTP request\n\n`POST https://datapipelines.googleapis.com/v1/{name=projects/*/locations/*/pipelines/*}:stop`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Pipeline](/dataflow/docs/reference/data-pipelines/rest/v1/projects.locations.pipelines#Pipeline).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `datapipelines.pipelines.stop`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
