# AlloyDB API API

> AlloyDB API API on Apizie: 28 endpoints (Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…, Updates the parameters of a single User., Deletes a long-running operation. This method indicates that the client is no longer interested in the…, Lists information about the supported locations for this service. This method lists locations based on the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/analytics:googleapis-alloydb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-alloydb`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/alloydb/
- Page: https://apizie.tech/api/analytics/googleapis-alloydb
- OpenAPI: https://apizie.tech/api/analytics/googleapis-alloydb/openapi.json

AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard…

## Endpoints

### Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource. |

### Updates the parameters of a single User.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-users-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| allowMissing | boolean | no | Optional. Allow missing fields in the update mask. |
| name | string | yes | Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| updateMask | string | no | Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the… |
| validateOnly | boolean | no | Optional. If set, the backend validates the request, but doesn't actually execute it. |
| body | object | yes | JSON request body |

### Deletes a long-running operation. This method indicates that the client is no longer interested in the…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be deleted. |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Lists Backups in a given project and location.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-backups-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Filtering results |
| orderBy | string | no | Hint for how to order the results |
| pageSize | integer | no | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken | string | no | A token identifying a page of results the server should return. |
| parent | string | yes | Required. Parent value for ListBackupsRequest |
| view | string | no | Optional. The view of the backup to return. |

### Creates a new Backup in a given project and location.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-backups-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| backupId | string | no | Required. ID of the requesting object. |
| parent | string | yes | Required. Value for parent. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| validateOnly | boolean | no | Optional. If set, the backend validates the request, but doesn't actually execute it. |
| body | object | yes | JSON request body |

### Lists Clusters in a given project and location.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filtering results |
| orderBy | string | no | Optional. Hint for how to order the results |
| pageSize | integer | no | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken | string | no | A token identifying a page of results the server should return. |
| parent | string | yes | Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can… |

### Creates a new Cluster in a given project and location.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| clusterId | string | no | Required. ID of the requesting object. |
| parent | string | yes | Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| validateOnly | boolean | no | Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually… |
| body | object | yes | JSON request body |

### Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-createsecondary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| clusterId | string | no | Required. ID of the requesting object (the secondary cluster). |
| parent | string | yes | Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| validateOnly | boolean | no | Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually… |
| body | object | yes | JSON request body |

### Exports data from the cluster. Imperative only.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the cluster. |
| body | object | yes | JSON request body |

### Imports data to the cluster. Imperative only.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the cluster. |
| body | object | yes | JSON request body |

### Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-promote` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource. For the required format, see the comment on the Cluster.name field |
| body | object | yes | JSON request body |

### Creates a new Cluster in a given project and location, with a volume restored from the provided source,…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-restore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. |
| body | object | yes | JSON request body |

### Restores an AlloyDB cluster from a CloudSQL resource.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-restore-from-cloud-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The location of the new cluster. For the required format, see the comment on Cluster.name field. |
| body | object | yes | JSON request body |

### Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-switchover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource. For the required format, see the comment on the Cluster.name field |
| body | object | yes | JSON request body |

### Upgrades a single Cluster. Imperative only.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the cluster. |
| body | object | yes | JSON request body |

### Lists Instances in a given project and location.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filtering results |
| orderBy | string | no | Optional. Hint for how to order the results |
| pageSize | integer | no | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken | string | no | A token identifying a page of results the server should return. |
| parent | string | yes | Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can… |

### Creates a new Instance in a given project and location.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | no | Required. ID of the requesting object. |
| parent | string | yes | Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| validateOnly | boolean | no | Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually… |
| body | object | yes | JSON request body |

### Creates a new SECONDARY Instance in a given project and location.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-createsecondar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | no | Required. ID of the requesting object. |
| parent | string | yes | Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| validateOnly | boolean | no | Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually… |
| body | object | yes | JSON request body |

### Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource. For the required format, see the comment on the Instance.name field. |
| body | object | yes | JSON request body |

### Get instance metadata used for a connection.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-get-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the parent resource. The required format is:… |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |

### Injects fault in an instance. Imperative only.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-inject-fault` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource. For the required format, see the comment on the Instance.name field. |
| body | object | yes | JSON request body |

### Restart an Instance in a cluster. Imperative only.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-instances-restart` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource. For the required format, see the comment on the Instance.name field. |
| body | object | yes | JSON request body |

### Lists Users in a given project and location.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-users-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Filtering results |
| orderBy | string | no | Optional. Hint for how to order the results |
| pageSize | integer | no | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken | string | no | Optional. A token identifying a page of results the server should return. |
| parent | string | yes | Required. Parent value for ListUsersRequest |

### Creates a new User in a given project, location, and cluster.
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-clusters-users-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Value for parent. |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server… |
| userId | string | no | Required. ID of the requesting object. |
| validateOnly | boolean | no | Optional. If set, the backend validates the request, but doesn't actually execute it. |
| body | object | yes | JSON request body |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Lists SupportedDatabaseFlags for a given project and location.
`GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-supported-database-flags-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken | string | no | A token identifying a page of results the server should return. |
| parent | string | yes | Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent… |
| scope | string | no | Optional. The scope for which supported flags are requested. If not specified, default is DATABASE. |

## Example
```
curl "https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AlloyDB API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/analytics:googleapis-alloydb/alloydb-projects-locations-operations-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AlloyDB API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AlloyDB API itself also needs your own key from googleapis.com.

### Can AI agents use the AlloyDB API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-alloydb.

### What is the status of the AlloyDB API API?
Needs your own provider key (bring your own key)