Skip to content

Latest commit

 

History

History
2411 lines (1527 loc) · 60.1 KB

File metadata and controls

2411 lines (1527 loc) · 60.1 KB

KodingApi.JGroupApi

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

Method HTTP request Description
addSubscription POST /JGroup.addSubscription/{id}
byRelevance POST /JGroup.byRelevance
canEditGroup POST /JGroup.canEditGroup/{id}
changeMemberRoles POST /JGroup.changeMemberRoles/{id}
count POST /JGroup.count
create POST /JGroup.create
destroy POST /JGroup.destroy/{id}
each POST /JGroup.each
fetchAdmins POST /JGroup.fetchAdmins/{id}
fetchAdminsWithEmail POST /JGroup.fetchAdminsWithEmail/{id}
fetchApiTokens POST /JGroup.fetchApiTokens/{id}
fetchBlockedAccounts POST /JGroup.fetchBlockedAccounts/{id}
fetchBlockedAccountsWithEmail POST /JGroup.fetchBlockedAccountsWithEmail/{id}
fetchDataAt POST /JGroup.fetchDataAt/{id}
fetchMembers POST /JGroup.fetchMembers/{id}
fetchMembersWithEmail POST /JGroup.fetchMembersWithEmail/{id}
fetchModerators POST /JGroup.fetchModerators/{id}
fetchModeratorsWithEmail POST /JGroup.fetchModeratorsWithEmail/{id}
fetchMyMemberships POST /JGroup.fetchMyMemberships
fetchMyRoles POST /JGroup.fetchMyRoles/{id}
fetchPermissionSetOrDefault POST /JGroup.fetchPermissionSetOrDefault/{id}
fetchPermissions POST /JGroup.fetchPermissions/{id}
fetchResources POST /JGroup.fetchResources/{id}
fetchRoles POST /JGroup.fetchRoles/{id}
fetchSubscription POST /JGroup.fetchSubscription/{id}
fetchUserRoles POST /JGroup.fetchUserRoles/{id}
fetchUserStatus POST /JGroup.fetchUserStatus/{id}
isMember POST /JGroup.isMember/{id}
join POST /JGroup.join/{id}
joinUser POST /JGroup.joinUser
kickMember POST /JGroup.kickMember/{id}
leave POST /JGroup.leave/{id}
modify POST /JGroup.modify/{id}
modifyData POST /JGroup.modifyData/{id}
one POST /JGroup.one
searchMembers POST /JGroup.searchMembers/{id}
sendNotification POST /JGroup.sendNotification/{id}
setLimit POST /JGroup.setLimit/{id}
setOAuth POST /JGroup.setOAuth/{id}
someWithRelationship POST /JGroup.someWithRelationship
suggestUniqueSlug POST /JGroup.suggestUniqueSlug
toggleFeature POST /JGroup.toggleFeature/{id}
transferOwnership POST /JGroup.transferOwnership/{id}
unblockMember POST /JGroup.unblockMember/{id}
updatePermissions POST /JGroup.updatePermissions/{id}

addSubscription

DefaultResponse addSubscription(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.JGroupApi();

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

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

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

byRelevance

DefaultResponse byRelevance(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.JGroupApi();

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

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

canEditGroup

DefaultResponse canEditGroup(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.JGroupApi();

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

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

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

changeMemberRoles

DefaultResponse changeMemberRoles(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.JGroupApi();

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

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

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

count

DefaultResponse count(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.JGroupApi();

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

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

create

DefaultResponse create(body)

Method JGroup.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.JGroupApi();

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

DefaultResponse

Authorization

Bearer

HTTP request headers

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

destroy

DefaultResponse destroy(id, body)

Method JGroup.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.JGroupApi();

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

each

DefaultResponse each(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.JGroupApi();

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

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

fetchAdmins

DefaultResponse fetchAdmins(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.JGroupApi();

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

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

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

fetchAdminsWithEmail

DefaultResponse fetchAdminsWithEmail(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.JGroupApi();

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

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

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

fetchApiTokens

DefaultResponse fetchApiTokens(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.JGroupApi();

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

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

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

fetchBlockedAccounts

DefaultResponse fetchBlockedAccounts(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.JGroupApi();

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

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

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

fetchBlockedAccountsWithEmail

DefaultResponse fetchBlockedAccountsWithEmail(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.JGroupApi();

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

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

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

fetchDataAt

DefaultResponse fetchDataAt(id, body)

Method JGroup.fetchDataAt

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

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

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

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

fetchMembers

DefaultResponse fetchMembers(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.JGroupApi();

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

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

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

fetchMembersWithEmail

DefaultResponse fetchMembersWithEmail(id, body)

Method JGroup.fetchMembersWithEmail

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

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

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

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

fetchModerators

DefaultResponse fetchModerators(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.JGroupApi();

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

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

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

fetchModeratorsWithEmail

DefaultResponse fetchModeratorsWithEmail(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.JGroupApi();

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

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

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

fetchMyMemberships

DefaultResponse fetchMyMemberships(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.JGroupApi();

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

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

fetchMyRoles

DefaultResponse fetchMyRoles(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.JGroupApi();

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

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

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

fetchPermissionSetOrDefault

DefaultResponse fetchPermissionSetOrDefault(id, body)

Method JGroup.fetchPermissionSetOrDefault

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

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

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

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

fetchPermissions

DefaultResponse fetchPermissions(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.JGroupApi();

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

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

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

fetchResources

DefaultResponse fetchResources(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.JGroupApi();

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

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

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

fetchRoles

DefaultResponse fetchRoles(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.JGroupApi();

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

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

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

fetchSubscription

DefaultResponse fetchSubscription(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.JGroupApi();

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

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

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

fetchUserRoles

DefaultResponse fetchUserRoles(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.JGroupApi();

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

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

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

fetchUserStatus

DefaultResponse fetchUserStatus(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.JGroupApi();

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

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

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

isMember

DefaultResponse isMember(id, body)

Method JGroup.isMember

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

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

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

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

join

DefaultResponse join(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.JGroupApi();

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

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

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

joinUser

DefaultResponse joinUser(body)

joinUser Joins user with given options to group either by logging in or converting them.

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

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

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

kickMember

DefaultResponse kickMember(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.JGroupApi();

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

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

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

leave

DefaultResponse leave(id, body)

Method JGroup.leave

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

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

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

apiInstance.leave(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.JGroupApi();

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

modifyData

Error modifyData(id, body)

modifies JGroupData related with the JGroup instance

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

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

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

apiInstance.modifyData(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 Body4 body of the request

Return type

Error

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

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

searchMembers

DefaultResponse searchMembers(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.JGroupApi();

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

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

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

sendNotification

DefaultResponse sendNotification(id, body)

Method JGroup.sendNotification

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

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

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

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

setLimit

DefaultResponse setLimit(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.JGroupApi();

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

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

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

setOAuth

DefaultResponse setOAuth(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.JGroupApi();

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

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

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

someWithRelationship

DefaultResponse someWithRelationship(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.JGroupApi();

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

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

suggestUniqueSlug

DefaultResponse suggestUniqueSlug(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.JGroupApi();

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

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

toggleFeature

DefaultResponse toggleFeature(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.JGroupApi();

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

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

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

transferOwnership

DefaultResponse transferOwnership(id, body)

Method JGroup.transferOwnership

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

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

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

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

unblockMember

DefaultResponse unblockMember(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.JGroupApi();

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

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

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

updatePermissions

DefaultResponse updatePermissions(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.JGroupApi();

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

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

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