Upmind\EnhanceSdk\ImportersApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
analyzeImportMigration()	POST /v2/orgs/{org_id}/import/{import_migration_id}/analyze	Analyze imported migration
checkImportMigrationResources()	POST /v2/orgs/{org_id}/import/{import_migration_id}/resource	Check if all resources from the imported migration could be created.
createImportMigration()	POST /v2/orgs/{org_id}/import/{import_migration_id}	Create a new import migration.
deleteImportMigration()	DELETE /v2/orgs/{org_id}/import/{import_migration_id}	Delete single migration
getImportMigration()	GET /v2/orgs/{org_id}/import/{import_migration_id}	Fetches single migration details
getImportMigrationData()	GET /v2/orgs/{org_id}/import/{import_migration_id}/analyze	Get import migration information
getImportMigrationLog()	GET /v2/orgs/{org_id}/import/{import_migration_id}/log	Get the log for an import migration
getImportMigrations()	GET /v2/orgs/{org_id}/import	List all import migrations
scanImportMigrations()	GET /v2/import/scan	Scan for manually uploaded cPanel backups.
uploadImportMigration()	POST /v2/orgs/{org_id}/import/upload/{import_migration_kind}	Upload file for analyzing and processing.

`analyzeImportMigration()`

analyzeImportMigration($org_id, $import_migration_id)

Analyze imported migration

Analyze import and store results into database. Note: the endpoint returns immediately, and you have to poll status via getImportMigration endpoint. If you want to see detailed error, please call getImportMigrationLog.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.

try {
    $apiInstance->analyzeImportMigration($org_id, $import_migration_id);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->analyzeImportMigration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.

Return type

void (empty response body)

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`checkImportMigrationResources()`

checkImportMigrationResources($org_id, $import_migration_id, $importer_migration_req_body): \Upmind\EnhanceSdk\Model\ResourceCheckError

Check if all resources from the imported migration could be created.

Check if all resources from the imported migration could be created. If all resources could be created, 200 is returned with an empty ResourceCheckError. However, if any error occurs, 200 is returned with a non-empty ResourceCheckError. In case of import failure, you can rerun importing by setting forceQueue to true. Before doing so, it's required to remove any already imported resources. Otherwise, the import will fail.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.
$importer_migration_req_body = new \Upmind\EnhanceSdk\Model\ImporterMigrationReqBody(); // \Upmind\EnhanceSdk\Model\ImporterMigrationReqBody

try {
    $result = $apiInstance->checkImportMigrationResources($org_id, $import_migration_id, $importer_migration_req_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->checkImportMigrationResources: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.
importer_migration_req_body	\Upmind\EnhanceSdk\Model\ImporterMigrationReqBody		[optional]

Return type

\Upmind\EnhanceSdk\Model\ResourceCheckError

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createImportMigration()`

createImportMigration($org_id, $import_migration_id, $importer_migration_req_body)

Create a new import migration.

Create a new import migration for a given import type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.
$importer_migration_req_body = new \Upmind\EnhanceSdk\Model\ImporterMigrationReqBody(); // \Upmind\EnhanceSdk\Model\ImporterMigrationReqBody

try {
    $apiInstance->createImportMigration($org_id, $import_migration_id, $importer_migration_req_body);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->createImportMigration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.
importer_migration_req_body	\Upmind\EnhanceSdk\Model\ImporterMigrationReqBody		[optional]

Return type

void (empty response body)

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteImportMigration()`

deleteImportMigration($org_id, $import_migration_id)

Delete single migration

Delete a single migration with the uploaded file.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.

try {
    $apiInstance->deleteImportMigration($org_id, $import_migration_id);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->deleteImportMigration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.

Return type

void (empty response body)

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getImportMigration()`

getImportMigration($org_id, $import_migration_id): \Upmind\EnhanceSdk\Model\ImportMigrationEntry

Fetches single migration details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.

try {
    $result = $apiInstance->getImportMigration($org_id, $import_migration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->getImportMigration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.

Return type

\Upmind\EnhanceSdk\Model\ImportMigrationEntry

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getImportMigrationData()`

getImportMigrationData($org_id, $import_migration_id): \Upmind\EnhanceSdk\Model\ImporterAnalyzedData

Get import migration information

Get analyzed informations about import. Information contains details about domains, ftp users, databases, crontabs and mailboxes.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.

try {
    $result = $apiInstance->getImportMigrationData($org_id, $import_migration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->getImportMigrationData: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.

Return type

\Upmind\EnhanceSdk\Model\ImporterAnalyzedData

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getImportMigrationLog()`

getImportMigrationLog($org_id, $import_migration_id): \Upmind\EnhanceSdk\Model\ImportMigrationLogEntry[]

Get the log for an import migration

Fetches the import migration log for a single import migration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_id = 'import_migration_id_example'; // string | The ID of the import migration being acted upon.

try {
    $result = $apiInstance->getImportMigrationLog($org_id, $import_migration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->getImportMigrationLog: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_id	string	The ID of the import migration being acted upon.

Return type

\Upmind\EnhanceSdk\Model\ImportMigrationLogEntry[]

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getImportMigrations()`

getImportMigrations($org_id): \Upmind\EnhanceSdk\Model\ImportMigrationFullListing

List all import migrations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.

try {
    $result = $apiInstance->getImportMigrations($org_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->getImportMigrations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.

Return type

\Upmind\EnhanceSdk\Model\ImportMigrationFullListing

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`scanImportMigrations()`

scanImportMigrations(): string[]

Scan for manually uploaded cPanel backups.

Will scan /var/local/enhance/orchd/importer for files matching cpmove*.tar.gz or backup*.tar.gz and will add them to the importer database for analysis. An array of migration IDs will be returned. Master organisation only.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->scanImportMigrations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->scanImportMigrations: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

string[]

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`uploadImportMigration()`

uploadImportMigration($org_id, $import_migration_kind, $backup): \Upmind\EnhanceSdk\Model\NewResourceUuid

Upload file for analyzing and processing.

Uploads an import file. File must be in tar.gz format, and only cPanel uploads are allowed. The max allowed size is 100 GB.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: sessionCookie
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKey('id0', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('id0', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = Upmind\EnhanceSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Upmind\EnhanceSdk\Api\ImportersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$org_id = 'org_id_example'; // string | The id of the organization.
$import_migration_kind = 'import_migration_kind_example'; // string | The type of migration file being uploaded.
$backup = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $apiInstance->uploadImportMigration($org_id, $import_migration_kind, $backup);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImportersApi->uploadImportMigration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
org_id	string	The id of the organization.
import_migration_kind	string	The type of migration file being uploaded.
backup	\SplFileObject\SplFileObject		[optional]

Return type

\Upmind\EnhanceSdk\Model\NewResourceUuid

Authorization

sessionCookie, bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ImportersApi.md

Latest commit

History

ImportersApi.md

File metadata and controls

Upmind\EnhanceSdk\ImportersApi

analyzeImportMigration()

Example

Parameters

Return type

Authorization

HTTP request headers

checkImportMigrationResources()

Example

Parameters

Return type

Authorization

HTTP request headers

createImportMigration()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteImportMigration()

Example

Parameters

Return type

Authorization

HTTP request headers

getImportMigration()

Example

Parameters

Return type

Authorization

HTTP request headers

getImportMigrationData()

Example

Parameters

Return type

Authorization

HTTP request headers

getImportMigrationLog()

Example

Parameters

Return type

Authorization

HTTP request headers

getImportMigrations()

Example

Parameters

Return type

Authorization

HTTP request headers

scanImportMigrations()

Example

Parameters

Return type

Authorization

HTTP request headers

uploadImportMigration()

Example

Parameters

Return type

Authorization

HTTP request headers

`analyzeImportMigration()`

`checkImportMigrationResources()`

`createImportMigration()`

`deleteImportMigration()`

`getImportMigration()`

`getImportMigrationData()`

`getImportMigrationLog()`

`getImportMigrations()`

`scanImportMigrations()`

`uploadImportMigration()`