Skip to main content
POST
/
v1
/
instances:batchUpdate
cURL
curl --request POST \
  --url https://api.example.com/v1/instances:batchUpdate \
  --header 'Content-Type: application/json' \
  --data '
{
  "requests": [
    {
      "instance": {
        "name": "<string>",
        "state": "STATE_UNSPECIFIED",
        "title": "<string>",
        "engine": "ENGINE_UNSPECIFIED",
        "externalLink": "<string>",
        "dataSources": [
          {
            "id": "<string>",
            "type": "DATA_SOURCE_UNSPECIFIED",
            "username": "<string>",
            "password": "<string>",
            "useSsl": true,
            "sslCa": "<string>",
            "sslCert": "<string>",
            "sslKey": "<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>",
            "sshPrivateKey": "<string>",
            "authenticationPrivateKey": "<string>",
            "authenticationPrivateKeyPassphrase": "<string>",
            "externalSecret": {
              "secretType": "SECRET_TYPE_UNSPECIFIED",
              "url": "<string>",
              "authType": "AUTH_TYPE_UNSPECIFIED",
              "appRole": {
                "roleId": "<string>",
                "secretId": "<string>",
                "type": "SECRET_TYPE_UNSPECIFIED",
                "mountPath": "<string>"
              },
              "token": "<string>",
              "engineName": "<string>",
              "secretName": "<string>",
              "passwordKeyName": "<string>",
              "skipVaultTlsVerification": true,
              "vaultSslCa": "<string>",
              "vaultSslCert": "<string>",
              "vaultSslKey": "<string>"
            },
            "authenticationType": "AUTHENTICATION_UNSPECIFIED",
            "azureCredential": {
              "tenantId": "<string>",
              "clientId": "<string>",
              "clientSecret": "<string>"
            },
            "awsCredential": {
              "accessKeyId": "<string>",
              "secretAccessKey": "<string>",
              "sessionToken": "<string>",
              "roleArn": "<string>",
              "externalId": "<string>"
            },
            "gcpCredential": {
              "content": "<string>"
            },
            "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>",
            "redisType": "REDIS_TYPE_UNSPECIFIED",
            "cluster": "<string>",
            "extraConnectionParameters": {}
          }
        ],
        "environment": "<string>",
        "activation": true,
        "syncInterval": "<string>",
        "maximumConnections": 123,
        "syncDatabases": [
          "<string>"
        ],
        "labels": {}
      },
      "updateMask": "<string>",
      "allowMissing": true
    }
  ]
}
'
{
  "instances": [
    {
      "name": "<string>",
      "state": "STATE_UNSPECIFIED",
      "title": "<string>",
      "engine": "ENGINE_UNSPECIFIED",
      "engineVersion": "<string>",
      "externalLink": "<string>",
      "dataSources": [
        {
          "id": "<string>",
          "type": "DATA_SOURCE_UNSPECIFIED",
          "username": "<string>",
          "useSsl": true,
          "verifyTlsCertificate": true,
          "host": "<string>",
          "port": "<string>",
          "database": "<string>",
          "srv": true,
          "authenticationDatabase": "<string>",
          "replicaSet": "<string>",
          "sid": "<string>",
          "serviceName": "<string>",
          "sshHost": "<string>",
          "sshPort": "<string>",
          "sshUser": "<string>",
          "externalSecret": {
            "secretType": "SECRET_TYPE_UNSPECIFIED",
            "url": "<string>",
            "authType": "AUTH_TYPE_UNSPECIFIED",
            "appRole": {
              "type": "SECRET_TYPE_UNSPECIFIED",
              "mountPath": "<string>"
            },
            "engineName": "<string>",
            "secretName": "<string>",
            "passwordKeyName": "<string>",
            "skipVaultTlsVerification": true
          },
          "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>",
          "redisType": "REDIS_TYPE_UNSPECIFIED",
          "cluster": "<string>",
          "extraConnectionParameters": {}
        }
      ],
      "environment": "<string>",
      "activation": true,
      "roles": [
        {
          "name": "<string>",
          "roleName": "<string>",
          "connectionLimit": 123,
          "validUntil": "<string>",
          "attribute": "<string>"
        }
      ],
      "syncInterval": "<string>",
      "maximumConnections": 123,
      "syncDatabases": [
        "<string>"
      ],
      "lastSyncTime": "2023-11-07T05:31:56Z",
      "labels": {}
    }
  ]
}

Body

application/json
requests
object[]
required

The request message specifying the resources to update.

Response

OK

instances
object[]