KodingApi.JComputeStackApi

All URIs are relative to https://koding.com/remote.api

Method	HTTP request	Description
callDelete	POST /JComputeStack.delete/{id}
checkRevision	POST /JComputeStack.checkRevision/{id}
create	POST /JComputeStack.create
createAdminMessage	POST /JComputeStack.createAdminMessage/{id}
deleteAdminMessage	POST /JComputeStack.deleteAdminMessage/{id}
destroy	POST /JComputeStack.destroy/{id}
maintenance	POST /JComputeStack.maintenance/{id}
modify	POST /JComputeStack.modify/{id}
one	POST /JComputeStack.one
some	POST /JComputeStack.some

callDelete

DefaultResponse callDelete(id, body)

Method JComputeStack.delete

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.callDelete(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

checkRevision

DefaultResponse checkRevision(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.checkRevision(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

create

JComputeStack create(body)

JComputeStack::create

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.create(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

JComputeStack

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

createAdminMessage

DefaultResponse createAdminMessage(id, body)

Method JComputeStack.createAdminMessage

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.createAdminMessage(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

deleteAdminMessage

DefaultResponse deleteAdminMessage(id, body)

Method JComputeStack.deleteAdminMessage

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.deleteAdminMessage(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

destroy

DefaultResponse destroy(id, body)

Method JComputeStack.destroy

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.destroy(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

maintenance

DefaultResponse maintenance(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.maintenance(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

modify

DefaultResponse modify(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.modify(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

one

DefaultResponse one(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.one(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

some

DefaultResponse some(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JComputeStackApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.some(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

FilesExpand file tree

JComputeStackApi.md

Latest commit

History

JComputeStackApi.md

File metadata and controls

KodingApi.JComputeStackApi

callDelete

Example

Parameters

Return type

Authorization

HTTP request headers

checkRevision

Example

Parameters

Return type

Authorization

HTTP request headers

create

Example

Parameters

Return type

Authorization

HTTP request headers

createAdminMessage

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAdminMessage

Example

Parameters

Return type

Authorization

HTTP request headers

destroy

Example

Parameters

Return type

Authorization

HTTP request headers

maintenance

Example

Parameters

Return type

Authorization

HTTP request headers

modify

Example

Parameters

Return type

Authorization

HTTP request headers

one

Example

Parameters

Return type

Authorization

HTTP request headers

some

Example

Parameters

Return type

Authorization

HTTP request headers