Cloud SQL Admin API

API for Cloud SQL instance management.

Service: sqladmin.googleapis.com

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://sqladmin.googleapis.com

REST Resource: v1beta4.backupRuns

Methods
delete DELETE /sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}
Deletes the backup taken by a backup run.
get GET /sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}
Retrieves a resource containing information about a backup run.
insert POST /sql/v1beta4/projects/{project}/instances/{instance}/backupRuns
Creates a new backup run on demand.
list GET /sql/v1beta4/projects/{project}/instances/{instance}/backupRuns
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

REST Resource: v1beta4.databases

Methods
delete DELETE /sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}
Deletes a database from a Cloud SQL instance.
get GET /sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}
Retrieves a resource containing information about a database inside a Cloud SQL instance.
insert POST /sql/v1beta4/projects/{project}/instances/{instance}/databases
Inserts a resource containing information about a database inside a Cloud SQL instance.
list GET /sql/v1beta4/projects/{project}/instances/{instance}/databases
Lists databases in the specified Cloud SQL instance.
patch PATCH /sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}
Partially updates a resource containing information about a database inside a Cloud SQL instance.
update PUT /sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}
Updates a resource containing information about a database inside a Cloud SQL instance.

REST Resource: v1beta4.flags

Methods
list GET /sql/v1beta4/flags
List all available database flags for Cloud SQL instances.

REST Resource: v1beta4.instances

Methods
addServerCa POST /sql/v1beta4/projects/{project}/instances/{instance}/addServerCa
Add a new trusted Certificate Authority (CA) version for the specified instance.
clone POST /sql/v1beta4/projects/{project}/instances/{instance}/clone
Creates a Cloud SQL instance as a clone of the source instance.
delete DELETE /sql/v1beta4/projects/{project}/instances/{instance}
Deletes a Cloud SQL instance.
demoteMaster POST /sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
export POST /sql/v1beta4/projects/{project}/instances/{instance}/export
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
failover POST /sql/v1beta4/projects/{project}/instances/{instance}/failover
Failover the instance to its failover replica instance.
get GET /sql/v1beta4/projects/{project}/instances/{instance}
Retrieves a resource containing information about a Cloud SQL instance.
import POST /sql/v1beta4/projects/{project}/instances/{instance}/import
Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
insert POST /sql/v1beta4/projects/{project}/instances
Creates a new Cloud SQL instance.
list GET /sql/v1beta4/projects/{project}/instances
Lists instances under a given project.
listServerCas GET /sql/v1beta4/projects/{project}/instances/{instance}/listServerCas
Lists all of the trusted Certificate Authorities (CAs) for the specified instance.
patch PATCH /sql/v1beta4/projects/{project}/instances/{instance}
Updates settings of a Cloud SQL instance.
promoteReplica POST /sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica
Promotes the read replica instance to be a stand-alone Cloud SQL instance.
resetSslConfig POST /sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig
Deletes all client certificates and generates a new server SSL certificate for the instance.
restart POST /sql/v1beta4/projects/{project}/instances/{instance}/restart
Restarts a Cloud SQL instance.
restoreBackup POST /sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup
Restores a backup of a Cloud SQL instance.
rotateServerCa POST /sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
startReplica POST /sql/v1beta4/projects/{project}/instances/{instance}/startReplica
Starts the replication in the read replica instance.
stopReplica POST /sql/v1beta4/projects/{project}/instances/{instance}/stopReplica
Stops the replication in the read replica instance.
truncateLog POST /sql/v1beta4/projects/{project}/instances/{instance}/truncateLog
Truncate MySQL general and slow query log tables
update PUT /sql/v1beta4/projects/{project}/instances/{instance}
Updates settings of a Cloud SQL instance.

REST Resource: v1beta4.operations

Methods
get GET /sql/v1beta4/projects/{project}/operations/{operation}
Retrieves an instance operation that has been performed on an instance.
list GET /sql/v1beta4/projects/{project}/operations
Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

REST Resource: v1beta4.projects.instances

Methods
rescheduleMaintenance POST /sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance
Reschedules the maintenance on the given instance.
startExternalSync POST /sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync
Start External master migration.
verifyExternalSyncSettings POST /sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings
Verify External master external sync settings.

REST Resource: v1beta4.sslCerts

Methods
createEphemeral POST /sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance.
delete DELETE /sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}
Deletes the SSL certificate.
get GET /sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}
Retrieves a particular SSL certificate.
insert POST /sql/v1beta4/projects/{project}/instances/{instance}/sslCerts
Creates an SSL certificate and returns it along with the private key and server certificate authority.
list GET /sql/v1beta4/projects/{project}/instances/{instance}/sslCerts
Lists all of the current SSL certificates for the instance.

REST Resource: v1beta4.tiers

Methods
list GET /sql/v1beta4/projects/{project}/tiers
Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1.

REST Resource: v1beta4.users

Methods
delete DELETE /sql/v1beta4/projects/{project}/instances/{instance}/users
Deletes a user from a Cloud SQL instance.
insert POST /sql/v1beta4/projects/{project}/instances/{instance}/users
Creates a new user in a Cloud SQL instance.
list GET /sql/v1beta4/projects/{project}/instances/{instance}/users
Lists users in the specified Cloud SQL instance.
update PUT /sql/v1beta4/projects/{project}/instances/{instance}/users
Updates an existing user in a Cloud SQL instance.

Service: sqladmin.googleapis.com

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://sqladmin.googleapis.com

REST Resource: v1.flags

Methods
list GET /v1/flags
List all available database flags for Cloud SQL instances.

REST Resource: v1.projects.locations.instances

Methods
addServerCa POST /v1/{parent=projects/*/locations/*/instances/*}/addServerCa
Add a new trusted Certificate Authority (CA) version for the specified instance.
clone POST /v1/{parent=projects/*/locations/*/instances/*}/clone
Creates a Cloud SQL instance as a clone of the source instance.
create POST /v1/{parent=projects/*/locations/*}/instances
Creates a new Cloud SQL instance.
createEphemeral POST /v1/{parent=projects/*/locations/*/instances/*}/createEphemeral
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance.
delete DELETE /v1/{name=projects/*/locations/*/instances/*}
Deletes a Cloud SQL instance.
demoteMaster POST /v1/{parent=projects/*/locations/*/instances/*}/demoteMaster
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
export POST /v1/{parent=projects/*/locations/*/instances/*}/export
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
failover POST /v1/{parent=projects/*/locations/*/instances/*}/failover
Failover the instance to its failover replica instance.
get GET /v1/{name=projects/*/locations/*/instances/*}
Retrieves a resource containing information about a Cloud SQL instance.
import POST /v1/{parent=projects/*/locations/*/instances/*}/import
Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
list GET /v1/{parent=projects/*/locations/*}/instances
Lists instances under a given project.
listServerCas GET /v1/{parent=projects/*/locations/*/instances/*}/listServerCas
Lists all of the trusted Certificate Authorities (CAs) for the specified instance.
patch PATCH /v1/{name=projects/*/locations/*/instances/*}
Updates settings of a Cloud SQL instance.
promoteReplica POST /v1/{parent=projects/*/locations/*/instances/*}/promoteReplica
Promotes the read replica instance to be a stand-alone Cloud SQL instance.
rescheduleMaintenance POST /v1/{parent=projects/*/locations/*/instances/*}/rescheduleMaintenance
Reschedules the maintenance on the given instance.
resetSslConfig POST /v1/{parent=projects/*/locations/*/instances/*}/resetSslConfig
Deletes all client certificates and generates a new server SSL certificate for the instance.
restart POST /v1/{parent=projects/*/locations/*/instances/*}/restart
Restarts a Cloud SQL instance.
restoreBackup POST /v1/{parent=projects/*/locations/*/instances/*}/restoreBackup
Restores a backup of a Cloud SQL instance.
rotateServerCa POST /v1/{parent=projects/*/locations/*/instances/*}/rotateServerCa
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
startExternalSync POST /v1/{parent=projects/*/locations/*/instances/*}/startExternalSync
Start External master migration.
startReplica POST /v1/{parent=projects/*/locations/*/instances/*}/startReplica
Starts the replication in the read replica instance.
stopReplica POST /v1/{parent=projects/*/locations/*/instances/*}/stopReplica
Stops the replication in the read replica instance.
truncateLog POST /v1/{parent=projects/*/locations/*/instances/*}/truncateLog
Truncate MySQL general and slow query log tables
update PUT /v1/{name=projects/*/locations/*/instances/*}
Updates settings of a Cloud SQL instance.
verifyExternalSyncSettings POST /v1/{parent=projects/*/locations/*/instances/*}/verifyExternalSyncSettings
Verify External master external sync settings.

REST Resource: v1.projects.locations.instances.backupRuns

Methods
create POST /v1/{parent=projects/*/locations/*/instances/*}/backupRuns
Creates a new backup run on demand.
delete DELETE /v1/{name=projects/*/locations/*/instances/*/backupRuns/*}
Deletes the backup taken by a backup run.
get GET /v1/{name=projects/*/locations/*/instances/*/backupRuns/*}
Retrieves a resource containing information about a backup run.
list GET /v1/{parent=projects/*/locations/*/instances/*}/backupRuns
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

REST Resource: v1.projects.locations.instances.databases

Methods
create POST /v1/{parent=projects/*/locations/*/instances/*}/databases
Inserts a resource containing information about a database inside a Cloud SQL instance.
delete DELETE /v1/{name=projects/*/locations/*/instances/*/databases/*}
Deletes a database from a Cloud SQL instance.
get GET /v1/{name=projects/*/locations/*/instances/*/databases/*}
Retrieves a resource containing information about a database inside a Cloud SQL instance.
list GET /v1/{parent=projects/*/locations/*/instances/*}/databases
Lists databases in the specified Cloud SQL instance.
patch PATCH /v1/{name=projects/*/locations/*/instances/*/databases/*}
Partially updates a resource containing information about a database inside a Cloud SQL instance.
update PUT /v1/{name=projects/*/locations/*/instances/*/databases/*}
Updates a resource containing information about a database inside a Cloud SQL instance.

REST Resource: v1.projects.locations.instances.sslCerts

Methods
create POST /v1/{parent=projects/*/locations/*/instances/*}/sslCerts
Creates an SSL certificate and returns it along with the private key and server certificate authority.
delete DELETE /v1/{name=projects/*/locations/*/instances/*/sslCerts/*}
Deletes the SSL certificate.
get GET /v1/{name=projects/*/locations/*/instances/*/sslCerts/*}
Retrieves a particular SSL certificate.
list GET /v1/{parent=projects/*/locations/*/instances/*}/sslCerts
Lists all of the current SSL certificates for the instance.

REST Resource: v1.projects.locations.operations

Methods
get GET /v1/{name=projects/*/locations/*/operations/*}
Retrieves an instance operation that has been performed on an instance.
list GET /v1/{parent=projects/*/locations/*}/operations
Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

REST Resource: v1.projects.tiers

Methods
list GET /v1/{parent=projects/*}/tiers
Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1.