Skip to main content
POST
/
v1
/
instances
/
{instance}
:sync
cURL
curl --request POST \
  --url https://api.example.com/v1/instances/{instance}:sync \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enableFullSync": true
}
'
{
  "databases": [
    "<string>"
  ]
}

Path Parameters

​
instance
string
required

The instance id.

Body

application/json
​
name
string
required

The name of instance. Format: instances/{instance}

​
enableFullSync
boolean

When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only the instance metadata (such as the database list) and any newly discovered databases will be synced.

Response

OK

​
databases
string[]

All database name list in the instance.