Sign in

v1

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

Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.

post/v1beta/{+parent}/instances

Path parameters

parentstring required

Required. The parent project for which to create a database instance, in the form: projects/{project-number}/locations/{location-id}.

Query parameters

databaseIdstring

The globally unique identifier of the database instance.

validateOnlyboolean

When set to true, the request will be validated but not submitted.

Request body

namestring

The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.

type'DATABASE_INSTANCE_TYPE_UNSPECIFIED' | 'DEFAULT_DATABASE' | 'USER_DATABASE'

Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.

databaseUrlstring

Output only. Output Only. The globally unique hostname of the database.

projectstring

Output only. The resource name of the project this instance belongs to. For example: projects/{project-number}.

state'LIFECYCLE_STATE_UNSPECIFIED' | 'ACTIVE' | 'DISABLED' | 'DELETED'

Output only. The database's lifecycle state. Read-only.

Response

Successful response