v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13144376.2 KB
projects

Creates a new backend in a given project and location.

post/v1/{+parent}/backends

Path parameters

parentstring required

Required. A parent name of the form projects/{project}/locations/{locationId}.

Query parameters

backendIdstring

Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name.

requestIdstring

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).

validateOnlyboolean

Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

Request body

deleteTimestring google-datetime

Output only. Time at which the backend was deleted.

requestLogsDisabledboolean

Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.

etagstring

Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.

uristring

Output only. The primary URI to communicate with the backend.

createTimestring google-datetime

Output only. Time at which the backend was created.

updateTimestring google-datetime

Output only. Time at which the backend was last updated.

annotationsobject

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

displayNamestring

Optional. Human-readable name. 63 character limit.

modestring

Optional. Deprecated: Use environment instead.

servingLocality'SERVING_LOCALITY_UNSPECIFIED' | 'REGIONAL_STRICT' | 'GLOBAL_ACCESS'

Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).

namestring

Identifier. The resource name of the backend. Format: projects/{project}/locations/{locationId}/backends/{backendId}.

environmentstring

Optional. The environment name of the backend, used to load environment variables from environment specific configuration.

serviceAccountstring

Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.

uidstring

Output only. System-assigned, unique identifier.

reconcilingboolean

Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.

labelsobject

Optional. Unstructured key value map that can be used to organize and categorize objects.

appIdstring

Optional. The ID of a Web App associated with the backend.

Response

Successful response