AlloyDB API

Name: AlloyDB API API
Brand: AlloyDB API
Availability: InStock

✓ Official Vendor SpecStorageDatabaseoauth228 EndpointsREST

For Agents

Provision, scale, fail over, back up, and restore AlloyDB for PostgreSQL clusters and instances on Google Cloud.

Quickstart

Get started with AlloyDB API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create an AlloyDB cluster"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with AlloyDB API API.

Create an AlloyDB cluster with primary instance and configure machine type and region

Add or remove read-pool instances to scale read capacity for an existing cluster

Run a controlled failover or switchover on a cluster to test disaster recovery

Trigger an on-demand backup of a cluster and restore from a backup or point-in-time

GET STARTED

Start building with AlloyDB API API

Explore with Jentic

View OpenAPI Document

The AlloyDB API is the control plane for AlloyDB for PostgreSQL on Google Cloud — Google's PostgreSQL-compatible managed database service tuned for transactional and analytical workloads. It provisions and manages clusters and primary or read-pool instances, runs failover and switchover, drives backups and exports, and supports cluster restore. Application data access still goes through the standard PostgreSQL wire protocol; this API is for lifecycle and operations.

Use Cases

Patterns agents use AlloyDB API API for, with concrete tasks.

★ Provision Production Postgres Infrastructure

Platform teams use the AlloyDB API to spin up production PostgreSQL clusters as part of an environment provisioning pipeline rather than hand-clicking in the Cloud Console. The flow creates a cluster, adds a primary instance, then attaches one or more read-pool instances. The cluster appears as a standard Postgres endpoint that application services connect to with their existing drivers.

POST /v1/projects/{project}/locations/{loc}/clusters with cluster body, then POST /v1/{+parent}/instances with instanceType=PRIMARY, then create READ_POOL instances under the same parent.

Disaster Recovery Drills

Reliability teams need to prove that an AlloyDB-backed service tolerates failover. The API exposes :failover and :switchover on instances and :injectFault on clusters, so a DR drill can be expressed as a runbook that triggers the failover, watches the long-running operation, and verifies that application traffic recovered. This replaces ad-hoc console clicks during scheduled DR exercises.

POST /v1/{+name}:failover on the primary instance, poll the returned operation under /v1/{+name}/operations until done, and verify the cluster's primary IP rotated.

Backup, Restore, and Export Pipeline

A backup automation tool can use the AlloyDB API to schedule on-demand backups of every cluster, list backup objects per project, restore from any backup or point-in-time into a new cluster, and export data to Cloud Storage for archival. This lets compliance-driven teams meet RPO/RTO targets without manual operator steps.

Create a backup with POST /v1/{+parent}/backups, then test restore by POSTing /v1/{+parent}/clusters:restore with backupSource pointing at the backup name.

Agent-Driven Database Operations

An agent integrating AlloyDB through Jentic can express database lifecycle steps as natural-language intents — provision a cluster, add a read pool, take a backup. Jentic isolates the Google Cloud service account and exposes the operation schemas, so an agent stitches a multi-step DR or environment-bootstrap workflow without writing OAuth or LRO polling boilerplate.

Use the Jentic search query 'create an AlloyDB cluster' to discover the operation, then create the cluster, primary instance, and one read-pool instance and report back the connection details.

Key Endpoints

28 endpoints — the alloydb api is the control plane for alloydb for postgresql on google cloud — google's postgresql-compatible managed database service tuned for transactional and analytical workloads.

METHOD

PATH

DESCRIPTION

GET

/v1/{+name}/locations

List Google Cloud locations available for AlloyDB

GET

/v1/{+name}/operations

List long-running operations in a project and location

POST

/v1/{+name}:cancel

Cancel a long-running operation

POST

/v1/{+name}:export

Export cluster data to Cloud Storage

POST

/v1/{+name}:failover

Fail over an instance to its standby

POST

/v1/{+name}:injectFault

Inject a fault into a cluster for DR testing

POST

/v1/{+name}:import

Import data into a cluster from Cloud Storage

GET

/v1/{+name}/locations

List Google Cloud locations available for AlloyDB

GET

/v1/{+name}/operations

List long-running operations in a project and location

POST

/v1/{+name}:cancel

Cancel a long-running operation

POST

/v1/{+name}:export

Export cluster data to Cloud Storage

POST

/v1/{+name}:failover

Fail over an instance to its standby

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

AlloyDB uses OAuth 2.0 access tokens minted from a Google Cloud service account. Jentic stores the service account JSON in the encrypted MAXsystem vault and issues short-lived tokens, so the agent never sees the key.

Intent-based discovery

Agents search Jentic with intents like 'create an AlloyDB cluster' or 'fail over an AlloyDB instance' and Jentic returns the matching operation across the 28-endpoint surface with its input schema.

Time to first call

Direct AlloyDB integration takes 2-3 days to handle OAuth, project scoping, and long-running operation polling. Through Jentic, a provision or backup workflow runs in under an hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Cloud SQL Admin API

Cloud SQL Admin manages MySQL, PostgreSQL, and SQL Server instances; AlloyDB is Google's higher-performance Postgres-only service.

Use Cloud SQL Admin for general-purpose managed databases or non-Postgres engines; use AlloyDB for Postgres-compatible workloads needing higher performance and HTAP.

Alternative

Cloud Spanner API

Spanner is a globally distributed strongly consistent database; AlloyDB is a regional PostgreSQL-compatible service.

Use Spanner when global distribution and strong consistency are required; use AlloyDB when you need PostgreSQL compatibility within a region.

Complementary

Cloud Storage API

Cloud Storage is the destination for AlloyDB exports and the source for imports.

Pair with AlloyDB whenever an agent runs export or import operations.

FAQs

Specific to using AlloyDB API API through Jentic.

What authentication does the AlloyDB API use?

OAuth 2.0 with the cloud-platform scope, typically via a Google Cloud service account that has the AlloyDB Admin or Editor role. Jentic stores the service account credential in the MAXsystem vault and issues short-lived access tokens to the agent, keeping keys out of agent context.

Can I run application SQL queries through this API?

No. The AlloyDB API is the control plane only — provisioning, lifecycle, backup, and operations. Application data access uses the standard PostgreSQL wire protocol against the cluster's IP and port with a Postgres driver.

What are the rate limits for the AlloyDB API?

AlloyDB control-plane operations are governed by the per-project Google Cloud quota for the AlloyDB service. Long-running operations such as create cluster and restore are throttled to a small number of concurrent operations per project; check IAM and Admin, Quotas in the Cloud Console.

How do I provision an AlloyDB cluster through Jentic?

Search Jentic for 'create an AlloyDB cluster', load the schema for /v1/projects/{project}/locations/{location}/clusters, and execute it. Run pip install jentic and use the async search, load, execute pattern. Then create a primary instance via /v1/{+parent}/instances.

How do I run a failover for testing?

Call POST /v1/{+name}:failover on the primary instance. The API returns a long-running operation; poll /v1/{+name}/operations until done is true. Use :switchover for planned, lower-impact failover.

Is AlloyDB free?

AlloyDB is paid: charges are per vCPU-hour for primary and read-pool instances, per GB of storage, and per GB of backup. See AlloyDB pricing in the Google Cloud Console for the current per-region rates.