Method: deployments.configs.update
Stay organized with collections
Save and categorize content based on your preferences.
Updates a config. Returns INVALID_ARGUMENT if the name of the config is non-empty and does not equal the existing name.
HTTP request
PUT https://androidovertheair.googleapis.com/v1/{name=deployments/*/configs/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Relative resource name. For example: "deployments/deployment_x/configs/config_a"
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"config": {
object (Config)
},
"versionTag": {
object (VersionTag)
}
} |
| Fields |
config |
object (Config)
The Config to update.
|
versionTag |
object (VersionTag)
Required. The config to be updated should match this version. If another client updates the existing config concurrently, the update operation will fail.
|
Response body
If successful, the response body contains an instance of Config.
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\u003eThis documentation outlines how to update a device configuration using the Android Over-the-Air (OTA) service via a PUT request.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify the target configuration using a structured path parameter in the request URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a JSON payload containing the updated configuration data and a version tag for concurrency control.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return the updated configuration, and you will need the \u003ccode\u003eandroid_partner_over_the_air\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document outlines the process to update a configuration (`Config`). It uses a `PUT` request to a specific URL with a resource name in the path. The request body, in JSON format, includes the `Config` object to update and a `VersionTag` for concurrency control. Successful updates return a `Config` instance. An `INVALID_ARGUMENT` error occurs if the config name is non-empty and different from the existing name. Authorization requires the `android_partner_over_the_air` OAuth scope.\n"],null,["# Method: deployments.configs.update\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\nUpdates a [config](/android/over-the-air/reference/rest/v1/deployments.configs#Config). Returns `INVALID_ARGUMENT` if the name of the config is non-empty and does not equal the existing name.\n\n### HTTP request\n\n`PUT https://androidovertheair.googleapis.com/v1/{name=deployments/*/configs/*}`\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_a\" |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"config\": { object (/android/over-the-air/reference/rest/v1/deployments.configs#Config) }, \"versionTag\": { object (/android/over-the-air/reference/rest/v1/VersionTag) } } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `config` | `object (`[Config](/android/over-the-air/reference/rest/v1/deployments.configs#Config)`)` The [Config](/android/over-the-air/reference/rest/v1/deployments.configs#Config) to update. |\n| `versionTag` | `object (`[VersionTag](/android/over-the-air/reference/rest/v1/VersionTag)`)` Required. The config to be updated should match this version. If another client updates the existing config concurrently, the update operation will fail. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Config](/android/over-the-air/reference/rest/v1/deployments.configs#Config).\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)."]]