Method: projects.sites.customDomains.create
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The custom domain's parent, specifically a Firebase Hosting Site.
|
Query parameters
| Parameters |
customDomainId |
string
Required. The ID of the CustomDomain, which is the domain name you'd like to use with Firebase Hosting.
|
validateOnly |
boolean
If true, Hosting validates that it's possible to complete your request but doesn't actually create a new CustomDomain.
|
Request body
The request body contains an instance of CustomDomain.
Response body
If successful, the response body contains a newly created 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-18 UTC.
[null,null,["Last updated 2023-09-18 UTC."],[],[],null,["# Method: projects.sites.customDomains.create\n\nCreates a `CustomDomain`.\n\n### HTTP request\n\n`POST https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The custom domain's parent, specifically a Firebase Hosting `Site`. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `customDomainId` | `string` Required. The ID of the `CustomDomain`, which is the domain name you'd like to use with Firebase Hosting. |\n| `validateOnly` | `boolean` If true, Hosting validates that it's possible to complete your request but doesn't actually create a new `CustomDomain`. |\n\n### Request body\n\nThe request body contains an instance of [CustomDomain](/docs/reference/hosting/rest/v1beta1/projects.sites.customDomains#CustomDomain).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/docs/reference/hosting/rest/v1beta1/projects.operations#Operation).\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/)."]]
