Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
HTTP request
POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*/executions/*}:cancel
[[["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-08-22 UTC."],[[["\u003cp\u003eThis endpoint facilitates the cancellation of an execution and its associated sub-executions, excluding those that are IN_PROCESS or already completed (SUCCESSFUL, FAILED, or CANCELLED).\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to cancel an execution is a \u003ccode\u003ePOST\u003c/code\u003e request to a specified URL with a \u003ccode\u003ename\u003c/code\u003e path parameter, which requires a string to identify the execution resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003ecancelReason\u003c/code\u003e string field to provide the reason for the cancellation.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, the response body will contain a \u003ccode\u003eisCanceled\u003c/code\u003e boolean field, set to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eCancelling an execution requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003eintegrations.executions.cancel\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.integrations.executions.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CancelExecutionResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nCancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.\n\n### HTTP request\n\n`POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*/executions/*}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nResponse for cancelling an execution.\n\nIf successful, the response body contains data with the following structure:\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](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `integrations.executions.cancel`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
