Project

View as Markdown

GetGET /api/2.0/postgres/{name=projects/*}ListGET /api/2.0/postgres/projectsCreatePOST /api/2.0/postgres/projectsUpdatePATCH /api/2.0/postgres/{project.name=projects/*}DeleteDELETE /api/2.0/postgres/{name=projects/*}

Project object

namestring

Output only. The full resource path of the project. Format: projects/{project_id}

uidstring

System-generated unique ID for the project.

create_timestring

A timestamp indicating when the project was created.

update_timestring

A timestamp indicating when the project was last updated.

specobject

The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.

Show child attributesHide child attributes

display_namestring

Human-readable project name. Length should be between 1 and 256 characters.

pg_versionint32

The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.

history_retention_durationstring

The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).

default_endpoint_settingsobject

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstring

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionboolean

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

budget_policy_idstring

The desired budget policy to associate with the project. See status.budget_policy_id for the policy that is actually applied to the project.

custom_tagsarray of object

Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project. Defaults to false.

default_branchstring

The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}

statusobject

The current status of a Project.

Show child attributesHide child attributes

display_namestring

The effective human-readable project name.

pg_versionint32

The effective major Postgres version number.

history_retention_durationstring

The effective number of seconds to retain the shared history for point in time recovery.

default_endpoint_settingsobject

The effective default endpoint settings.

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstring

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionboolean

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

branch_logical_size_limit_bytesint64

The logical size limit for a branch.

synthetic_storage_size_bytesint64

The current space occupied by the project in storage.

compute_last_active_timestring

The most recent time when any endpoint of this project was active.

budget_policy_idstring

The budget policy that is applied to the project.

custom_tagsarray of object

The effective custom tags associated with the project.

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

ownerstring

The email of the project owner.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project.

default_branchstring

The full resource path of the default branch of the project

project_idstring

Part of the resource name.

initial_endpoint_specobject

Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly created project. If omitted, the initial endpoint created will have default settings, without high availability configured. This field does not apply to any endpoints created after project creation. Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation.

Show child attributesHide child attributes

groupobject

Settings for HA configuration of the endpoint.

Show child attributesHide child attributes

minint32

The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.

maxint32

The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.

enable_readable_secondariesboolean

Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1.

autoscaling_limit_min_cudouble

The minimum number of Compute Units for the initial endpoint.

autoscaling_limit_max_cudouble

The maximum number of Compute Units for the initial endpoint.

suspend_timeout_durationstring

Duration of inactivity after which the initial endpoint is automatically suspended. If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension.

no_suspensionboolean

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration.

delete_timestringBeta

A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, otherwise set to a timestamp in the past.

purge_timestringBeta

A timestamp indicating when the project is scheduled for permanent deletion. Empty if the project is not deleted, otherwise set to a timestamp in the future.

initial_branch_specobject

Configuration for the initial default branch created as part of project creation. Allows overriding branch protection. These settings only apply at creation time and do not affect resources created after project creation.

Show child attributesHide child attributes

is_protectedboolean

Whether the initial default branch should be protected from deletion.

project_idstring

The part of the name, chosen by the user when the resource was created.

View as Markdown

The Project object

{
  "name": "string",
  "uid": "string",
  "create_time": "string",
  "update_time": "string",
  "spec": {
    "display_name": "string",
    "pg_version": 0,
    "history_retention_duration": "string",
    "default_endpoint_settings": {},
    "budget_policy_id": "string",
    "custom_tags": [
      {}
    ],
    "enable_pg_native_login": true,
    "default_branch": "string"
  },
  "status": {
    "display_name": "string",
    "pg_version": 0,
    "history_retention_duration": "string",
    "default_endpoint_settings": {},
    "branch_logical_size_limit_bytes": 0,
    "synthetic_storage_size_bytes": 0,
    "compute_last_active_time": "string",
    "budget_policy_id": "string",
    "custom_tags": [
      {}
    ],
    "owner": "string",
    "enable_pg_native_login": true,
    "default_branch": "string",
    "project_id": "string"
  },
  "initial_endpoint_spec": {
    "group": {},
    "autoscaling_limit_min_cu": 0,
    "autoscaling_limit_max_cu": 0,
    "suspend_timeout_duration": "string",
    "no_suspension": true
  },
  "delete_time": "string",
  "purge_time": "string",
  "initial_branch_spec": {
    "is_protected": true
  },
  "project_id": "string"
}

Get GA

GET /api/2.0/postgres/{name=projects/*}

Retrieves information about the specified database project.

API scopes: postgres

Parameters

namestringpath

The full resource path of the project to retrieve. Format: projects/{project_id}

Response

Returns the Project object.

View as Markdown

Response

{
  "name": "string",
  "uid": "string",
  "create_time": "string",
  "update_time": "string",
  "spec": {
    "display_name": "string",
    "pg_version": 0,
    "history_retention_duration": "string",
    "default_endpoint_settings": {},
    "budget_policy_id": "string",
    "custom_tags": [
      {}
    ],
    "enable_pg_native_login": true,
    "default_branch": "string"
  },
  "status": {
    "display_name": "string",
    "pg_version": 0,
    "history_retention_duration": "string",
    "default_endpoint_settings": {},
    "branch_logical_size_limit_bytes": 0,
    "synthetic_storage_size_bytes": 0,
    "compute_last_active_time": "string",
    "budget_policy_id": "string",
    "custom_tags": [
      {}
    ],
    "owner": "string",
    "enable_pg_native_login": true,
    "default_branch": "string",
    "project_id": "string"
  },
  "initial_endpoint_spec": {
    "group": {},
    "autoscaling_limit_min_cu": 0,
    "autoscaling_limit_max_cu": 0,
    "suspend_timeout_duration": "string",
    "no_suspension": true
  },
  "delete_time": "string",
  "purge_time": "string",
  "initial_branch_spec": {
    "is_protected": true
  },
  "project_id": "string"
}

List GA

GET /api/2.0/postgres/projects

Returns a paginated list of database projects in the workspace that the user has permission to access.

API scopes: postgres

Parameters

page_tokenstringquery

Page token from a previous response. If not provided, returns the first page.

page_sizeint32query

Upper bound for items returned. Cannot be negative. The maximum value is 100.

show_deletedbooleanBetaquery

Whether to include soft-deleted projects in the response. When true, soft-deleted projects are included alongside active projects. Hard-deleted and already-purged projects are never returned.

Response

Returns a list of Project objects.

View as Markdown

Response

{
  "projects": [
    {
      "name": "string",
      "uid": "string",
      "create_time": "string",
      "update_time": "string",
      "spec": {},
      "status": {},
      "initial_endpoint_spec": {},
      "delete_time": "string",
      "purge_time": "string",
      "initial_branch_spec": {},
      "project_id": "string"
    }
  ],
  "next_page_token": "string"
}

Create GA

POST /api/2.0/postgres/projects

Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.

API scopes: postgres

Parameters

project_idstringquery

The ID to use for the Project. This becomes the final component of the project's resource name. The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, my-app becomes projects/my-app.

Request body

projectobject

The Project to create.

Show child attributesHide child attributes

namestring

Output only. The full resource path of the project. Format: projects/{project_id}

uidstring

System-generated unique ID for the project.

create_timestring

A timestamp indicating when the project was created.

update_timestring

A timestamp indicating when the project was last updated.

specobject

The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.

Show child attributesHide child attributes

display_namestring

Human-readable project name. Length should be between 1 and 256 characters.

pg_versionint32

The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.

history_retention_durationstring

The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).

default_endpoint_settingsobject

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstringRequired

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

budget_policy_idstring

The desired budget policy to associate with the project. See status.budget_policy_id for the policy that is actually applied to the project.

custom_tagsarray of object

Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project. Defaults to false.

default_branchstring

The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}

statusobject

The current status of a Project.

Show child attributesHide child attributes

display_namestring

The effective human-readable project name.

pg_versionint32

The effective major Postgres version number.

history_retention_durationstring

The effective number of seconds to retain the shared history for point in time recovery.

default_endpoint_settingsobject

The effective default endpoint settings.

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstringRequired

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

branch_logical_size_limit_bytesint64

The logical size limit for a branch.

synthetic_storage_size_bytesint64

The current space occupied by the project in storage.

compute_last_active_timestring

The most recent time when any endpoint of this project was active.

budget_policy_idstring

The budget policy that is applied to the project.

custom_tagsarray of object

The effective custom tags associated with the project.

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

ownerstring

The email of the project owner.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project.

default_branchstring

The full resource path of the default branch of the project

project_idstring

Part of the resource name.

initial_endpoint_specobject

Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly created project. If omitted, the initial endpoint created will have default settings, without high availability configured. This field does not apply to any endpoints created after project creation. Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation.

Show child attributesHide child attributes

groupobject

Settings for HA configuration of the endpoint.

Show child attributesHide child attributes

minint32

The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.

maxint32

The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.

enable_readable_secondariesboolean

Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1.

autoscaling_limit_min_cudouble

The minimum number of Compute Units for the initial endpoint.

autoscaling_limit_max_cudouble

The maximum number of Compute Units for the initial endpoint.

suspend_timeout_durationstringRequired

Duration of inactivity after which the initial endpoint is automatically suspended. If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration.

delete_timestringBeta

A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, otherwise set to a timestamp in the past.

purge_timestringBeta

A timestamp indicating when the project is scheduled for permanent deletion. Empty if the project is not deleted, otherwise set to a timestamp in the future.

initial_branch_specobject

Configuration for the initial default branch created as part of project creation. Allows overriding branch protection. These settings only apply at creation time and do not affect resources created after project creation.

Show child attributesHide child attributes

is_protectedboolean

Whether the initial default branch should be protected from deletion.

project_idstring

The part of the name, chosen by the user when the resource was created.

Response

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobjectRequired

The error result of the operation in case of failure or cancellation.

Show child attributesHide child attributes

error_codestring

Values: UNKNOWN, INTERNAL_ERROR, TEMPORARILY_UNAVAILABLE, IO_ERROR, BAD_REQUEST, SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE, DEADLINE_EXCEEDED, CANCELLED, RESOURCE_EXHAUSTED, ABORTED, NOT_FOUND, ALREADY_EXISTS, UNAUTHENTICATED, UNAVAILABLE, INVALID_PARAMETER_VALUE, ENDPOINT_NOT_FOUND, MALFORMED_REQUEST, INVALID_STATE, PERMISSION_DENIED, FEATURE_DISABLED, CUSTOMER_UNAUTHORIZED, REQUEST_LIMIT_EXCEEDED, RESOURCE_CONFLICT, UNPARSEABLE_HTTP_ERROR, NOT_IMPLEMENTED, DATA_LOSS, INVALID_STATE_TRANSITION, COULD_NOT_ACQUIRE_LOCK, RESOURCE_ALREADY_EXISTS, RESOURCE_DOES_NOT_EXIST, QUOTA_EXCEEDED, MAX_BLOCK_SIZE_EXCEEDED, MAX_READ_SIZE_EXCEEDED, PARTIAL_DELETE, MAX_LIST_SIZE_EXCEEDED, DRY_RUN_FAILED, RESOURCE_LIMIT_EXCEEDED, DIRECTORY_NOT_EMPTY, DIRECTORY_PROTECTED, MAX_NOTEBOOK_SIZE_EXCEEDED, MAX_CHILD_NODE_SIZE_EXCEEDED, SEARCH_QUERY_TOO_LONG, SEARCH_QUERY_TOO_SHORT, MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST, PERMISSION_NOT_PROPAGATED, DEPLOYMENT_TIMEOUT, GIT_CONFLICT, GIT_UNKNOWN_REF, GIT_SENSITIVE_TOKEN_DETECTED, GIT_URL_NOT_ON_ALLOW_LIST, GIT_REMOTE_ERROR, PROJECTS_OPERATION_TIMEOUT, IPYNB_FILE_IN_REPO, INSECURE_PARTNER_RESPONSE, MALFORMED_PARTNER_RESPONSE, METASTORE_DOES_NOT_EXIST, DAC_DOES_NOT_EXIST, CATALOG_DOES_NOT_EXIST, SCHEMA_DOES_NOT_EXIST, TABLE_DOES_NOT_EXIST, SHARE_DOES_NOT_EXIST, RECIPIENT_DOES_NOT_EXIST, STORAGE_CREDENTIAL_DOES_NOT_EXIST, EXTERNAL_LOCATION_DOES_NOT_EXIST, PRINCIPAL_DOES_NOT_EXIST, PROVIDER_DOES_NOT_EXIST, METASTORE_ALREADY_EXISTS, DAC_ALREADY_EXISTS, CATALOG_ALREADY_EXISTS, SCHEMA_ALREADY_EXISTS, TABLE_ALREADY_EXISTS, SHARE_ALREADY_EXISTS, RECIPIENT_ALREADY_EXISTS, STORAGE_CREDENTIAL_ALREADY_EXISTS, EXTERNAL_LOCATION_ALREADY_EXISTS, PROVIDER_ALREADY_EXISTS, CATALOG_NOT_EMPTY, SCHEMA_NOT_EMPTY, METASTORE_NOT_EMPTY, PROVIDER_SHARE_NOT_ACCESSIBLE

messagestring

stack_tracestring

detailsarray of object

responseobjectRequired

The normal, successful response of the operation.

View as Markdown

Request

{
  "project": {
    "name": "string",
    "uid": "string",
    "create_time": "string",
    "update_time": "string",
    "spec": {},
    "status": {},
    "initial_endpoint_spec": {},
    "delete_time": "string",
    "purge_time": "string",
    "initial_branch_spec": {},
    "project_id": "string"
  }
}

Response

{
  "name": "string",
  "metadata": {},
  "done": true,
  "error": {
    "error_code": "string",
    "message": "string",
    "stack_trace": "string",
    "details": [
      {}
    ]
  },
  "response": {}
}

Update GA

PATCH /api/2.0/postgres/{project.name=projects/*}

Updates the specified database project.

API scopes: postgres

Parameters

projectobjectpath

The Project to update.

The project's name field is used to identify the project to update. Format: projects/{project_id}

Show child attributesHide child attributes

namestring

Output only. The full resource path of the project. Format: projects/{project_id}

uidstring

System-generated unique ID for the project.

create_timestring

A timestamp indicating when the project was created.

update_timestring

A timestamp indicating when the project was last updated.

specobject

The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.

Show child attributesHide child attributes

display_namestring

Human-readable project name. Length should be between 1 and 256 characters.

pg_versionint32

The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.

history_retention_durationstring

The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).

default_endpoint_settingsobject

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstringRequired

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

budget_policy_idstring

The desired budget policy to associate with the project. See status.budget_policy_id for the policy that is actually applied to the project.

custom_tagsarray of object

Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project. Defaults to false.

default_branchstring

The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}

statusobject

The current status of a Project.

Show child attributesHide child attributes

display_namestring

The effective human-readable project name.

pg_versionint32

The effective major Postgres version number.

history_retention_durationstring

The effective number of seconds to retain the shared history for point in time recovery.

default_endpoint_settingsobject

The effective default endpoint settings.

Show child attributesHide child attributes

autoscaling_limit_min_cudouble

The minimum number of Compute Units. Minimum value is 0.5.

autoscaling_limit_max_cudouble

The maximum number of Compute Units. Minimum value is 0.5.

suspend_timeout_durationstringRequired

Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension. When updating, use spec.project_default_settings.suspension in the update_mask.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration. When updating, use spec.project_default_settings.suspension in the update_mask.

pg_settingsobject

A raw representation of Postgres settings.

branch_logical_size_limit_bytesint64

The logical size limit for a branch.

synthetic_storage_size_bytesint64

The current space occupied by the project in storage.

compute_last_active_timestring

The most recent time when any endpoint of this project was active.

budget_policy_idstring

The budget policy that is applied to the project.

custom_tagsarray of object

The effective custom tags associated with the project.

Show child attributesHide child attributes

keystring

The key of the custom tag.

valuestring

The value of the custom tag.

ownerstring

The email of the project owner.

enable_pg_native_loginboolean

Whether to enable PG native password login on all endpoints in this project.

default_branchstring

The full resource path of the default branch of the project

project_idstring

Part of the resource name.

initial_endpoint_specobject

Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly created project. If omitted, the initial endpoint created will have default settings, without high availability configured. This field does not apply to any endpoints created after project creation. Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation.

Show child attributesHide child attributes

groupobject

Settings for HA configuration of the endpoint.

Show child attributesHide child attributes

minint32

The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.

maxint32

The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.

enable_readable_secondariesboolean

Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1.

autoscaling_limit_min_cudouble

The minimum number of Compute Units for the initial endpoint.

autoscaling_limit_max_cudouble

The maximum number of Compute Units for the initial endpoint.

suspend_timeout_durationstringRequired

Duration of inactivity after which the initial endpoint is automatically suspended. If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension.

no_suspensionbooleanRequired

When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration.

delete_timestringBeta

A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, otherwise set to a timestamp in the past.

purge_timestringBeta

A timestamp indicating when the project is scheduled for permanent deletion. Empty if the project is not deleted, otherwise set to a timestamp in the future.

initial_branch_specobject

Configuration for the initial default branch created as part of project creation. Allows overriding branch protection. These settings only apply at creation time and do not affect resources created after project creation.

Show child attributesHide child attributes

is_protectedboolean

Whether the initial default branch should be protected from deletion.

project_idstring

The part of the name, chosen by the user when the resource was created.

update_maskstringquery

The list of fields to update.

Response

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobjectRequired

The error result of the operation in case of failure or cancellation.

Show child attributesHide child attributes

error_codestring

Values: UNKNOWN, INTERNAL_ERROR, TEMPORARILY_UNAVAILABLE, IO_ERROR, BAD_REQUEST, SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE, DEADLINE_EXCEEDED, CANCELLED, RESOURCE_EXHAUSTED, ABORTED, NOT_FOUND, ALREADY_EXISTS, UNAUTHENTICATED, UNAVAILABLE, INVALID_PARAMETER_VALUE, ENDPOINT_NOT_FOUND, MALFORMED_REQUEST, INVALID_STATE, PERMISSION_DENIED, FEATURE_DISABLED, CUSTOMER_UNAUTHORIZED, REQUEST_LIMIT_EXCEEDED, RESOURCE_CONFLICT, UNPARSEABLE_HTTP_ERROR, NOT_IMPLEMENTED, DATA_LOSS, INVALID_STATE_TRANSITION, COULD_NOT_ACQUIRE_LOCK, RESOURCE_ALREADY_EXISTS, RESOURCE_DOES_NOT_EXIST, QUOTA_EXCEEDED, MAX_BLOCK_SIZE_EXCEEDED, MAX_READ_SIZE_EXCEEDED, PARTIAL_DELETE, MAX_LIST_SIZE_EXCEEDED, DRY_RUN_FAILED, RESOURCE_LIMIT_EXCEEDED, DIRECTORY_NOT_EMPTY, DIRECTORY_PROTECTED, MAX_NOTEBOOK_SIZE_EXCEEDED, MAX_CHILD_NODE_SIZE_EXCEEDED, SEARCH_QUERY_TOO_LONG, SEARCH_QUERY_TOO_SHORT, MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST, PERMISSION_NOT_PROPAGATED, DEPLOYMENT_TIMEOUT, GIT_CONFLICT, GIT_UNKNOWN_REF, GIT_SENSITIVE_TOKEN_DETECTED, GIT_URL_NOT_ON_ALLOW_LIST, GIT_REMOTE_ERROR, PROJECTS_OPERATION_TIMEOUT, IPYNB_FILE_IN_REPO, INSECURE_PARTNER_RESPONSE, MALFORMED_PARTNER_RESPONSE, METASTORE_DOES_NOT_EXIST, DAC_DOES_NOT_EXIST, CATALOG_DOES_NOT_EXIST, SCHEMA_DOES_NOT_EXIST, TABLE_DOES_NOT_EXIST, SHARE_DOES_NOT_EXIST, RECIPIENT_DOES_NOT_EXIST, STORAGE_CREDENTIAL_DOES_NOT_EXIST, EXTERNAL_LOCATION_DOES_NOT_EXIST, PRINCIPAL_DOES_NOT_EXIST, PROVIDER_DOES_NOT_EXIST, METASTORE_ALREADY_EXISTS, DAC_ALREADY_EXISTS, CATALOG_ALREADY_EXISTS, SCHEMA_ALREADY_EXISTS, TABLE_ALREADY_EXISTS, SHARE_ALREADY_EXISTS, RECIPIENT_ALREADY_EXISTS, STORAGE_CREDENTIAL_ALREADY_EXISTS, EXTERNAL_LOCATION_ALREADY_EXISTS, PROVIDER_ALREADY_EXISTS, CATALOG_NOT_EMPTY, SCHEMA_NOT_EMPTY, METASTORE_NOT_EMPTY, PROVIDER_SHARE_NOT_ACCESSIBLE

messagestring

stack_tracestring

detailsarray of object

responseobjectRequired

The normal, successful response of the operation.

View as Markdown

Response

{
  "name": "string",
  "metadata": {},
  "done": true,
  "error": {
    "error_code": "string",
    "message": "string",
    "stack_trace": "string",
    "details": [
      {}
    ]
  },
  "response": {}
}

Delete GA

DELETE /api/2.0/postgres/{name=projects/*}

Deletes the specified database project.

API scopes: postgres

Parameters

namestringpath

The full resource path of the project to delete. Format: projects/{project_id}

purgebooleanBetaquery

If true, permanently deletes the project (hard delete). If false or unset, performs a soft delete.

Response

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobjectRequired

The error result of the operation in case of failure or cancellation.

Show child attributesHide child attributes

error_codestring

Values: UNKNOWN, INTERNAL_ERROR, TEMPORARILY_UNAVAILABLE, IO_ERROR, BAD_REQUEST, SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE, DEADLINE_EXCEEDED, CANCELLED, RESOURCE_EXHAUSTED, ABORTED, NOT_FOUND, ALREADY_EXISTS, UNAUTHENTICATED, UNAVAILABLE, INVALID_PARAMETER_VALUE, ENDPOINT_NOT_FOUND, MALFORMED_REQUEST, INVALID_STATE, PERMISSION_DENIED, FEATURE_DISABLED, CUSTOMER_UNAUTHORIZED, REQUEST_LIMIT_EXCEEDED, RESOURCE_CONFLICT, UNPARSEABLE_HTTP_ERROR, NOT_IMPLEMENTED, DATA_LOSS, INVALID_STATE_TRANSITION, COULD_NOT_ACQUIRE_LOCK, RESOURCE_ALREADY_EXISTS, RESOURCE_DOES_NOT_EXIST, QUOTA_EXCEEDED, MAX_BLOCK_SIZE_EXCEEDED, MAX_READ_SIZE_EXCEEDED, PARTIAL_DELETE, MAX_LIST_SIZE_EXCEEDED, DRY_RUN_FAILED, RESOURCE_LIMIT_EXCEEDED, DIRECTORY_NOT_EMPTY, DIRECTORY_PROTECTED, MAX_NOTEBOOK_SIZE_EXCEEDED, MAX_CHILD_NODE_SIZE_EXCEEDED, SEARCH_QUERY_TOO_LONG, SEARCH_QUERY_TOO_SHORT, MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST, PERMISSION_NOT_PROPAGATED, DEPLOYMENT_TIMEOUT, GIT_CONFLICT, GIT_UNKNOWN_REF, GIT_SENSITIVE_TOKEN_DETECTED, GIT_URL_NOT_ON_ALLOW_LIST, GIT_REMOTE_ERROR, PROJECTS_OPERATION_TIMEOUT, IPYNB_FILE_IN_REPO, INSECURE_PARTNER_RESPONSE, MALFORMED_PARTNER_RESPONSE, METASTORE_DOES_NOT_EXIST, DAC_DOES_NOT_EXIST, CATALOG_DOES_NOT_EXIST, SCHEMA_DOES_NOT_EXIST, TABLE_DOES_NOT_EXIST, SHARE_DOES_NOT_EXIST, RECIPIENT_DOES_NOT_EXIST, STORAGE_CREDENTIAL_DOES_NOT_EXIST, EXTERNAL_LOCATION_DOES_NOT_EXIST, PRINCIPAL_DOES_NOT_EXIST, PROVIDER_DOES_NOT_EXIST, METASTORE_ALREADY_EXISTS, DAC_ALREADY_EXISTS, CATALOG_ALREADY_EXISTS, SCHEMA_ALREADY_EXISTS, TABLE_ALREADY_EXISTS, SHARE_ALREADY_EXISTS, RECIPIENT_ALREADY_EXISTS, STORAGE_CREDENTIAL_ALREADY_EXISTS, EXTERNAL_LOCATION_ALREADY_EXISTS, PROVIDER_ALREADY_EXISTS, CATALOG_NOT_EMPTY, SCHEMA_NOT_EMPTY, METASTORE_NOT_EMPTY, PROVIDER_SHARE_NOT_ACCESSIBLE

messagestring

stack_tracestring

detailsarray of object

responseobjectRequired

The normal, successful response of the operation.

View as Markdown

Response

{
  "name": "string",
  "metadata": {},
  "done": true,
  "error": {
    "error_code": "string",
    "message": "string",
    "stack_trace": "string",
    "details": [
      {}
    ]
  },
  "response": {}
}