Method: sites.versions.patch

Updates the specified metadata for the specified version.

This method will fail withFAILED_PRECONDITION in the event of an invalid state transition. The supportedstate transitions for a version are fromCREATED toFINALIZED.

Useversions.delete to set the status of a version toDELETED.

HTTP request

PATCH https://firebasehosting.googleapis.com/v1beta1/{version.name=sites/*/versions/*}

The URL usesgRPC 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 callversions.create.

Query parameters

Parameters
updateMask

string (FieldMask format)

A set of field names from yourversion 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 onlystatus 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 ofVersion.

Response body

If successful, the response body contains an instance ofVersion.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-09-11 UTC.