Method: projects.sites.customDomains.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the specified CustomDomain.
HTTP request
PATCH https://firebasehosting.googleapis.com/v1beta1/{customDomain.name=projects/*/sites/*/customDomains/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customDomain.name |
string
Output only. The fully-qualified name of the CustomDomain.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
The set of field names from your CustomDomain that you want to update. A field will be overwritten if, and only if, it's in the mask. If you don't provide a mask, Hosting updates the entire CustomDomain. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
allowMissing |
boolean
If true, Hosting creates the CustomDomain if it doesn't already exist.
|
validateOnly |
boolean
If true, Hosting validates that it's possible to complete your request but doesn't actually create or update the CustomDomain.
|
Request body
The request body contains an instance of CustomDomain.
Response body
If successful, the response body contains an instance of Operation.
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,["Updates the specified `CustomDomain`.\n\nHTTP request\n\n`PATCH https://firebasehosting.googleapis.com/v1beta1/{customDomain.name=projects/*/sites/*/customDomains/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\nQuery parameters\n\nRequest body\n\nThe request body contains an instance of [CustomDomain](/docs/reference/hosting/rest/v1beta1/projects.sites.customDomains#CustomDomain).\n\nResponse body\n\nIf successful, the response body contains an instance of [Operation](/docs/reference/hosting/rest/v1beta1/projects.operations#Operation).\n\nAuthorization 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/)."]]
