Official vendor OpenAPI document · agent-readyStorageDatabaseoauth228 EndpointsREST
For Agents
Provision, scale, fail over, back up, and restore AlloyDB for PostgreSQL clusters and instances on Google Cloud.
Use for: Provision a new AlloyDB cluster in europe-west1, Add a read-pool instance to an existing AlloyDB cluster, Trigger an on-demand backup of an AlloyDB cluster, Restore an AlloyDB cluster from a backup
Not supported: Does not run application SQL queries, manage Postgres roles, or handle non-AlloyDB database services - use for AlloyDB cluster and instance lifecycle only.
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.
Install Jentic One Beta
Connect the AlloyDB API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AlloyDB API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Falloydb" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Falloydb" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with AlloyDB 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
Export cluster data to Cloud Storage in PostgreSQL dump or CSV format
List long-running operations in a project and cancel an in-flight one
Inject faults into a cluster to validate application failure handling
Use Cases
Patterns agents use AlloyDB 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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
AlloyDB API
- Non-Ready (F)40/100
43
Foundational Compliance56
Developer Experience & Jentic Compatibility19
AI-Readiness & Agent Experience94
Agent Usability63
Security56
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
43
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D-Signals: 4
54%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
17%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
19
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
77%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
63
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
62%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
56
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: CSignals: 1
56%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the AlloyDB API by hand means configuring Google OAuth 2.0 from a service account, rotating short-lived access tokens yourself, and pointing lifecycle calls at the alloydb.googleapis.com host. Through Jentic you install once, import the AlloyDB API from the API Directory, store the OAuth credential once, and your agent calls it.
Permission scoping
AlloyDB puts the resource name in the URL path (/v1/{+name}/locations, /v1/{+name}/operations), so a rule can pin your agent to one project or cluster: it can read locations and operations there and nothing else. You choose the operations it may call, so disruptive actions like failover, injectFault, export, or import are not included unless you add them.
Credential isolation
Your Google service account credential is stored once, encrypted, by your own Jentic One instance and rotated into short-lived access tokens at execution time. The key never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an AlloyDB cluster' or 'fail over an AlloyDB instance', and Jentic returns the matching AlloyDB operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AlloyDB 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 your Jentic One instance 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.
Can I limit what my agent is allowed to do with the AlloyDB API?
Yes. Because you run Jentic One yourself, your own rules decide which AlloyDB operations and credentials the agent may use. AlloyDB puts the resource name in the URL path, so you can pin the agent to a single project or cluster and let it only read locations and operations there. You also pick the exact operations it may call, so disruptive actions like failover, injectFault, export, or import stay off unless you explicitly add them.
GET STARTED