Cloud SQL Admin API (sqladmin:v1beta4)

2026-08-30

5 new methods | 50 updated methods

Additions

    Methods

  • ▼ ▲ sql.blueGreenDeployments.create

      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.

      Scopes :

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

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

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

      Parameters :

        parent

          Required : Yes

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

          Location : path

          Type : string

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

        blueGreenDeploymentId

          Location : query

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

          Type : string

      Parameter Order : parent

      HTTP Method : POST

  • ▼ ▲ sql.blueGreenDeployments.get

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

      Path : sql/v1beta4/{+name}

      Scopes :

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

      • Parameters :

        name

          Required : Yes

          Location : path

          Type : string

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

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

        view

          Location : query

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

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

          • Type : string

          Enum :

        • BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED
        • BASIC
        • DETAILED

      HTTP Method : GET

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

      Parameter Order : name

  • ▼ ▲ sql.blueGreenDeployments.list

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

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        parent

          Type : string

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

          Location : path

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

          Required : Yes

        orderBy

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

          Location : query

          Type : string

        pageToken

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

          Type : string

          Location : query

        filter

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

          Type : string

          Location : query

        pageSize

          Location : query

          Type : integer

          Format : int32

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

      Scopes :

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

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

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

  • ▼ ▲ sql.blueGreenDeployments.switchover

      Scopes :

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

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

      HTTP Method : POST

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

      Parameters :

        name

          Required : Yes

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

          Location : path

          Type : string

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

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

      Parameter Order : name

  • ▼ ▲ sql.blueGreenDeployments.delete

      Path : sql/v1beta4/{+name}

      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

          Location : path

          Type : string

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

          Required : Yes

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

      HTTP Method : DELETE

      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}

      Parameter Order : name

      Scopes :

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

Updates

    Methods

  • ▼ ▲ sql.instances.export

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.RotateEntraIdCertificate

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.addEntraIdCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.promoteReplica

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.delete

      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.ListEntraIdCertificates

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.acquireSsrsLease

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.stopReplica

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.addServerCertificate

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.resetSslConfig

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.releaseSsrsLease

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.startReplica

      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.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.ListServerCertificates

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.preCheckMajorVersionUpgrade

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.failover

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.demoteMaster

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.RotateServerCertificate

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.truncateLog

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.restoreBackup

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.reencrypt

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.update

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.restart

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.list

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.rotateServerCa

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.clone

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.demote

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.patch

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.import

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.listServerCas

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.insert

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.executeSql

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ 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

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.projects.instances.getLatestRecoveryTime

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.projects.instances.performDiskShrink

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.sslCerts.createEphemeral

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.users.delete

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ 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.

          Location : query

          Type : string

  • ▼ ▲ sql.users.update

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.users.insert

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.get

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.delete

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.databases.patch

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.databases.update

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.databases.insert

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.databases.list

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string