2025-05-07
▼ ▲ firebaseapphosting.projects.locations.list
Path : v1beta/{+name}/locations
Flat Path : v1beta/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
extraLocationTypes
Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
Location : query
Repeated : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ firebaseapphosting.projects.locations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ firebaseapphosting.projects.locations.operations.list
Path : v1beta/{+name}/operations
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
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 : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ firebaseapphosting.projects.locations.operations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ firebaseapphosting.projects.locations.operations.delete
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ firebaseapphosting.projects.locations.operations.cancel
Path : v1beta/{+name}:cancel
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ firebaseapphosting.projects.locations.backends.list
Path : v1beta/{+parent}/backends
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends
HTTP Method : GET
Parameters :
parent
Description : Required. A parent name of the form `projects/{project}/locations/{locationId}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
filter
Description : Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.
Location : query
Type : string
showDeleted
Description : Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists backends in a given project and location.
▼ ▲ firebaseapphosting.projects.locations.backends.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.create
Path : v1beta/{+parent}/backends
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends
HTTP Method : POST
Parameters :
parent
Description : Required. A parent name of the form `projects/{project}/locations/{locationId}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
backendId
Description : Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name.
Location : query
Type : string
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new backend in a given project and location.
▼ ▲ firebaseapphosting.projects.locations.backends.patch
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the update_mask 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.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated, without persisting the request or updating any resources.
Location : query
Type : boolean
allowMissing
Description : Optional. If set to true, and the backend is not found, a new backend will be created.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the information for a single backend.
▼ ▲ firebaseapphosting.projects.locations.backends.delete
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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 after 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).
Location : query
Type : string
force
Description : Optional. If set to true, any resources for this backend will also be deleted. Otherwise, any children resources will block deletion.
Location : query
Type : boolean
validateOnly
Description : Optional. Indicates that the request should be validated, without persisting the request or updating any resources.
Location : query
Type : boolean
etag
Description : Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single backend.
▼ ▲ firebaseapphosting.projects.locations.backends.traffic.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a backend's traffic.
▼ ▲ firebaseapphosting.projects.locations.backends.traffic.patch
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask 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.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated, without persisting the request or updating any resources.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a backend's traffic.
▼ ▲ firebaseapphosting.projects.locations.backends.builds.list
Path : v1beta/{+parent}/builds
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds
HTTP Method : GET
Parameters :
parent
Description : Required. The parent backend in the form `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
filter
Description : Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.
Location : query
Type : string
showDeleted
Description : Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists builds in a given project, location, and backend.
▼ ▲ firebaseapphosting.projects.locations.backends.builds.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a build.
▼ ▲ firebaseapphosting.projects.locations.backends.builds.create
Path : v1beta/{+parent}/builds
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds
HTTP Method : POST
Parameters :
parent
Description : Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
buildId
Description : Required. Desired ID of the build being created.
Location : query
Type : string
requestId
Description : 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 the 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new build for a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.builds.delete
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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 after the first request. For example, consider a situation where you make an initial request and the 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).
Location : query
Type : string
etag
Description : Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single build.
▼ ▲ firebaseapphosting.projects.locations.backends.rollouts.list
Path : v1beta/{+parent}/rollouts
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts
HTTP Method : GET
Parameters :
parent
Description : Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
filter
Description : Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.
Location : query
Type : string
showDeleted
Description : Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists rollouts for a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.rollouts.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts/{rolloutsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/rollouts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a rollout.
▼ ▲ firebaseapphosting.projects.locations.backends.rollouts.create
Path : v1beta/{+parent}/rollouts
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts
HTTP Method : POST
Parameters :
parent
Description : Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
rolloutId
Description : Optional. Desired ID of the rollout being created.
Location : query
Type : string
requestId
Description : 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 the 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new rollout for a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.domains.list
Path : v1beta/{+parent}/domains
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains
HTTP Method : GET
Parameters :
parent
Description : Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
filter
Description : Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.
Location : query
Type : string
showDeleted
Description : Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists domains of a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.domains.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a domain.
▼ ▲ firebaseapphosting.projects.locations.backends.domains.create
Path : v1beta/{+parent}/domains
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains
HTTP Method : POST
Parameters :
parent
Description : Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+$
Location : path
Required : Yes
Type : string
domainId
Description : Required. Id of the domain to create. Must be a valid domain name.
Location : query
Type : string
requestId
Description : 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 the 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Links a new domain to a backend.
▼ ▲ firebaseapphosting.projects.locations.backends.domains.patch
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask 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.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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 the 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).
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying any resources.
Location : query
Type : boolean
allowMissing
Description : Optional. If set to true, and the domain is not found, a new domain will be created.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the information for a single domain.
▼ ▲ firebaseapphosting.projects.locations.backends.domains.delete
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.
Pattern : ^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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 after the first request. For example, consider a situation where you make an initial request and the 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).
Location : query
Type : string
etag
Description : Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.
Location : query
Type : string
validateOnly
Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single domain.