2023-09-12
▼ ▲ firebasehosting.projects.sites.customDomains.create
Path: v1beta1/{+parent}/customDomains
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains
HTTP Method: POST
Parameters:
parent
Description: Required. The `CustomDomain`'s parent, specifically a Firebase Hosting `Site`.
Pattern: ^projects/[^/]+/sites/[^/]+$
Location: path
Required: Yes
Type: string
customDomainId
Description: Required. The ID of the `CustomDomain`, which is the domain name you'd like to use with Firebase Hosting.
Location: query
Type: string
validateOnly
Description: If true, Hosting validates that it's possible to complete your request but doesn't actually create a new `CustomDomain`.
Location: query
Type: boolean
Parameter Order: parent
Scopes:
Description: Creates a `CustomDomain`.
▼ ▲ firebasehosting.projects.sites.customDomains.patch
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The fully-qualified name of the `CustomDomain`.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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`.
Location: query
Type: string
Format: google-fieldmask
allowMissing
Description: If true, Hosting creates the `CustomDomain` if it doesn't already exist.
Location: query
Type: boolean
validateOnly
Description: If true, Hosting validates that it's possible to complete your request but doesn't actually create or update the `CustomDomain`.
Location: query
Type: boolean
Parameter Order: name
Scopes:
Description: Updates the specified `CustomDomain`.
▼ ▲ firebasehosting.projects.sites.customDomains.get
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the `CustomDomain` to get.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the specified `CustomDomain`.
▼ ▲ firebasehosting.projects.sites.customDomains.list
Path: v1beta1/{+parent}/customDomains
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains
HTTP Method: GET
Parameters:
parent
Description: Required. The Firebase Hosting `Site` with `CustomDomain` entities you'd like to list.
Pattern: ^projects/[^/]+/sites/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The max number of `CustomDomain` entities to return in a request. Defaults to 10.
Location: query
Type: integer
Format: int32
pageToken
Description: A token from a previous call to `ListCustomDomains` that tells the server where to resume listing.
Location: query
Type: string
showDeleted
Description: If true, the request returns soft-deleted `CustomDomain`s that haven't been fully-deleted yet. To restore deleted `CustomDomain`s, make an `UndeleteCustomDomain` request.
Location: query
Type: boolean
Parameter Order: parent
Scopes:
Description: Lists each `CustomDomain` associated with the specified parent Hosting Site. Returns `CustomDomain`s in a consistent, but undefined, order to facilitate pagination.
▼ ▲ firebasehosting.projects.sites.customDomains.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the `CustomDomain` to delete.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Description: If true, the request succeeds even if the `CustomDomain` doesn't exist.
Location: query
Type: boolean
validateOnly
Description: If true, Hosting validates that it's possible to complete your request but doesn't actually delete the `CustomDomain`.
Location: query
Type: boolean
etag
Description: A tag that represents the state of the `CustomDomain` as you know it. If present, the supplied tag must match the current value on your `CustomDomain`, or the request fails.
Location: query
Type: string
Parameter Order: name
Scopes:
Description: Deletes the specified `CustomDomain`.
▼ ▲ firebasehosting.projects.sites.customDomains.undelete
Path: v1beta1/{+name}:undelete
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}:undelete
HTTP Method: POST
Parameters:
name
Description: Required. The name of the `CustomDomain` to delete.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Undeletes the specified `CustomDomain` if it has been soft-deleted. Hosting retains soft-deleted CustomDomains for around 30 days before permanently deleting them.
▼ ▲ firebasehosting.projects.sites.customDomains.operations.list
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes:
Description: Lists operations that match the specified filter in the request.
▼ ▲ firebasehosting.projects.sites.customDomains.operations.get
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/sites/[^/]+/customDomains/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the latest state of a long-running operation. Use this method to poll the operation result at intervals as recommended by the API service.