Skip to content

DeploymentApi.md

Latest commit

 

History

History
200 lines (129 loc) · 4.84 KB

DeploymentApi.md

File metadata and controls

200 lines (129 loc) · 4.84 KB

HyperstackApi.DeploymentApi

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

Method HTTP request Description
deleteDeployment DELETE /core/marketplace/deployments/{id} Delete Deployment
getDeployment GET /core/marketplace/deployments/{id} Details of Deployment by ID
listDeployments GET /core/marketplace/deployments List Deployments
startDeployment POST /core/marketplace/deployments Start Deployment

deleteDeployment

ResponseModel deleteDeployment(id)

Delete Deployment

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.DeploymentApi();
let id = 56; // Number | 
apiInstance.deleteDeployment(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

getDeployment

StartDeployment getDeployment(id)

Details of Deployment by ID

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.DeploymentApi();
let id = 56; // Number | 
apiInstance.getDeployment(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number

Return type

StartDeployment

Authorization

apiKey

HTTP request headers

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

listDeployments

Deployments listDeployments()

List Deployments

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

Parameters

This endpoint does not need any parameter.

Return type

Deployments

Authorization

apiKey

HTTP request headers

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

startDeployment

StartDeployment startDeployment(payload)

Start Deployment

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

Parameters

Name Type Description Notes
payload StartDeploymentPayload

Return type

StartDeployment

Authorization

apiKey

HTTP request headers

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