Method: sites.versions.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the specified metadata for the specified version.
This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED.
Use versions.delete to set the status of a version to DELETED.
HTTP request
PATCH https://firebasehosting.googleapis.com/v1beta1/{version.name=sites/*/versions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
version.name |
string
The fully-qualified resource name for the version, in the format:
sites/SITE_ID/versions/VERSION_ID
This name is provided in the response body when you call versions.create.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
A set of field names from your version that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only status will be used. This is a comma-separated list of fully qualified names of fields. Example: "config,status".
|
Request body
The request body contains an instance of Version.
Response body
If successful, the response body contains an instance of Version.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/firebase.hosting
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication 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 2023-09-11 UTC.
[null,null,["Last updated 2023-09-11 UTC."],[],[],null,["# Method: sites.versions.patch\n\nUpdates the specified metadata for the specified version.\n\nThis method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The supported [state](../sites.versions#versionstatus) transitions for a version are from `CREATED` to `FINALIZED`.\n\nUse [`versions.delete`](/docs/reference/hosting/rest/v1beta1/sites.versions/delete) to set the status of a version to `DELETED`.\n\n### HTTP request\n\n`PATCH https://firebasehosting.googleapis.com/v1beta1/{version.name=sites/*/versions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `version.name` | `string` The fully-qualified resource name for the version, in the format: `sites/`\u003cvar translate=\"no\"\u003eSITE_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION_ID\u003c/var\u003e This name is provided in the response body when you call [`versions.create`](/docs/reference/hosting/rest/v1beta1/sites.versions/sites.versions/create). |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used. This is a comma-separated list of fully qualified names of fields. Example: `\"config,status\"`. |\n\n### Request body\n\nThe request body contains an instance of [Version](/docs/reference/hosting/rest/v1beta1/sites.versions#Version).\n\n### Response body\n\nIf successful, the response body contains an instance of [Version](/docs/reference/hosting/rest/v1beta1/sites.versions#Version).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/firebase.hosting`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
