Method: deployments.groups.disable
Stay organized with collections
Save and categorize content based on your preferences.
Disables the defined groups. Returns NOT_FOUND if the matching path does not exist.
HTTP request
POST https://androidovertheair.googleapis.com/v1/{name=deployments/*}/groups:disable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Relative resource name. For example: "deployments/deployment_x/groups"
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"groupNames": [
string
]
} |
| Fields |
groupNames[] |
string
Required. The groups that should be disabled.
|
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/android_partner_over_the_air
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eDisables defined groups within Android over-the-air deployments, returning a \u003ccode\u003eNOT_FOUND\u003c/code\u003e error if the path doesn't exist.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the relative resource name ("deployments/deployment_x/groups") as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a JSON object with a \u003ccode\u003egroupNames\u003c/code\u003e array listing the groups to disable.\u003c/p\u003e\n"],["\u003cp\u003eA successful operation results in an empty response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/android_partner_over_the_air\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details how to disable groups within a deployment using an HTTP POST request. The request is sent to a specific URL using gRPC Transcoding, defined by a resource `name` path parameter (e.g., \"deployments/deployment_x/groups\"). The request body, in JSON format, contains a `groupNames` array listing groups to disable. Successful requests return an empty response, while invalid paths result in a `NOT_FOUND` error. Authorization requires the specified OAuth scope.\n"],null,["# Method: deployments.groups.disable\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDisables the defined [groups](/android/over-the-air/reference/rest/v1/deployments.groups#Group). Returns `NOT_FOUND` if the matching path does not exist.\n\n### HTTP request\n\n`POST https://androidovertheair.googleapis.com/v1/{name=deployments/*}/groups:disable`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------|\n| `name` | `string` Relative resource name. For example: \"deployments/deployment_x/groups\" |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------|\n| ``` { \"groupNames\": [ string ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------|\n| `groupNames[]` | `string` Required. The groups that should be disabled. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/android_partner_over_the_air`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]