Skip to content

SnapshotsApi.md

Latest commit

 

History

History
324 lines (212 loc) · 8.49 KB

SnapshotsApi.md

File metadata and controls

324 lines (212 loc) · 8.49 KB

HyperstackApi.SnapshotsApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
createCustomImage POST /core/snapshots/{snapshot_id}/image Create an image from a snapshot
deleteSnapshot DELETE /core/snapshots/{id} Delete snapshot
fetchSnapshotNameAvailability GET /core/snapshots/name-availability/{name} Fetch snapshot name availability
getSnapshot GET /core/snapshots/{id} Retrieve a snapshot
listSnapshots GET /core/snapshots Retrieve list of snapshots with pagination
restoreSnapshot POST /core/snapshots/{id}/restore Restore a snapshot

createCustomImage

CreateImage createCustomImage(snapshotId, payload)

Create an image from a snapshot

Create a new custom image from an existing snapshot.Requires a name and any labels for your new custom image.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let snapshotId = 56; // Number | 
let payload = new HyperstackApi.CreateImagePayload(); // CreateImagePayload | 
apiInstance.createCustomImage(snapshotId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
snapshotId Number
payload CreateImagePayload

Return type

CreateImage

Authorization

apiKey

HTTP request headers

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

deleteSnapshot

ResponseModel deleteSnapshot(id)

Delete snapshot

Delete a snapshot. Provide the snapshot ID in the path to delete the specified snapshot. If the snapshot is connected with an image, that image will also bedeleted and the deleted image ID will be returned in the success message response.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let id = 56; // Number | 
apiInstance.deleteSnapshot(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

fetchSnapshotNameAvailability

NameAvailableModel fetchSnapshotNameAvailability(name)

Fetch snapshot name availability

Check if a Snapshot name is available

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let name = "name_example"; // String | 
apiInstance.fetchSnapshotNameAvailability(name).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
name String

Return type

NameAvailableModel

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSnapshot

SnapshotRetrieve getSnapshot(id)

Retrieve a snapshot

Retrieve a snapshot.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let id = 56; // Number | 
apiInstance.getSnapshot(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number

Return type

SnapshotRetrieve

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listSnapshots

Snapshots listSnapshots(opts)

Retrieve list of snapshots with pagination

Retrieves a list of snapshots, providing details such as snapshot name, timestamp, VM ID, and other relevant information.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let opts = {
  'page': "page_example", // String | Page Number
  'pageSize': "pageSize_example", // String | Data Per Page
  'search': "search_example" // String | Search By Snapshot ID or Name
};
apiInstance.listSnapshots(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
page String Page Number [optional]
pageSize String Data Per Page [optional]
search String Search By Snapshot ID or Name [optional]

Return type

Snapshots

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

restoreSnapshot

Instance restoreSnapshot(id, payload)

Restore a snapshot

Restore a snapshot.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.SnapshotsApi();
let id = 56; // Number | 
let payload = new HyperstackApi.SnapshotRestoreRequest(); // SnapshotRestoreRequest | 
apiInstance.restoreSnapshot(id, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number
payload SnapshotRestoreRequest

Return type

Instance

Authorization

apiKey

HTTP request headers

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