Method: projects.locations.backends.patch

Updates the information for a single backend.

HTTP request

PATCH https://firebaseapphosting.googleapis.com/v1/{backend.name=projects/*/locations/*/backends/*}

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
backend.name

string

Identifier. The resource name of the backend.

Format:

projects/{project}/locations/{locationId}/backends/{backendId}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly

boolean

Optional. Indicates that the request should be validated, without persisting the request or updating any resources.
allowMissing

boolean

Optional. If set to true, and the backend is not found, a new backend will be created.

Request body

The request body contains an instance of Backend.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • firebaseapphosting.backends.update

For more information, see the IAM documentation.

See also Firebase App Hosting's IAM Permissions and Predefined IAM Roles.