Database Management API

The Database Management APIs let you list, inspect, back up (snapshot), clone, restore, and operate databases and database clones in XLServer.

Conventions

Replace <server> with your XLServer host/IP and <token> with a valid bearer token.

Unless stated otherwise, write operations are asynchronous and typically return:

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}

List All Databases

Endpoint

GET /xls-server/database/list

Description

Returns all databases known to XLServer (live and clones).

Request Example

curl -k -X GET https://<server>:8443/xls-server/database/list
-H "Authorization: Bearer <token>"

Get Database

Endpoint

GET /xls-server/database/{id}

Description

Fetch a single database by its identifier.

Path Parameters

Parameter Type Description id string Database identifier (e.g., ORACLE_LIVE_DATABASE-229)

Request Example

curl -k -X GET https://<server>:8443/xls-server/database/ORACLE_LIVE_DATABASE-229
-H "Authorization: Bearer <token>"

Snapshot Database

Endpoint

PUT /xls-server/database/sync

Description

Takes an incremental backup and creates a new snapshot for the specified live database.

Request Body (JSON)

{"database":"ORACLE_LIVE_DATABASE-229"}

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/sync
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{"database":"ORACLE_LIVE_DATABASE-229"}'

Backup Database Logs (e.g., Oracle archivelogs)

Endpoint

PUT /xls-server/database/sync

Description

Backs up only the database logs.

Request Body (JSON)

{
"database":"ORACLE_LIVE_DATABASE-229",
"syncType":"LOG"
}

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/sync
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{"database":"ORACLE_LIVE_DATABASE-229","syncType":"LOG"}'

Refresh Database

Endpoint

PUT /xls-server/database/refresh

Description

Refreshes database metadata from the source host.

Request Body (text/plain)

"ORACLE_LIVE_DATABASE-229"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/refresh
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d 'ORACLE_LIVE_DATABASE-229'

Clone Management

XLServer supports:

Virtual clones: Created instantly from snapshots without copying data.

Physical clones: Full, block-level copies to the target environment.

If you omit snapshot in payloads, the latest snapshot is used.

Create Oracle Virtual Database Clone

Endpoint

POST /xls-server/database/clone/create

Description

Creates an Oracle virtual clone from a snapshot.

Request Body (JSON – example)

{
"vendor":"ORACLE",
"cloneType":"VIRTUALCLONE",
"databaseName":"TEST",
"mountBase":"/mnt/dup",
"snapshot":"ORACLE_SNAPSHOT-173",
"environmentUser":"ENVIRONMENT_USER-57",
"install":"ORACLE_INSTALL-24",
"sourceDatabase":"ORACLE_LIVE_DATABASE-229",
"targetEnvironment":"HOST_ENVIRONMENT-30",
"project":"PROJECT-14",
"databaseParams":[
{"name":"compatible","type":"STRING","value":"19.0.0"},
{"name":"open_cursors","type":"NUMBER","value":300}
],
"rmanChannel":2,
"dbUniqueName":"TEST",
"instanceName":"TEST",
"specificPostScriptPath":"/opt/scripts/change-db-user-password.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"ORACLE",
"cloneType":"VIRTUALCLONE",
"databaseName":"TEST",
"mountBase":"/mnt/dup",
"snapshot":"ORACLE_SNAPSHOT-173",
"environmentUser":"ENVIRONMENT_USER-57",
"install":"ORACLE_INSTALL-24",
"sourceDatabase":"ORACLE_LIVE_DATABASE-229",
"targetEnvironment":"HOST_ENVIRONMENT-30",
"project":"PROJECT-14",
"databaseParams":[
{"name":"compatible","type":"STRING","value":"19.0.0"},
{"name":"open_cursors","type":"NUMBER","value":300}
],
"rmanChannel":2,
"dbUniqueName":"TEST",
"instanceName":"TEST",
"specificPostScriptPath":"/opt/scripts/change-db-user-password.sql"
}'

Create MySQL Virtual Database Server Clone

Endpoint

POST /xls-server/database/clone/create

Description

Creates a MySQL virtual server clone from a snapshot.

Request Body (JSON – example)

{
"vendor":"MYSQL",
"cloneType":"VIRTUALCLONE",
"mountBase":"/mnt/clone",
"snapshot":"MYSQL_SNAPSHOT-42",
"environmentUser":"ENVIRONMENT_USER-48",
"install":"MYSQL_INSTALL-9",
"sourceDatabase":"MYSQL_LIVE_SERVER-51",
"targetEnvironment":"HOST_ENVIRONMENT-23",
"project":"PROJECT-15",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"utf8mb4"},
{"name":"collation_server","type":"STRING","value":"utf8mb4_0900_ai_ci"}
],
"parallel":2,
"port":3307,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"MYSQL",
"cloneType":"VIRTUALCLONE",
"mountBase":"/mnt/clone",
"snapshot":"MYSQL_SNAPSHOT-42",
"environmentUser":"ENVIRONMENT_USER-48",
"install":"MYSQL_INSTALL-9",
"sourceDatabase":"MYSQL_LIVE_SERVER-51",
"targetEnvironment":"HOST_ENVIRONMENT-23",
"project":"PROJECT-15",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"utf8mb4"},
{"name":"collation_server","type":"STRING","value":"utf8mb4_0900_ai_ci"}
],
"parallel":2,
"port":3307,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}'

Create MariaDB Virtual Database Server Clone

Endpoint

POST /xls-server/database/clone/create

Description

Creates a MariaDB virtual server clone from a snapshot.

Request Body (JSON – example)

{
"vendor":"MARIADB",
"cloneType":"VIRTUALCLONE",
"mountBase":"/mnt/clone",
"snapshot":"MARIADB_SNAPSHOT-37",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"MARIADB_INSTALL-4",
"sourceDatabase":"MARIADB_LIVE_SERVER-39",
"targetEnvironment":"HOST_ENVIRONMENT-27",
"project":"PROJECT-59",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"latin1"},
{"name":"default_storage_engine","type":"STRING","value":"InnoDB"}
],
"parallel":2,
"port":3307,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"MARIADB",
"cloneType":"VIRTUALCLONE",
"mountBase":"/mnt/clone",
"snapshot":"MARIADB_SNAPSHOT-37",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"MARIADB_INSTALL-4",
"sourceDatabase":"MARIADB_LIVE_SERVER-39",
"targetEnvironment":"HOST_ENVIRONMENT-27",
"project":"PROJECT-59",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"latin1"},
{"name":"default_storage_engine","type":"STRING","value":"InnoDB"}
],
"parallel":2,
"port":3307,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}'

Create Oracle Physical Database Clone

Endpoint

POST /xls-server/database/duplicate/create

Description

Creates an Oracle physical clone (full copy) from a snapshot.

Request Body (JSON – example)

{
"vendor":"ORACLE",
"cloneType":"PHYSICAL",
"databaseName":"TEST",
"mountBase":"/mnt/dup",
"snapshot":"ORACLE_SNAPSHOT-173",
"environmentUser":"ENVIRONMENT_USER-57",
"install":"ORACLE_INSTALL-24",
"sourceDatabase":"ORACLE_LIVE_DATABASE-229",
"targetEnvironment":"HOST_ENVIRONMENT-30",
"project":"PROJECT-14",
"databaseParams":[
{"name":"compatible","type":"STRING","value":"19.0.0"},
{"name":"enable_pluggable_database","type":"BOOLEAN","value":"true"}
],
"rmanChannel":2,
"dbUniqueName":"TEST",
"instanceName":"TEST",
"specificPostScriptPath":"/opt/scripts/change-db-user-password.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/duplicate/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"ORACLE",
"cloneType":"PHYSICAL",
"databaseName":"TEST",
"mountBase":"/mnt/dup",
"snapshot":"ORACLE_SNAPSHOT-173",
"environmentUser":"ENVIRONMENT_USER-57",
"install":"ORACLE_INSTALL-24",
"sourceDatabase":"ORACLE_LIVE_DATABASE-229",
"targetEnvironment":"HOST_ENVIRONMENT-30",
"project":"PROJECT-14",
"databaseParams":[
{"name":"compatible","type":"STRING","value":"19.0.0"},
{"name":"enable_pluggable_database","type":"BOOLEAN","value":"true"}
],
"rmanChannel":2,
"dbUniqueName":"TEST",
"instanceName":"TEST",
"specificPostScriptPath":"/opt/scripts/change-db-user-password.sql"
}'

Create MySQL Physical Database Server Clone

Endpoint

POST /xls-server/database/duplicate/create

Description

Creates a MySQL physical server clone (full copy).

Request Body (JSON – example)

{
"vendor":"MYSQL",
"cloneType":"PHYSICAL",
"mountBase":"/mnt/dup",
"environmentUser":"ENVIRONMENT_USER-48",
"install":"MYSQL_INSTALL-9",
"sourceDatabase":"MYSQL_LIVE_SERVER-51",
"targetEnvironment":"HOST_ENVIRONMENT-23",
"project":"PROJECT-15",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"utf8mb4"},
{"name":"collation_server","type":"STRING","value":"utf8mb4_0900_ai_ci"}
],
"parallel":2,
"port":3308,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/duplicate/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"MYSQL",
"cloneType":"PHYSICAL",
"mountBase":"/mnt/dup",
"environmentUser":"ENVIRONMENT_USER-48",
"install":"MYSQL_INSTALL-9",
"sourceDatabase":"MYSQL_LIVE_SERVER-51",
"targetEnvironment":"HOST_ENVIRONMENT-23",
"project":"PROJECT-15",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"utf8mb4"},
{"name":"collation_server","type":"STRING","value":"utf8mb4_0900_ai_ci"}
],
"parallel":2,
"port":3308,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}'

Create MariaDB Physical Database Server Clone

Endpoint

POST /xls-server/database/duplicate/create

Description

Creates a MariaDB physical server clone (full copy).

Request Body (JSON – example)

{
"vendor":"MARIADB",
"cloneType":"PHYSICAL",
"mountBase":"/mnt/dup",
"snapshot":"MARIADB_SNAPSHOT-37",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"MARIADB_INSTALL-4",
"sourceDatabase":"MARIADB_LIVE_SERVER-39",
"targetEnvironment":"HOST_ENVIRONMENT-27",
"project":"PROJECT-59",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"latin1"},
{"name":"default_storage_engine","type":"STRING","value":"InnoDB"}
],
"parallel":2,
"port":3308,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/duplicate/create
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"vendor":"MARIADB",
"cloneType":"PHYSICAL",
"mountBase":"/mnt/dup",
"snapshot":"MARIADB_SNAPSHOT-37",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"MARIADB_INSTALL-4",
"sourceDatabase":"MARIADB_LIVE_SERVER-39",
"targetEnvironment":"HOST_ENVIRONMENT-27",
"project":"PROJECT-59",
"databaseParams":[
{"name":"character_set_server","type":"STRING","value":"latin1"},
{"name":"default_storage_engine","type":"STRING","value":"InnoDB"}
],
"parallel":2,
"port":3308,
"specificPostScriptPath":"/tmp/specific_post_script.sql"
}'

Mount Snapshot (Latest or Specific)

Endpoint

POST /xls-server/database/snapshot/mount

Description

Mounts a snapshot on the source environment as a staging clone.

Request Body (JSON – latest)

{"database":"ORACLE_LIVE_DATABASE-229"}

Request Body (JSON – specific)

{"database":"ORACLE_LIVE_DATABASE-229","snapshot":"ORACLE_SNAPSHOT-42"}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/snapshot/mount
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{"database":"ORACLE_LIVE_DATABASE-229"}'

Restore / Recovery

Add "snapshot":"<SNAPSHOT-ID>" to do PITR to a specific snapshot; omit it to use the latest snapshot.

Restore Oracle – Full Database

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"ORACLE_DATABASE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":true
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"ORACLE_DATABASE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":true
}'

Restore Oracle – Pluggable Database (PDB)

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"ORACLE_PLUGGABLE_DATABASE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"pdb":"PDB191"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"ORACLE_PLUGGABLE_DATABASE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"pdb":"PDB191"
}'

Restore Oracle – Tablespace

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"ORACLE_TABLESPACE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"tablespaceName":"USERS",
"pdb":"PDB191"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"ORACLE_TABLESPACE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"tablespaceName":"USERS",
"pdb":"PDB191"
}'

Restore Oracle – Datafile (by file id)

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"ORACLE_DATAFILE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"pdb":"PDB191",
"datafileName":11
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"ORACLE_DATAFILE_RECOVERY_PARAMS",
"database":"ORACLE_LIVE_DATABASE-229",
"autoRecovery":true,
"completeRecovery":true,
"fastRecovery":false,
"pdb":"PDB191",
"datafileName":11
}'

Restore MySQL – Full Server

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MYSQL_SERVER_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MYSQL_SERVER_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true
}'

Restore MySQL – Single Database

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MYSQL_DATABASE_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true,
"databaseName":"ecommerce"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MYSQL_DATABASE_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true,
"databaseName":"ecommerce"
}'

Restore MySQL – Table

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MYSQL_TABLE_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true,
"databaseName":"ecommerce",
"tableName":"ecommerce_user_sales"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MYSQL_TABLE_RECOVERY_PARAMS",
"database":"MYSQL_LIVE_SERVER-51",
"autoRecovery":true,
"databaseName":"ecommerce",
"tableName":"ecommerce_user_sales"
}'

Restore MariaDB – Full Server

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MARIADB_SERVER_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MARIADB_SERVER_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true
}'

Restore MariaDB – Single Database

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MARIADB_DATABASE_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true,
"databaseName":"ecommerce"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MARIADB_DATABASE_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true,
"databaseName":"ecommerce"
}'

Restore MariaDB – Table

Endpoint

POST /xls-server/database/restore

Request Body (JSON – example)

{
"objectType":"MARIADB_TABLE_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true,
"databaseName":"ecommerce",
"tableName":"ecommerce_user_sales"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/restore
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{
"objectType":"MARIADB_TABLE_RECOVERY_PARAMS",
"database":"MARIADB_LIVE_SERVER-39",
"autoRecovery":true,
"databaseName":"ecommerce",
"tableName":"ecommerce_user_sales"
}'

Lifecycle Operations (Live DB)

Disable Database

Endpoint

PUT /xls-server/database/disable

Request Body (text/plain)

"ORACLE_LIVE_DATABASE-229"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/disable
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d 'ORACLE_LIVE_DATABASE-229'

Enable Database

Endpoint

PUT /xls-server/database/enable

Request Body (text/plain)

"ORACLE_LIVE_DATABASE-229"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/enable
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d 'ORACLE_LIVE_DATABASE-229'

Delete Database

Endpoint

DELETE /xls-server/database/delete?input={id}

Description

Deletes a database object from XLServer (must have no dependent clones).

Query Parameters

Parameter	Type	Description
`input`	string	Database id (e.g., ORACLE_LIVE_DATABASE-229)

Request Example

curl -k -X DELETE "https://<server>:8443/xls-server/database/delete?input=ORACLE_LIVE_DATABASE-229"
-H "Authorization: Bearer <token>"

Delete Database Snapshot

Endpoint

PUT /xls-server/snapshot/delete?input={snapshot-id}

Description

Deletes a snapshot (not allowed if referenced by clones or if it’s the last snapshot).

Query Parameters

Parameter	Type	Description
`input`	string	Snapshot id (e.g., ORACLE_SNAPSHOT-173)

Request Example

curl -f -k -X PUT "https://<server>:8443/xls-server/snapshot/delete?input=ORACLE_SNAPSHOT-173"
-H "Authorization: Bearer <token>"

Virtual Clone Operations

Stop Virtual Database Clone

Endpoint

PUT /xls-server/database/stop

Request Body (text/plain)

"MYSQL_CLONE_SERVER-53"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/stop
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d 'MYSQL_CLONE_SERVER-53'

Start Virtual Database Clone

Endpoint

PUT /xls-server/database/start

Request Body (text/plain)

"MYSQL_CLONE_SERVER-53"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/start
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d 'MYSQL_CLONE_SERVER-53'

Reset Virtual Database Clone

Endpoint

PUT /xls-server/database/reset

Request Body (text/plain)

"MYSQL_CLONE_SERVER-53"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/database/reset
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d 'MYSQL_CLONE_SERVER-53'

Endpoint

POST /xls-server/database/clone/share

Request Body (JSON – example)

{
"vendor":"ORACLE",
"databaseName":"TEST2",
"mountBase":"/mnt/clone3",
"sourceDatabase":"ORACLE_CLONE_DATABASE-62",
"environment":"HOST_ENVIRONMENT-27",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"ORACLE_INSTALL-4",
"project":"PROJECT-56",
"dbUniqueName":"TEST2",
"instanceName":"TEST2",
"rmanChannel":2
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/share
-H "Content-Type: application/json"
-H "Authorization: Bearer <token>"
-d '{"vendor":"ORACLE","databaseName":"TEST2","mountBase":"/mnt/clone3","sourceDatabase":"ORACLE_CLONE_DATABASE-62","environment":"HOST_ENVIRONMENT-27","environmentUser":"ENVIRONMENT_USER-52","install":"ORACLE_INSTALL-4","project":"PROJECT-56","dbUniqueName":"TEST2","instanceName":"TEST2","rmanChannel":2}'

Endpoint

POST /xls-server/database/clone/share

Request Body (JSON – example)

{
"vendor":"MYSQL",
"mountBase":"/mnt/clone3",
"sourceDatabase":"MYSQL_CLONE_SERVER-53",
"environment":"HOST_ENVIRONMENT-26",
"environmentUser":"ENVIRONMENT_USER-51",
"install":"MYSQL_INSTALL-10",
"project":"PROJECT-15",
"port":3309,
"parallel":2
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/share
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d '{"vendor":"MYSQL","mountBase":"/mnt/clone3","sourceDatabase":"MYSQL_CLONE_SERVER-53","environment":"HOST_ENVIRONMENT-26","environmentUser":"ENVIRONMENT_USER-51","install":"MYSQL_INSTALL-10","project":"PROJECT-15","port":3309,"parallel":2}'

Endpoint

POST /xls-server/database/clone/share

Request Body (JSON – example)

{
"vendor":"MARIADB",
"mountBase":"/mnt/clone3",
"sourceDatabase":"MARIADB_CLONE_SERVER-41",
"environment":"HOST_ENVIRONMENT-27",
"environmentUser":"ENVIRONMENT_USER-52",
"install":"MARIADB_INSTALL-4",
"project":"PROJECT-59",
"port":3308,
"parallel":2
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/share
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d '{"vendor":"MARIADB","mountBase":"/mnt/clone3","sourceDatabase":"MARIADB_CLONE_SERVER-41","environment":"HOST_ENVIRONMENT-27","environmentUser":"ENVIRONMENT_USER-52","install":"MARIADB_INSTALL-4","project":"PROJECT-59","port":3308,"parallel":2}'

Convert Virtual Clone to Physical

Convert Oracle Virtual Clone to Physical

Endpoint

POST /xls-server/database/clone/switch

Request Body (JSON – example)

{
"database":"ORACLE_CLONE_SERVER-62",
"localDirectory":"/mnt/dup",
"dbFileNameConvert":"/mnt/dup",
"logFileNameConvert":"/mnt/dup"
}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/switch
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d '{"database":"ORACLE_CLONE_SERVER-62","localDirectory":"/mnt/dup","dbFileNameConvert":"/mnt/dup","logFileNameConvert":"/mnt/dup"}'

Convert MySQL Virtual Clone to Physical

Endpoint

POST /xls-server/database/clone/switch

Request Body (JSON – example)

{"database":"MYSQL_CLONE_SERVER-53","localDirectory":"/mnt/dup"}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/switch
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d '{"database":"MYSQL_CLONE_SERVER-53","localDirectory":"/mnt/dup"}'

Convert MariaDB Virtual Clone to Physical

Endpoint

POST /xls-server/database/clone/switch

Request Body (JSON – example)

{"database":"MARIADB_CLONE_SERVER-41","localDirectory":"/mnt/dup"}

Request Example

curl -k -X POST https://<server>:8443/xls-server/database/clone/switch
-H "Content-Type: application/json"
-H "Authorization: Bearer <token)"
-d '{"database":"MARIADB_CLONE_SERVER-41","localDirectory":"/mnt/dup"}'

Asynchronous Response (typical for PUT/POST/DELETE)

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}

List All Databases​

Get Database​

Snapshot Database​

Backup Database Logs (e.g., Oracle archivelogs)​

Refresh Database​

Clone Management​

Create Oracle Virtual Database Clone​

Create MySQL Virtual Database Server Clone​

Create MariaDB Virtual Database Server Clone​

Create Oracle Physical Database Clone​

Create MySQL Physical Database Server Clone​

Create MariaDB Physical Database Server Clone​

Mount Snapshot (Latest or Specific)​

Restore / Recovery​

Restore Oracle – Full Database​

Restore Oracle – Pluggable Database (PDB)​

Restore Oracle – Tablespace​

Restore Oracle – Datafile (by file id)​

Restore MySQL – Full Server​

Restore MySQL – Single Database​

Restore MySQL – Table​

Restore MariaDB – Full Server​

Restore MariaDB – Single Database​

Restore MariaDB – Table​

Lifecycle Operations (Live DB)​

Disable Database​

Enable Database​

Delete Database​

Delete Database Snapshot​

Virtual Clone Operations​

Stop Virtual Database Clone​

Start Virtual Database Clone​

Reset Virtual Database Clone​

Share Virtual Clone​

Share Oracle Virtual Database Clone​

Share MySQL Virtual Database Server Clone​

Share MariaDB Virtual Database Server Clone​

Convert Virtual Clone to Physical​

Convert Oracle Virtual Clone to Physical​

Convert MySQL Virtual Clone to Physical​

Convert MariaDB Virtual Clone to Physical​

List All Databases

Get Database

Snapshot Database

Backup Database Logs (e.g., Oracle archivelogs)

Refresh Database

Clone Management

Create Oracle Virtual Database Clone

Create MySQL Virtual Database Server Clone

Create MariaDB Virtual Database Server Clone

Create Oracle Physical Database Clone

Create MySQL Physical Database Server Clone

Create MariaDB Physical Database Server Clone

Mount Snapshot (Latest or Specific)

Restore / Recovery

Restore Oracle – Full Database

Restore Oracle – Pluggable Database (PDB)

Restore Oracle – Tablespace

Restore Oracle – Datafile (by file id)

Restore MySQL – Full Server

Restore MySQL – Single Database

Restore MySQL – Table

Restore MariaDB – Full Server

Restore MariaDB – Single Database

Restore MariaDB – Table

Lifecycle Operations (Live DB)

Disable Database

Enable Database

Delete Database

Delete Database Snapshot

Virtual Clone Operations

Stop Virtual Database Clone

Start Virtual Database Clone

Reset Virtual Database Clone

Share Virtual Clone

Share Oracle Virtual Database Clone

Share MySQL Virtual Database Server Clone

Share MariaDB Virtual Database Server Clone

Convert Virtual Clone to Physical

Convert Oracle Virtual Clone to Physical

Convert MySQL Virtual Clone to Physical

Convert MariaDB Virtual Clone to Physical