Skip to content

AliveApi.md

Latest commit

 

History

History
100 lines (62 loc) · 2.23 KB

AliveApi.md

File metadata and controls

100 lines (62 loc) · 2.23 KB

HyperstackApi.AliveApi

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

Method HTTP request Description
getAlive GET /billing/alive GET: Alive
getAliveDoc GET /billing/alive/doc

getAlive

getAlive()

GET: Alive

Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information click here.

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.AliveApi();
apiInstance.getAlive().then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

apiKey

HTTP request headers

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

getAliveDoc

getAliveDoc()

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.AliveApi();
apiInstance.getAliveDoc().then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

apiKey

HTTP request headers

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