Skip to content

Latest commit

 

History

History
313 lines (210 loc) · 9.06 KB

BackupServiceApi.md

File metadata and controls

313 lines (210 loc) · 9.06 KB
Raw

OpenAPI\Client\BackupServiceApi

All URIs are relative to https://api.beget.com, except if the operation defines another base path.

Method HTTP request Description
backupServiceGetAvailableCopies() GET /v1/vps/backup
backupServiceGetBackupFileList() GET /v1/vps/{id}/backup/{copy_id}
backupServiceGetOrders() GET /v1/vps/backup/orders
backupServiceRestoreFile() POST /v1/vps/{id}/backup/{copy_id}/file
backupServiceRestoreServer() POST /v1/vps/{id}/backup/{copy_id}/server

backupServiceGetAvailableCopies()

backupServiceGetAvailableCopies(): \OpenAPI\Client\Model\BackupGetAvailableCopiesResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\BackupServiceApi(
    // 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->backupServiceGetAvailableCopies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackupServiceApi->backupServiceGetAvailableCopies: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\BackupGetAvailableCopiesResponse

Authorization

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]

backupServiceGetBackupFileList()

backupServiceGetBackupFileList($id, $copy_id, $path): \OpenAPI\Client\Model\BackupGetBackupFileListResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\BackupServiceApi(
    // 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
);
$id = 'id_example'; // string
$copy_id = 'copy_id_example'; // string
$path = 'path_example'; // string

try {
    $result = $apiInstance->backupServiceGetBackupFileList($id, $copy_id, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackupServiceApi->backupServiceGetBackupFileList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string
copy_id string
path string [optional]

Return type

\OpenAPI\Client\Model\BackupGetBackupFileListResponse

Authorization

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]

backupServiceGetOrders()

backupServiceGetOrders($limit, $offset): \OpenAPI\Client\Model\BackupGetOrdersResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\BackupServiceApi(
    // 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
);
$limit = 56; // int
$offset = 56; // int

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

Parameters

Name Type Description Notes
limit int [optional]
offset int [optional]

Return type

\OpenAPI\Client\Model\BackupGetOrdersResponse

Authorization

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]

backupServiceRestoreFile()

backupServiceRestoreFile($id, $copy_id, $backup_restore_file_request): \OpenAPI\Client\Model\BackupRestoreFileResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\BackupServiceApi(
    // 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
);
$id = 'id_example'; // string
$copy_id = 'copy_id_example'; // string
$backup_restore_file_request = new \OpenAPI\Client\Model\BackupRestoreFileRequest(); // \OpenAPI\Client\Model\BackupRestoreFileRequest

try {
    $result = $apiInstance->backupServiceRestoreFile($id, $copy_id, $backup_restore_file_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackupServiceApi->backupServiceRestoreFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string
copy_id string
backup_restore_file_request \OpenAPI\Client\Model\BackupRestoreFileRequest

Return type

\OpenAPI\Client\Model\BackupRestoreFileResponse

Authorization

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]

backupServiceRestoreServer()

backupServiceRestoreServer($id, $copy_id, $backup_restore_server_request): \OpenAPI\Client\Model\BackupRestoreServerResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\BackupServiceApi(
    // 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
);
$id = 'id_example'; // string
$copy_id = 'copy_id_example'; // string
$backup_restore_server_request = new \OpenAPI\Client\Model\BackupRestoreServerRequest(); // \OpenAPI\Client\Model\BackupRestoreServerRequest

try {
    $result = $apiInstance->backupServiceRestoreServer($id, $copy_id, $backup_restore_server_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BackupServiceApi->backupServiceRestoreServer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string
copy_id string
backup_restore_server_request \OpenAPI\Client\Model\BackupRestoreServerRequest

Return type

\OpenAPI\Client\Model\BackupRestoreServerResponse

Authorization

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]