--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade `POST /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade` ## Request - Base URL: `https://composer.googleapis.com` - URL: `https://composer.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloudcomposer` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloudcomposer` - TypeScript: (a function with typed inputs; its response is checked against the schema) Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `environmentsId` string, required ## Request body - CheckUpgradeRequest: Request to check whether image upgrade will succeed. - `imageVersion` string: Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview). ## Response `200` Successful response - Operation: This resource represents a long-running operation that is the result of a network API call. - `done` boolean: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - `error` Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `metadata` object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - `name` string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - `response` object: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. ## Changes - **2026-11-07** `9c23b974ddbb`: 4 info - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloudcomposer` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloudcomposer` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/composer/changes/v1/projects/:projectsId/locations/:locationsId/environments/:environmentsId:checkUpgrade/post.md) --- [API](https://skmtc.dev/google/apis/composer.md) - [All operations](https://skmtc.dev/google/apis/composer/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/composer/revisions/9c23b974ddbb?raw)