Skip to content

VPSPublicKeysApi.md

Latest commit

 

History

History
197 lines (130 loc) · 6.24 KB

VPSPublicKeysApi.md

File metadata and controls

197 lines (130 loc) · 6.24 KB

Hostinger\VPSPublicKeysApi

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

Method HTTP request Description
attachPublicKeyV1() POST /api/vps/v1/public-keys/attach/{virtualMachineId} Attach public key
createPublicKeyV1() POST /api/vps/v1/public-keys Create public key
deletePublicKeyV1() DELETE /api/vps/v1/public-keys/{publicKeyId} Delete public key
getPublicKeysV1() GET /api/vps/v1/public-keys Get public keys

attachPublicKeyV1()

attachPublicKeyV1($virtualMachineId, $vPSV1PublicKeyAttachRequest): \Hostinger\Model\VPSV1ActionActionResource

Attach public key

Attach existing public keys from your account to a specified virtual machine. Multiple keys can be attached to a single virtual machine. Use this endpoint to enable SSH key authentication for VPS instances.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSPublicKeysApi(config: $config);
$virtualMachineId = 1268054; // int | Virtual Machine ID
$vPSV1PublicKeyAttachRequest = new \Hostinger\Model\VPSV1PublicKeyAttachRequest(); // \Hostinger\Model\VPSV1PublicKeyAttachRequest

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

Parameters

Name Type Description Notes
virtualMachineId int Virtual Machine ID
vPSV1PublicKeyAttachRequest \Hostinger\Model\VPSV1PublicKeyAttachRequest

Return type

\Hostinger\Model\VPSV1ActionActionResource

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

createPublicKeyV1()

createPublicKeyV1($vPSV1PublicKeyStoreRequest): \Hostinger\Model\VPSV1PublicKeyPublicKeyResource

Create public key

Add a new public key to your account. Use this endpoint to register SSH keys for VPS authentication.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSPublicKeysApi(config: $config);
$vPSV1PublicKeyStoreRequest = new \Hostinger\Model\VPSV1PublicKeyStoreRequest(); // \Hostinger\Model\VPSV1PublicKeyStoreRequest

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

Parameters

Name Type Description Notes
vPSV1PublicKeyStoreRequest \Hostinger\Model\VPSV1PublicKeyStoreRequest

Return type

\Hostinger\Model\VPSV1PublicKeyPublicKeyResource

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

deletePublicKeyV1()

deletePublicKeyV1($publicKeyId): \Hostinger\Model\CommonSuccessEmptyResource

Delete public key

Delete a public key from your account. Deleting public key from account does not remove it from virtual machine Use this endpoint to remove unused SSH keys from account.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSPublicKeysApi(config: $config);
$publicKeyId = 6672861; // int | Public Key ID

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

Parameters

Name Type Description Notes
publicKeyId int Public Key ID

Return type

\Hostinger\Model\CommonSuccessEmptyResource

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

getPublicKeysV1()

getPublicKeysV1($page): \Hostinger\Model\VPSV1PublicKeyListResponse

Get public keys

Retrieve public keys associated with your account. Use this endpoint to view available SSH keys for VPS authentication.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSPublicKeysApi(config: $config);
$page = 1; // int | Page number

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

Parameters

Name Type Description Notes
page int Page number [optional]

Return type

\Hostinger\Model\VPSV1PublicKeyListResponse

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