Skip to content

BetaAccessApi.md

Latest commit

 

History

History
157 lines (100 loc) · 4.22 KB

BetaAccessApi.md

File metadata and controls

157 lines (100 loc) · 4.22 KB

HyperstackApi.BetaAccessApi

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

Method HTTP request Description
createBetaAccessRequest POST /auth/beta-access/requests Create a new beta access request
getBetaAccessRequests GET /auth/beta-access/requests/{program} Check the status of beta access requests
getBetaAccessStatus GET /auth/beta-access/requests Check the status of all beta access requests

createBetaAccessRequest

BetaAccessRequestResponseModel createBetaAccessRequest(payload)

Create a new beta access request

Creates a new beta access request for the current user

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.BetaAccessApi();
let payload = new HyperstackApi.BetaAccessRequestPayload(); // BetaAccessRequestPayload | 
apiInstance.createBetaAccessRequest(payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
payload BetaAccessRequestPayload

Return type

BetaAccessRequestResponseModel

Authorization

apiKey

HTTP request headers

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

getBetaAccessRequests

BetaAccessStatusResponseModel getBetaAccessRequests(program)

Check the status of beta access requests

Check the status of a particular beta access requests.

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.BetaAccessApi();
let program = "program_example"; // String | 
apiInstance.getBetaAccessRequests(program).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
program String

Return type

BetaAccessStatusResponseModel

Authorization

apiKey

HTTP request headers

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

getBetaAccessStatus

BetaAccessStatusResponseModel getBetaAccessStatus()

Check the status of all beta access requests

Check the status of all beta access requests.

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.BetaAccessApi();
apiInstance.getBetaAccessStatus().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

BetaAccessStatusResponseModel

Authorization

apiKey

HTTP request headers

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