Stay organized with collections
Save and categorize content based on your preferences.
This page is intended for customers who are currently using the V2 Beta version
of the Cloud Support API and would like to migrate to V2.
Getting started with V2
If you're already using V2 Beta, then you don't need to do any additional setup
to start using V2. You can use the same service accounts and credentials. The API will already be enabled for you.
To call the V2 endpoints, simply replace the /v2beta/ portion of the
request URL to /v2/. For example, here's how you would upgrade a
cases.get call from V2 Beta to V2:
V2 Beta:
GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc
V2:
GET https://cloudsupport.googleapis.com/v2/projects/123/cases/abc
Breaking changes to SearchCases, Case.severity, and Comment.plainTextBody
SearchCases Endpoint Changes
The SearchCases endpoint has changed in the following ways:
The path has changed from:
GET https://cloudsupport.googleapis.com/v2/cases:search
to:
GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search
The filter parameter no longer accepts a project or organization filter. Instead, the project/organization
from the URL will be used as the scope of the search.
Field Changes
The fields have changed in the following ways:
The severity field on cases has been removed in favor of the priority field.
The plainTextBody field on case comments has been removed in favor of the body field.
Why did we make these changes?
Changing the SearchCases path
The old way of defining the search scope was confusing and not in-line with standard Google Cloud Platform API design practices.
The new way makes SearchCases more consistent with other endpoints in the API, such as ListCases.
Removing the Case.severity field
Severity serves the same purpose as priority, so removing it simplifies the API.
Removing the Comment.plainTextBody field
Comment.body only ever contains plain text, so it's a duplicate of this field, so we are removing plainTextBody to simplify the API.
How to adapt to the changes
Remove the project and organization filters from SearchCase requests and declare them in the request URL instead.
Use the priority field in the places where you used to use the severity field. They're very similar in semantic meaning, so you can usually swap out these references.
Use the body field instead of the plainTextBody field. They contained the same information. So, odds are, it should be fine to replace all references to plainTextBody with body.
[[["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-09-04 UTC."],[],[],null,["# Migrating from V2 Beta\n\nThis page is intended for customers who are currently using the V2 Beta version\nof the Cloud Support API and would like to migrate to V2.\n\nGetting started with V2\n-----------------------\n\nIf you're already using V2 Beta, then you don't need to do any additional setup\nto start using V2. You can use the same service accounts and credentials. The API will already be enabled for you.\n\nTo call the V2 endpoints, simply replace the `/v2beta/` portion of the\nrequest URL to `/v2/`. For example, here's how you would upgrade a\n`cases.get` call from V2 Beta to V2:\n\nV2 Beta:\n`GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc`\n\nV2:\n`GET https://cloudsupport.googleapis.com/v2/projects/123/cases/abc`\n\nBreaking changes to `SearchCases`, `Case.severity`, and `Comment.plainTextBody`\n-------------------------------------------------------------------------------\n\n| **Important:** These are the only breaking changes between V2 Beta and V2. Any fields/endpoints that are not mentioned in this section are exactly the same. If you don't currently use the `SearchCases` endpoint, `Case.severity` field, or the `Comment.plainTextBody` field, you can safely migrate to V2 without any changes to your business logic or request-response format.\n\n### `SearchCases` Endpoint Changes\n\nThe `SearchCases` endpoint has changed in the following ways:\n\n- The path has changed from:\n\n `GET https://cloudsupport.googleapis.com/v2/cases:search`\n\n to:\n\n `GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search`\n- The `filter` parameter no longer accepts a `project` or `organization` filter. Instead, the project/organization\n from the URL will be used as the scope of the search.\n\n### Field Changes\n\nThe fields have changed in the following ways:\n\n- The `severity` field on [cases](/support/docs/reference/rest/v2beta/cases) has been removed in favor of the `priority` field.\n\n- The `plainTextBody` field on [case comments](/support/docs/reference/rest/v2beta/cases.comments) has been removed in favor of the `body` field.\n\nWhy did we make these changes?\n------------------------------\n\n- Changing the `SearchCases` path\n\n - The old way of defining the search scope was confusing and not in-line with standard Google Cloud Platform API design practices.\n - The new way makes `SearchCases` more consistent with other endpoints in the API, such as `ListCases`.\n- Removing the `Case.severity` field\n\n - Severity serves the same purpose as priority, so removing it simplifies the API.\n- Removing the `Comment.plainTextBody` field\n\n - `Comment.body` only ever contains plain text, so it's a duplicate of this field, so we are removing `plainTextBody` to simplify the API.\n\nHow to adapt to the changes\n---------------------------\n\n- Remove the `project` and `organization` filters from `SearchCase` requests and declare them in the request URL instead.\n\n- Use the `priority` field in the places where you used to use the `severity` field. They're very similar in semantic meaning, so you can usually swap out these references.\n\n- Use the `body` field instead of the `plainTextBody` field. They contained the same information. So, odds are, it should be fine to replace all references to `plainTextBody` with `body`."]]
