Method: deployments.configs.disable
Stay organized with collections
Save and categorize content based on your preferences.
Disables all enabled groups that have the specified config. Returns NOT_FOUND if the matching path does not exist.
HTTP request
POST https://androidovertheair.googleapis.com/v1/{name=deployments/*/configs/*}:disable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Relative resource name. For example: "deployments/deployment_x/configs/config_c"
|
Request body
The request body must be empty.
Response body
Response message for OverTheAirService.DisableAllEnabledGroupsOfConfig.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"groupNames": [
string
]
} |
| Fields |
groupNames[] |
string
The list of group names that are associated with the specified config and have been disabled in this request processing.
|
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 all enabled groups associated with a specific Android over-the-air deployment configuration.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP POST request to the specified endpoint with the configuration's resource name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns a list of disabled group names in the response.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/android_partner_over_the_air\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["The core actions involve disabling all enabled groups associated with a specific configuration. This is achieved via a `POST` request to a URL with a defined resource `name` path parameter. The request body is empty. Upon success, the response contains a JSON array of `groupNames` that were disabled. This action requires specific OAuth authorization scope: `https://www.googleapis.com/auth/android_partner_over_the_air`. The request utilizes gRPC Transcoding and will result in a `NOT_FOUND` error if the path is incorrect.\n"],null,["# Method: deployments.configs.disable\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.DisableAllEnabledGroupsOfConfigResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDisables all enabled groups that have the specified config. Returns `NOT_FOUND` if the matching path does not exist.\n\n### HTTP request\n\n`POST https://androidovertheair.googleapis.com/v1/{name=deployments/*/configs/*}: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/configs/config_c\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for OverTheAirService.DisableAllEnabledGroupsOfConfig.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------|\n| ``` { \"groupNames\": [ string ] } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `groupNames[]` | `string` The list of group names that are associated with the specified config and have been disabled in this request processing. |\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)."]]