Native cohort restores use the existing asynchronous restore job to provision hidden fresh generations, import rows, rebuild indexes and coordinated constraints, and publish the dependency-complete target set atomically. Document, relational, and mixed native cohorts use the same workflow (at most 128 tables/4096 ranges). Skipping a live parent cannot substitute it for a parent generation required by a restored child. Overwrite retains the old generation until validation and cutover; cancellation after publication completes publication rather than rollback. Reserved destination authorization is immutable: changing principal requires canceling the old job and creating a new restore.
Required configured `external_io` connection with the `restore.read` capability.
table_names
array
Optional list of tables to restore. If omitted, all tables in the backup are restored, up to the cluster restore limit of 4096 tables. Larger backups must be restored in explicit batches of at most 25
restore_mode
string
How to handle existing tables: - `fail_if_exists`: Abort if any table already exists (default) - `skip_if_exists`: Skip existing tables, restore others - `overwrite`: Atomically replace existing table
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/antfly/json-schema/antfly-cluster-restore-request-schema.json",
"title": "ClusterRestoreRequest",
"description": "Native cohort restores use the existing asynchronous restore job to provision\nhidden fresh generations, import rows, rebuild indexes and coordinated constraints,\nand publish the dependency-complete target set atomically. Document, relational,\nand mixed native cohorts use the same workflow (at most 128 tables/4096 ranges).\nSkipping a live parent cannot substitute it for a parent generation required by\na restored child. Overwrite retains the old generation until validation and\ncutover; cancellation after publication completes publication rather than rollback.\nReserved destination authorization is immutable: changing principal requires\ncanceling the old job and creating a new restore.\n",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/antfly-cluster-management-api-openapi.yml#/components/schemas/ClusterRestoreRequest",
"type": "object",
"additionalProperties": false,
"required": [
"backup_id",
"location",
"connection"
],
"properties": {
"backup_id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$",
"description": "Unique identifier of the backup to restore from.\n"
},
"location": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Storage location where the backup is stored.\n"
},
"connection": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Required configured `external_io` connection with the `restore.read` capability."
},
"table_names": {
"type": "array",
"maxItems": 256,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"description": "Optional list of tables to restore. If omitted, all tables in the backup are restored,\nup to the cluster restore limit of 4096 tables. Larger backups must be restored\nin explicit batches of at most 256 tables.\n"
},
"restore_mode": {
"type": "string",
"enum": [
"fail_if_exists",
"skip_if_exists",
"overwrite"
],
"default": "fail_if_exists",
"description": "How to handle existing tables:\n- `fail_if_exists`: Abort if any table already exists (default)\n- `skip_if_exists`: Skip existing tables, restore others\n- `overwrite`: Atomically replace existing table generations after staging and validation\n"
}
}
}
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.