Skip to content

SnapshotEventsApi.md

Latest commit

 

History

History
59 lines (37 loc) · 1.52 KB

SnapshotEventsApi.md

File metadata and controls

59 lines (37 loc) · 1.52 KB

HyperstackApi.SnapshotEventsApi

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

Method HTTP request Description
listSnapshotEvents GET /core/snapshots/{snapshot_id}/events Fetch all events for a snapshot

listSnapshotEvents

listSnapshotEvents(snapshotId)

Fetch all events for a snapshot

Retrieves a list of all events for a Snapshot's history, which records actions performed on the specific snapshot. Requires the snapshot ID in the path.

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.SnapshotEventsApi();
let snapshotId = 56; // Number | 
apiInstance.listSnapshotEvents(snapshotId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
snapshotId Number

Return type

null (empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined