Cloud SQL Admin API (sqladmin:v1beta4)

2026-08-29

5 new methods | 50 updated methods

Additions

    Methods

  • ▼ ▲ sql.blueGreenDeployments.get

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

      HTTP Method : GET

      Parameter Order : name

      Scopes :

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

      • 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`).

          • Enum :

        • BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED
        • BASIC
        • DETAILED

          • Type : string

          Location : query

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

        name

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

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

          Required : Yes

          Location : path

          Type : string

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

      Path : sql/v1beta4/{+name}

  • ▼ ▲ sql.blueGreenDeployments.create

      Parameters :

        parent

          Location : path

          Required : Yes

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

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

          Type : string

        blueGreenDeploymentId

          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

          Type : string

      HTTP Method : POST

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

      Scopes :

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

      • Parameter Order : parent

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

      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.

  • ▼ ▲ sql.blueGreenDeployments.delete

      Parameter Order : name

      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.

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

      Parameters :

        deleteOldSource

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

          Location : query

          Type : boolean

        name

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

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

          Type : string

          Required : Yes

          Location : path

      Path : sql/v1beta4/{+name}

      Scopes :

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

      • HTTP Method : DELETE

  • ▼ ▲ sql.blueGreenDeployments.switchover

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

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

      HTTP Method : POST

      Parameters :

        name

          Location : path

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

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

          Required : Yes

          Type : string

      Parameter Order : name

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

      Scopes :

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

  • ▼ ▲ sql.blueGreenDeployments.list

      Parameter Order : parent

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

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

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

      HTTP Method : GET

      Parameters :

        parent

          Required : Yes

          Location : path

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

          Type : string

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

        pageSize

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

          Format : int32

          Location : query

          Type : integer

        filter

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

          Location : query

          Type : string

        pageToken

          Location : query

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

          Type : string

        orderBy

          Type : string

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

          Location : query

      Scopes :

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

Updates

    Methods

  • ▼ ▲ sql.projects.instances.rescheduleMaintenance

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          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

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.projects.instances.performDiskShrink

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.sslCerts.createEphemeral

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.databases.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.databases.patch

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.update

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.delete

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.databases.insert

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.list

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.switchover

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.addServerCa

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.import

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.acquireSsrsLease

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.RotateServerCertificate

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.restart

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.addServerCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.promoteReplica

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.update

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.addEntraIdCertificate

      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.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.list

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.stopReplica

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.truncateLog

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.reencrypt

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.ListServerCertificates

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.resetSslConfig

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.insert

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.ListEntraIdCertificates

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.executeSql

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.demote

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.restoreBackup

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.listServerCas

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.startReplica

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.failover

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.RotateEntraIdCertificate

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.demoteMaster

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.clone

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.delete

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.export

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.rotateServerCa

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.releaseSsrsLease

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.patch

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.preCheckMajorVersionUpgrade

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.users.update

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.users.list

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.users.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.users.delete

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.users.insert

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query