2023-06-28
▼ ▲ cloudsupport.caseClassifications.search
Description: Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by `" > "`. For example `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.
Path: v2/caseClassifications:search
HTTP Method: GET
Parameters:
pageToken
Type: string
Location: query
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
query
Type: string
Location: query
Description: An expression written in the Google Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.
pageSize
Format: int32
Type: integer
Location: query
Description: The maximum number of cases fetched with each request.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/caseClassifications:search
▼ ▲ cloudsupport.cases.patch
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}
Path: v2/{+name}
Description: Update the specified case. Only a subset of fields can be updated.
Parameters:
updateMask
Description: A list of attributes of the case object that should be updated as part of this request. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.
Format: google-fieldmask
Location: query
Type: string
name
Required: Yes
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Type: string
Description: The resource name for the case.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
▼ ▲ cloudsupport.cases.create
Description: Create a new case and associate it with the given Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v2/{+parent}/cases
HTTP Method: POST
Parameters:
parent
Location: path
Description: Required. The name of the Google Cloud Resource under which the case should be created.
Required: Yes
Pattern: ^[^/]+/[^/]+$
Type: string
Flat Path: v2/{v2Id}/{v2Id1}/cases
▼ ▲ cloudsupport.cases.list
HTTP Method: GET
Flat Path: v2/{v2Id}/{v2Id1}/cases
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+parent}/cases
Parameter Order: parent
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: The maximum number of cases fetched with each request. Defaults to 10.
pageToken
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
Location: query
parent
Description: Required. The fully qualified name of parent resource to list cases under.
Pattern: ^[^/]+/[^/]+$
Type: string
Location: path
Required: Yes
filter
Description: An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`
Location: query
Type: string
Description: Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.
▼ ▲ cloudsupport.cases.get
Description: Retrieve the specified case.
HTTP Method: GET
Path: v2/{+name}
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The fully qualified name of a case to be retrieved.
Required: Yes
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Type: string
▼ ▲ cloudsupport.cases.escalate
HTTP Method: POST
Parameter Order: name
Parameters:
name
Description: Required. The fully qualified name of the Case resource to be escalated.
Type: string
Required: Yes
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Description: Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.
Path: v2/{+name}:escalate
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}:escalate
▼ ▲ cloudsupport.cases.search
HTTP Method: GET
Flat Path: v2/{v2Id}/{v2Id1}/cases:search
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Search cases using the specified query.
Path: v2/{+parent}/cases:search
Parameters:
pageToken
Location: query
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
query
Description: An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
Type: string
Location: query
parent
Required: Yes
Pattern: ^[^/]+/[^/]+$
Description: The fully qualified name of parent resource to search cases under.
Type: string
Location: path
pageSize
Format: int32
Description: The maximum number of cases fetched with each request. The default page size is 10.
Location: query
Type: integer
▼ ▲ cloudsupport.cases.close
Parameters:
name
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The fully qualified name of the case resource to be closed.
Path: v2/{+name}:close
HTTP Method: POST
Parameter Order: name
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}:close
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Close the specified case.
▼ ▲ cloudsupport.cases.comments.create
HTTP Method: POST
Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}/comments
Path: v2/{+parent}/comments
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Description: Required. The resource name of Case to which this comment should be added.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ cloudsupport.cases.comments.list
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}/comments
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieve all Comments associated with the Case object.
Parameter Order: parent
Path: v2/{+parent}/comments
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Description: Required. The resource name of Case object for which comments should be listed.
pageSize
Location: query
Description: The maximum number of comments fetched with each request. Defaults to 10.
Format: int32
Type: integer
pageToken
Type: string
Location: query
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
HTTP Method: GET
▼ ▲ cloudsupport.cases.attachments.list
HTTP Method: GET
Path: v2/{+parent}/attachments
Description: Retrieve all attachments associated with a support case.
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Location: query
Description: The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.
Type: integer
Format: int32
pageToken
Type: string
Location: query
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
parent
Type: string
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
Description: Required. The resource name of Case object for which attachments should be listed.
Parameter Order: parent
▼ ▲ cloudsupport.media.upload
Supportsmediaupload: Yes
Parameters:
parent
Description: Required. The resource name of the case (or case parent) to which the attachment should be attached.
Type: string
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
Parameter Order: parent
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.
Mediaupload:
Accept: */*
Protocols:
Simple:
Multipart: Yes
Path: /upload/v2/{+parent}/attachments
Path: v2/{+parent}/attachments
▼ ▲ cloudsupport.media.download
HTTP Method: GET
Path: v2/{+name}:download
Parameters:
name
Pattern: ^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$
Location: path
Required: Yes
Type: string
Description: The resource name of the attachment to be downloaded.
Supportsmediadownload: Yes
Description: Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL.
Parameter Order: name
Usemediadownloadservice: Yes
Flat Path: v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments/{attachmentsId}:download