Method: projects.sites.customDomains.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists each CustomDomain associated with the specified parent Hosting site.
Returns CustomDomains in a consistent, but undefined, order to facilitate pagination.
HTTP request
GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The Firebase Hosting Site with CustomDomain entities you'd like to list.
|
Query parameters
| Parameters |
pageSize |
integer
The max number of CustomDomain entities to return in a request. Defaults to 10.
|
pageToken |
string
A token from a previous call to customDomains.list that tells the server where to resume listing.
|
showDeleted |
boolean
If true, the request returns soft-deleted CustomDomains that haven't been fully-deleted yet. To restore deleted CustomDomains, make an customDomains.undelete request.
|
Request body
The request body must be empty.
Response body
The response from customDomains.list.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"customDomains": [
{
object (CustomDomain)
}
],
"nextPageToken": string
} |
| Fields |
customDomains[] |
object (CustomDomain)
A list of CustomDomain entities associated with the specified Firebase Site.
|
nextPageToken |
string
The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to customDomains.list. Page tokens are short-lived and should not be stored.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/firebase.hosting.readonly
https://www.googleapis.com/auth/firebase.hosting
https://www.googleapis.com/auth/firebase.readonly
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/cloud-platform.read-only
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,["Lists each `CustomDomain` associated with the specified parent Hosting site.\n\nReturns `CustomDomain`s in a consistent, but undefined, order to facilitate pagination.\n\nHTTP request\n\n`GET https://firebasehosting.googleapis.com/v1beta1/{parent=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 must be empty.\n\nResponse body The response from `customDomains.list`.\n\nIf successful, the response body contains data with the following structure:\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/firebase.hosting.readonly`\n- `\n https://www.googleapis.com/auth/firebase.hosting`\n- `\n https://www.googleapis.com/auth/firebase.readonly`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
