Skip to content

SnapshotServiceApi.md

Latest commit

 

History

History
421 lines (278 loc) · 12 KB

SnapshotServiceApi.md

File metadata and controls

421 lines (278 loc) · 12 KB

OpenAPI\Client\SnapshotServiceApi

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

Method HTTP request Description
snapshotServiceCreate() POST /v1/vps/snapshot
snapshotServiceCreateCalculator() POST /v1/vps/snapshot/calculator
snapshotServiceEdit() PUT /v1/vps/snapshot/{id}
snapshotServiceGetAll() GET /v1/vps/snapshot
snapshotServiceGetAllRestores() GET /v1/vps/snapshot/restore
snapshotServiceRemove() DELETE /v1/vps/snapshot/{id}
snapshotServiceRestore() POST /v1/vps/snapshot/{id}/restore

snapshotServiceCreate()

snapshotServiceCreate($snapshot_create_request): \OpenAPI\Client\Model\SnapshotCreateResponse

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\SnapshotServiceApi(
    // 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
);
$snapshot_create_request = new \OpenAPI\Client\Model\SnapshotCreateRequest(); // \OpenAPI\Client\Model\SnapshotCreateRequest

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

Parameters

Name Type Description Notes
snapshot_create_request \OpenAPI\Client\Model\SnapshotCreateRequest

Return type

\OpenAPI\Client\Model\SnapshotCreateResponse

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]

snapshotServiceCreateCalculator()

snapshotServiceCreateCalculator($snapshot_create_calculator_request): \OpenAPI\Client\Model\SnapshotCreateCalculatorResponse

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\SnapshotServiceApi(
    // 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
);
$snapshot_create_calculator_request = new \OpenAPI\Client\Model\SnapshotCreateCalculatorRequest(); // \OpenAPI\Client\Model\SnapshotCreateCalculatorRequest

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

Parameters

Name Type Description Notes
snapshot_create_calculator_request \OpenAPI\Client\Model\SnapshotCreateCalculatorRequest

Return type

\OpenAPI\Client\Model\SnapshotCreateCalculatorResponse

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]

snapshotServiceEdit()

snapshotServiceEdit($id, $snapshot_edit_request): \OpenAPI\Client\Model\SnapshotEditResponse

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\SnapshotServiceApi(
    // 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
$snapshot_edit_request = new \OpenAPI\Client\Model\SnapshotEditRequest(); // \OpenAPI\Client\Model\SnapshotEditRequest

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

Parameters

Name Type Description Notes
id string
snapshot_edit_request \OpenAPI\Client\Model\SnapshotEditRequest

Return type

\OpenAPI\Client\Model\SnapshotEditResponse

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]

snapshotServiceGetAll()

snapshotServiceGetAll(): \OpenAPI\Client\Model\SnapshotGetAllResponse

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\SnapshotServiceApi(
    // 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->snapshotServiceGetAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SnapshotServiceApi->snapshotServiceGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\SnapshotGetAllResponse

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]

snapshotServiceGetAllRestores()

snapshotServiceGetAllRestores($id): \OpenAPI\Client\Model\SnapshotGetAllRestoresResponse

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\SnapshotServiceApi(
    // 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

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

Parameters

Name Type Description Notes
id string [optional]

Return type

\OpenAPI\Client\Model\SnapshotGetAllRestoresResponse

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]

snapshotServiceRemove()

snapshotServiceRemove($id): \OpenAPI\Client\Model\SnapshotRemoveResponse

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\SnapshotServiceApi(
    // 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

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

Parameters

Name Type Description Notes
id string

Return type

\OpenAPI\Client\Model\SnapshotRemoveResponse

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]

snapshotServiceRestore()

snapshotServiceRestore($id, $snapshot_restore_request): \OpenAPI\Client\Model\SnapshotRestoreResponse

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\SnapshotServiceApi(
    // 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
$snapshot_restore_request = new \OpenAPI\Client\Model\SnapshotRestoreRequest(); // \OpenAPI\Client\Model\SnapshotRestoreRequest

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

Parameters

Name Type Description Notes
id string
snapshot_restore_request \OpenAPI\Client\Model\SnapshotRestoreRequest

Return type

\OpenAPI\Client\Model\SnapshotRestoreResponse

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]