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} |
DefaultResponse addSubscription(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse byRelevance(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse canEditGroup(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse changeMemberRoles(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse count(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse create(body)
Method JGroup.create
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse destroy(id, body)
Method JGroup.destroy
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse each(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchAdmins(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchAdminsWithEmail(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchApiTokens(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchBlockedAccounts(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchBlockedAccountsWithEmail(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchDataAt(id, body)
Method JGroup.fetchDataAt
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchMembers(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchMembersWithEmail(id, body)
Method JGroup.fetchMembersWithEmail
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchModerators(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchModeratorsWithEmail(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchMyMemberships(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchMyRoles(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchPermissionSetOrDefault(id, body)
Method JGroup.fetchPermissionSetOrDefault
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchPermissions(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchResources(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchRoles(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchSubscription(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchUserRoles(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse fetchUserStatus(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse isMember(id, body)
Method JGroup.isMember
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse join(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse joinUser(body)
joinUser Joins user with given options to group either by logging in or converting them.
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse kickMember(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse leave(id, body)
Method JGroup.leave
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse modify(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
Error modifyData(id, body)
modifies JGroupData related with the JGroup instance
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | Body4 | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse one(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse searchMembers(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse sendNotification(id, body)
Method JGroup.sendNotification
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse setLimit(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse setOAuth(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse someWithRelationship(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse suggestUniqueSlug(body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse toggleFeature(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse transferOwnership(id, body)
Method JGroup.transferOwnership
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse unblockMember(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined
DefaultResponse updatePermissions(id, body)
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);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Mongo ID of target instance | |
| body | DefaultSelector | body of the request |
- Content-Type: application/json
- Accept: Not defined