Skip to main content
GET
/
v1
/
instances
cURL
curl --request GET \
  --url https://api.example.com/v1/instances
{
  "instances": [
    {
      "title": "<string>",
      "engine": "ENGINE_UNSPECIFIED",
      "activation": true,
      "version": "<string>",
      "externalLink": "<string>",
      "dataSources": [
        {
          "id": "<string>",
          "type": "DATA_SOURCE_UNSPECIFIED",
          "username": "<string>",
          "password": "<string>",
          "obfuscatedPassword": "<string>",
          "useSsl": true,
          "sslCa": "<string>",
          "obfuscatedSslCa": "<string>",
          "sslCert": "<string>",
          "obfuscatedSslCert": "<string>",
          "sslKey": "<string>",
          "obfuscatedSslKey": "<string>",
          "verifyTlsCertificate": true,
          "host": "<string>",
          "port": "<string>",
          "database": "<string>",
          "srv": true,
          "authenticationDatabase": "<string>",
          "replicaSet": "<string>",
          "sid": "<string>",
          "serviceName": "<string>",
          "sshHost": "<string>",
          "sshPort": "<string>",
          "sshUser": "<string>",
          "sshPassword": "<string>",
          "obfuscatedSshPassword": "<string>",
          "sshPrivateKey": "<string>",
          "obfuscatedSshPrivateKey": "<string>",
          "authenticationPrivateKey": "<string>",
          "obfuscatedAuthenticationPrivateKey": "<string>",
          "authenticationPrivateKeyPassphrase": "<string>",
          "obfuscatedAuthenticationPrivateKeyPassphrase": "<string>",
          "externalSecret": {
            "secretType": "SECRET_TYPE_UNSPECIFIED",
            "url": "<string>",
            "authType": "AUTH_TYPE_UNSPECIFIED",
            "appRole": {
              "type": "SECRET_TYPE_UNSPECIFIED",
              "mountPath": "<string>"
            },
            "token": "<string>",
            "engineName": "<string>",
            "secretName": "<string>",
            "passwordKeyName": "<string>",
            "skipVaultTlsVerification": true,
            "vaultSslCa": "<string>",
            "obfuscatedVaultSslCa": "<string>",
            "vaultSslCert": "<string>",
            "obfuscatedVaultSslCert": "<string>",
            "vaultSslKey": "<string>",
            "obfuscatedVaultSslKey": "<string>"
          },
          "authenticationType": "AUTHENTICATION_UNSPECIFIED",
          "azureCredential": {
            "tenantId": "<string>",
            "clientId": "<string>"
          },
          "awsCredential": {},
          "gcpCredential": {},
          "saslConfig": {
            "krbConfig": {
              "primary": "<string>",
              "instance": "<string>",
              "realm": "<string>",
              "keytab": "<string>",
              "kdcHost": "<string>",
              "kdcPort": "<string>",
              "kdcTransportProtocol": "<string>"
            }
          },
          "additionalAddresses": [
            {
              "host": "<string>",
              "port": "<string>"
            }
          ],
          "directConnection": true,
          "region": "<string>",
          "warehouseId": "<string>",
          "masterName": "<string>",
          "masterUsername": "<string>",
          "masterPassword": "<string>",
          "obfuscatedMasterPassword": "<string>",
          "redisType": "REDIS_TYPE_UNSPECIFIED",
          "cluster": "<string>",
          "extraConnectionParameters": {}
        }
      ],
      "syncInterval": "<string>",
      "maximumConnections": 123,
      "syncDatabases": [
        "<string>"
      ],
      "mysqlLowerCaseTableNames": 123,
      "lastSyncTime": "2023-11-07T05:31:56Z",
      "roles": [
        {
          "name": "<string>",
          "connectionLimit": 123,
          "validUntil": "<string>",
          "attribute": "<string>"
        }
      ],
      "labels": {}
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer<int32>

The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 10 instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListInstances call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListInstances must match the call that provided the page token.

​
showDeleted
boolean

Show deleted instances if specified.

​
filter
string

Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • name: the instance name, support "==" and ".matches()" operator.
  • resource_id: the instance id, support "==" and ".matches()" operator.
  • environment: the environment full name in "environments/{id}" format, support "==" operator.
  • state: the instance state, check State enum for values, support "==" operator.
  • engine: the instance engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator.
  • host: the instance host, support "==" and ".matches()" operator.
  • port: the instance port, support "==" and ".matches()" operator.
  • project: the project full name in "projects/{id}" format, support "==" operator.
  • labels.{key}: the instance label, support "==" and "in" operators.

For example: name == "sample instance" name.matches("sample") resource_id == "sample-instance" resource_id.matches("sample") state == "DELETED" environment == "environments/test" environment == "" (find instances which environment is not set) engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) host == "127.0.0.1" host.matches("127.0") port == "54321" port.matches("543") labels.org_group == "infrastructure" labels.environment in ["prod", "production"] project == "projects/sample-project" You can combine filter conditions like: name.matches("sample") && environment == "environments/test" host == "127.0.0.1" && port == "54321"

Response

OK

​
instances
object[]

The instances from the specified request.

​
nextPageToken
string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.