Cloud SQL Admin API (sqladmin:v1)

2026-08-28

5 new methods | 50 updated methods

Additions

    Methods

  • ▼ ▲ sql.blueGreenDeployments.switchover

      HTTP Method : POST

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

      Parameter Order : name

      Parameters :

        name

          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

          Location : path

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

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

      Scopes :

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

      • Path : v1/{+name}:switchover

  • ▼ ▲ sql.blueGreenDeployments.delete

      Scopes :

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

      • Parameter Order : name

      Path : v1/{+name}

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

      HTTP Method : DELETE

      Description : Deletes a blue-green deployment.

      Parameters :

        name

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

          Location : path

          Required : Yes

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

          Type : string

        deleteOldSource

          Type : boolean

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

          Location : query

  • ▼ ▲ sql.blueGreenDeployments.list

      HTTP Method : GET

      Scopes :

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

      • Parameter Order : parent

      Parameters :

        pageSize

          Type : integer

          Description : Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000.

          Location : query

          Format : int32

        orderBy

          Location : query

          Type : string

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

        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

        pageToken

          Location : query

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

          Type : string

        filter

          Type : string

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

          Location : query

      Path : v1/{+parent}/blueGreenDeployments

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments

  • ▼ ▲ sql.blueGreenDeployments.get

      Parameter Order : name

      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 retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}

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

          Location : path

          Required : Yes

        view

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

          Location : query

          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

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

      Path : v1/{+name}

      HTTP Method : GET

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

  • ▼ ▲ sql.blueGreenDeployments.create

      HTTP Method : POST

      Parameter Order : parent

      Path : v1/{+parent}/blueGreenDeployments

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

      Parameters :

        blueGreenDeploymentId

          Type : string

          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. The ID must be unique within the given project and location and between 2-63 characters.

        parent

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

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

          Required : Yes

          Type : string

          Location : path

      Scopes :

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

      • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments

Updates

    Methods

  • ▼ ▲ sql.databases.update

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.databases.patch

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.get

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.databases.list

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

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

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

  • ▼ ▲ sql.users.get

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.sslCerts.createEphemeral

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.projects.instances.rescheduleMaintenance

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.projects.instances.performDiskShrink

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.projects.instances.getLatestRecoveryTime

      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.instances.update

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.addEntraIdCertificate

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.addServerCa

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.import

      Parameters :

        location

          Location : query

          Type : string

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

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.truncateLog

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.restart

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.export

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.RotateEntraIdCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.reencrypt

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.startReplica

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.switchover

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

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.releaseSsrsLease

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.patch

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.listServerCas

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.demote

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.clone

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.RotateServerCertificate

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.list

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.rotateServerCa

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.get

      Parameters :

        location

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

  • ▼ ▲ sql.instances.acquireSsrsLease

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.ListEntraIdCertificates

      Parameters :

        location

          Type : string

          Location : query

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.preCheckMajorVersionUpgrade

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.ListServerCertificates

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.executeSql

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.delete

      Parameters :

        location

          Location : query

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

  • ▼ ▲ sql.instances.promoteReplica

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Type : string

          Location : query

  • ▼ ▲ sql.instances.resetSslConfig

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

  • ▼ ▲ sql.instances.addServerCertificate

      Parameters :

        location

          Description : Optional. Region of the Cloud SQL instance.

          Location : query

          Type : string

  • ▼ ▲ sql.instances.restoreBackup

      Parameters :

        location

          Type : string

          Description : Optional. Region of the Cloud SQL instance.

          Location : query