Cloud SQL Admin API (sqladmin:v1beta4)

2026-08-31

5 new methods | 50 updated methods

Additions

    Methods

  • ▼ ▲ sql.blueGreenDeployments.switchover

      Path : sql/v1beta4/{+name}:switchover

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • Parameters :

        name

          Description : Required. The name of the blue-green deployment to switch over. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$

          Location : path

      Parameter Order : name

      Flat Path : sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}:switchover

      Description : Switches over to green instance for a blue-green deployment.

  • ▼ ▲ sql.blueGreenDeployments.create

      Flat Path : sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • Parameters :

        blueGreenDeploymentId

          Type : string

          Description : Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name.

          Location : query

        parent

          Type : string

          Description : Required. The parent resource where this blue-green deployment will be created. Format: projects/{project}/locations/{location}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

      Description : Creates a blue-green deployment under a given project and location. This deployment provisions a synchronized green environment (target instance) from a blue production environment (source instance), facilitating updates like major version upgrades on the green instance without impacting the blue instance.

      HTTP Method : POST

      Parameter Order : parent

      Path : sql/v1beta4/{+parent}/blueGreenDeployments

  • ▼ ▲ sql.blueGreenDeployments.delete

      Flat Path : sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}

      Description : Deletes a blue-green deployment, including metadata and underlying resources based on the deployment state. If issued before switchover, this deletes the green instance. If issued after switchover, this deletes the old blue instance (source instance) if the `delete_old_source` field in the request is set to true. All blue-green deployment metadata is permanently deleted. Resources deleted as a result of this operation are no longer accessible and can't be restored.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • Parameters :

        name

          Type : string

          Description : Required. The name of the blue-green deployment to delete. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$

          Location : path

        deleteOldSource

          Description : Optional. If set to true, and the switchover is complete, this deletes the old source instance along with the deployment.

          Type : boolean

          Location : query

      HTTP Method : DELETE

      Parameter Order : name

      Path : sql/v1beta4/{+name}

  • ▼ ▲ sql.blueGreenDeployments.get

      Description : Retrieves a blue-green deployment resource under a given project and location.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • Flat Path : sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}

      HTTP Method : GET

      Path : sql/v1beta4/{+name}

      Parameter Order : name

      Parameters :

        view

          Enum Descriptions :

        • Blue-green deployment view enumeration. This allows the caller to specify what view they query. If unspecified (BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED), the behavior is the same as BASIC.
        • Includes basic metadata about the blue-green deployment. `BASIC` is the default view.
        • Includes basic metadata and configuration differences between source and target instances (`database_version`, `tier`, `edition`, `availability_type`, `data_disk_size_gb`, and `data_disk_type`).

          • Location : query

          Type : string

          Description : Optional. Specifies whether to return the basic or detailed view of the resource in the response.

          Enum :

        • BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED
        • BASIC
        • DETAILED

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$

          Description : Required. The name of the blue-green deployment to retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}

          Type : string

          Required : Yes

  • ▼ ▲ sql.blueGreenDeployments.list

      Path : sql/v1beta4/{+parent}/blueGreenDeployments

      Flat Path : sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/sqlservice.admin

      • HTTP Method : GET

      Description : Lists blue-green deployments under a given project.

      Parameters :

        parent

          Type : string

          Description : Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

        pageToken

          Description : Optional. A page token, received from a previous `ListBlueGreenDeployments` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

        orderBy

          Description : Optional. A comma-separated list of fields to order the results by.

          Location : query

          Type : string

        filter

          Type : string

          Description : Optional. A filter expression that filters the results.

          Location : query

        pageSize

          Format : int32

          Description : Optional. The maximum number of deployments to return.

          Location : query

          Type : integer

      Parameter Order : parent

Updates

    Methods

  • ▼ ▲ sql.instances.listServerCas

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.RotateEntraIdCertificate

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.RotateServerCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.rotateServerCa

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.import

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.startReplica

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.addEntraIdCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.patch

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.ListServerCertificates

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.demote

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.reencrypt

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.failover

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.restoreBackup

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.clone

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.restart

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.preCheckMajorVersionUpgrade

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.list

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.delete

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.stopReplica

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.truncateLog

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.switchover

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.addServerCa

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.demoteMaster

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.export

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.resetSslConfig

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.releaseSsrsLease

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.update

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.promoteReplica

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.acquireSsrsLease

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.executeSql

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.addServerCertificate

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.ListEntraIdCertificates

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.insert

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.sslCerts.createEphemeral

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.projects.instances.getDiskShrinkConfig

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.projects.instances.getLatestRecoveryTime

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.projects.instances.rescheduleMaintenance

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.projects.instances.performDiskShrink

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.databases.update

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.databases.list

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.patch

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.databases.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.databases.delete

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.databases.insert

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.users.list

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.users.get

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.users.update

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.users.delete

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.users.insert

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.