Skip to content

Latest commit

 

History

History
323 lines (202 loc) · 7.71 KB

JProvisionerApi.md

File metadata and controls

323 lines (202 loc) · 7.71 KB

KodingApi.JProvisionerApi

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

Method HTTP request Description
callDelete POST /JProvisioner.delete/{id}
create POST /JProvisioner.create
one POST /JProvisioner.one
setAccess POST /JProvisioner.setAccess/{id}
some POST /JProvisioner.some
update POST /JProvisioner.update/{id}

callDelete

DefaultResponse callDelete(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.JProvisionerApi();

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

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

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

Parameters

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

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

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

create

DefaultResponse create(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.JProvisionerApi();

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

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

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

setAccess

DefaultResponse setAccess(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.JProvisionerApi();

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

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

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

some

DefaultResponse some(body)

Example

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

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

var apiInstance = new KodingApi.JProvisionerApi();

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

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

Parameters

Name Type Description Notes
body DefaultSelector body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

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

update

DefaultResponse update(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.JProvisionerApi();

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

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

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