apcera-ap-is v1.0.1

apcera-ap-is

ApceraApIs - JavaScript client for apcera-ap-is REST APIs used to manage an Apcera cluster and its resources. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2016-05-06T22:36:41.864Z
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install apcera-ap-is --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/apcera-ap-is then install it via:

npm install YOUR_USERNAME/apcera-ap-is --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApceraApIs = require('apcera-ap-is');

var defaultClient = ApceraApIs.ApiClient.default;

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

var api = new ApceraApIs.DefaultApi()

var opts = { 
  'startTime': 3.4, // {Number} UNIX timestamp. If specified, only events that occurred on or after the specified time are returned in the response.
  'endTime': 3.4, // {Number} UNIX timestamp. If specified, only events that occurred on or before the specified time are returned in the response.
  'fqn': "fqn_example", // {String} If specified, only events on the resource specified by `fqn` are returned in the response. You can also specify an FQN segment, which may include wildcards for the resource type. For example:\n * `*::/` returns all audit logs for all resource types.\n * `job::/` returns all audit logs for Job resource types. \n * `job::/apcera` returns all audit logs for Job resource types in the `/apcera` namespace and its sub-namespaces. \n * `*::/apcera` returns all audit logs for all resource types in the `/apcera` namespace its sub-namespaces.
  'eventType': "eventType_example", // {String} If specified, only events of the specified type are returned in the response.
  'authorization': "authorization_example" // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.auditGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.kiso.io/v1

Documentation for Models

• ApceraApIs.APCVersionObject
• ApceraApIs.APIError
• ApceraApIs.AuditLogItem
• ApceraApIs.AuditLogItemOld
• ApceraApIs.Binding
• ApceraApIs.CreateDockerJobRequest
• ApceraApIs.CreateDockerJobResponse
• ApceraApIs.Dependency
• ApceraApIs.DependencyResolve
• ApceraApIs.DockerOrigin
• ApceraApIs.Drain
• ApceraApIs.DrainConfig
• ApceraApIs.FileListing
• ApceraApIs.Info
• ApceraApIs.InlineResponse200
• ApceraApIs.InstanceManager
• ApceraApIs.InstanceState
• ApceraApIs.Instances
• ApceraApIs.Job
• ApceraApIs.JobHealth
• ApceraApIs.JobNetworkReference
• ApceraApIs.Log
• ApceraApIs.MetricSeries
• ApceraApIs.Metrics
• ApceraApIs.ModelPackage
• ApceraApIs.Namespace
• ApceraApIs.PackageDependsRequest
• ApceraApIs.PackageInfo
• ApceraApIs.PackageResource
• ApceraApIs.PolicyError
• ApceraApIs.Port
• ApceraApIs.Process
• ApceraApIs.ProcessObject
• ApceraApIs.Provide
• ApceraApIs.Provider
• ApceraApIs.Resource
• ApceraApIs.RestartConfig
• ApceraApIs.RolloutConfig
• ApceraApIs.Route
• ApceraApIs.Rule
• ApceraApIs.Runtime
• ApceraApIs.SemiPipeRule
• ApceraApIs.SemiPipeRuleAction
• ApceraApIs.Service
• ApceraApIs.ServiceRequestObject
• ApceraApIs.StagerJob
• ApceraApIs.StagingPipeline
• ApceraApIs.SubTask
• ApceraApIs.SubnetInfo
• ApceraApIs.Task
• ApceraApIs.TaskEvent
• ApceraApIs.TaskProgress
• ApceraApIs.UnbindParameterObject
• ApceraApIs.UnlinkParameterObject
• ApceraApIs.VirtualNetwork
• ApceraApIs.VirtualNetworkEndpoint
• ApceraApIs.VirtualNetworkEndpointInterface

Documentation for Authorization

authorization

• Type: API key
• API key parameter name: authorization
• Location: HTTP header