KodingApi.JProposedDomainApi

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

Method	HTTP request	Description
activateDomain	POST /JProposedDomain.activateDomain/{id}
bindMachine	POST /JProposedDomain.bindMachine/{id}
createDomain	POST /JProposedDomain.createDomain
deactivateDomain	POST /JProposedDomain.deactivateDomain/{id}
fetchDomains	POST /JProposedDomain.fetchDomains
one	POST /JProposedDomain.one
remove	POST /JProposedDomain.remove/{id}
unbindMachine	POST /JProposedDomain.unbindMachine/{id}

activateDomain

DefaultResponse activateDomain(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.JProposedDomainApi();

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

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

apiInstance.activateDomain(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

bindMachine

DefaultResponse bindMachine(id, body)

Method JProposedDomain.bindMachine

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.JProposedDomainApi();

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

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

apiInstance.bindMachine(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

createDomain

DefaultResponse createDomain(body)

Method JProposedDomain.createDomain

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.JProposedDomainApi();

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

apiInstance.createDomain(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

deactivateDomain

DefaultResponse deactivateDomain(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.JProposedDomainApi();

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

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

apiInstance.deactivateDomain(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

fetchDomains

DefaultResponse fetchDomains()

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

Parameters

This endpoint does not need any parameter.

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.JProposedDomainApi();

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

remove

DefaultResponse remove(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.JProposedDomainApi();

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

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

apiInstance.remove(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

unbindMachine

DefaultResponse unbindMachine(id, body)

Method JProposedDomain.unbindMachine

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.JProposedDomainApi();

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

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

apiInstance.unbindMachine(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

Files

JProposedDomainApi.md

Latest commit

History

JProposedDomainApi.md

File metadata and controls

KodingApi.JProposedDomainApi

activateDomain

Example

Parameters

Return type

Authorization

HTTP request headers

bindMachine

Example

Parameters

Return type

Authorization

HTTP request headers

createDomain

Example

Parameters

Return type

Authorization

HTTP request headers

deactivateDomain

Example

Parameters

Return type

Authorization

HTTP request headers

fetchDomains

Example

Parameters

Return type

Authorization

HTTP request headers

one

Example

Parameters

Return type

Authorization

HTTP request headers

remove

Example

Parameters

Return type

Authorization

HTTP request headers

unbindMachine

Example

Parameters

Return type

Authorization

HTTP request headers