AlloyDB API
AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
Endpoints 28
projects.locations.operations
- GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.clusters.users
- PATCHUpdates the parameters of a single User.
/v1/:name?allowMissing=true&requestId=string&updateMask=string&validateOnly=trueUpdates the parameters of a single User. - GETLists Users in a given project and location.
/v1/:parent/users?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Users in a given project and location. - POSTCreates a new User in a given project, location, and cluster.
/v1/:parent/users?requestId=string&userId=string&validateOnly=trueCreates a new User in a given project, location, and cluster.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.backups
- GETLists Backups in a given project and location.
/v1/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=string&view=BACKUP_VIEW_UNSPECIFIEDLists Backups in a given project and location. - POSTCreates a new Backup in a given project and location.
/v1/:parent/backups?backupId=string&requestId=string&validateOnly=trueCreates a new Backup in a given project and location.
projects.locations.clusters
- GETLists Clusters in a given project and location.
/v1/:parent/clusters?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Clusters in a given project and location. - POSTCreates a new Cluster in a given project and location.
/v1/:parent/clusters?clusterId=string&requestId=string&validateOnly=trueCreates a new Cluster in a given project and location. - POSTCreates a cluster of type SECONDARY in the given location using the primary cluster as the source.
/v1/:parent/clusters:createsecondary?clusterId=string&requestId=string&validateOnly=trueCreates a cluster of type SECONDARY in the given location using the primary cluster as the source. - POSTExports data from the cluster
/v1/:name:exportExports data from the cluster. Imperative only. - POSTImports data to the cluster
/v1/:name:importImports data to the cluster. Imperative only. - POSTPromotes a SECONDARY cluster
/v1/:name:promotePromotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster.… - POSTCreates a new Cluster in a given project and location, with a volume restored from the provided source, either a…
/v1/:parent/clusters:restoreCreates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source… - POSTRestores an AlloyDB cluster from a CloudSQL resource.
/v1/:parent/clusters:restoreFromCloudSQLRestores an AlloyDB cluster from a CloudSQL resource. - POSTSwitches the roles of PRIMARY and SECONDARY clusters without any data loss
/v1/:name:switchoverSwitches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY… - PATCHUpgrades a single Cluster
/v1/:name:upgradeUpgrades a single Cluster. Imperative only.
projects.locations.clusters.instances
- GETLists Instances in a given project and location.
/v1/:parent/instances?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Instances in a given project and location. - POSTCreates a new Instance in a given project and location.
/v1/:parent/instances?instanceId=string&requestId=string&validateOnly=trueCreates a new Instance in a given project and location. - POSTCreates a new SECONDARY Instance in a given project and location.
/v1/:parent/instances:createsecondary?instanceId=string&requestId=string&validateOnly=trueCreates a new SECONDARY Instance in a given project and location. - POSTForces a Failover for a highly available instance
/v1/:name:failoverForces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only. - GETGet instance metadata used for a connection.
/v1/:parent/connectionInfo?requestId=stringGet instance metadata used for a connection. - POSTInjects fault in an instance
/v1/:name:injectFaultInjects fault in an instance. Imperative only. - POSTRestart an Instance in a cluster
/v1/:name:restartRestart an Instance in a cluster. Imperative only.
projects.locations.supportedDatabaseFlags
- GETLists SupportedDatabaseFlags for a given project and location.
/v1/:parent/supportedDatabaseFlags?pageSize=0&pageToken=string&scope=SCOPE_UNSPECIFIEDLists SupportedDatabaseFlags for a given project and location.
API details
- Base URL
https://alloydb.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 28 operations on 22 pathsPOST 16GET 9PATCH 2DELETE 1
- Main resources
- projects.locations.clusters 10projects.locations.clusters.instances 7projects.locations.operations 4projects.locations.clusters.users 3projects.locations.backups 2projects.locations 1projects.locations.supportedDatabaseFlags 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the AlloyDB API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AlloyDB API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AlloyDB API?
AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade… It is listed under Developer tools and has 28 endpoints.
Who publishes the AlloyDB API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AlloyDB API?
Requests go to https://alloydb.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the AlloyDB API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the AlloyDB API have?
28 operations on 22 paths (16 POST, 9 GET, 2 PATCH, 1 DELETE). The largest groups are projects.locations.clusters, projects.locations.clusters.instances, projects.locations.operations, projects.locations.clusters.users.
Is forking the AlloyDB API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.