@corellium/client-api

@corellium/client-api

CorelliumClient - JavaScript client for @corellium/client-api REST API to manage your virtual devices. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.10.0-13354
• Package version: 0.1.0
• Build package: org.openapitools.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 @corellium/client-api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @corellium/client-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var CorelliumClient = require('@corellium/client-api');


var api = new CorelliumClient.CorelliumApi()
var body = {
  "username": "admin",
  "password": "password"
}; // {Object} Authorization data ( Credentials|ApiToken )
api.v1AuthLogin(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://app.corellium.com/api

Class	Method	HTTP request	Description
CorelliumClient.CorelliumApi	v1AuthLogin	POST /v1/auth/login	Log In
CorelliumClient.CorelliumApi	v1CreateImage	POST /v1/images	Create a new Image
CorelliumClient.CorelliumApi	v1CreateInstance	POST /v1/instances	Create Instance
CorelliumClient.CorelliumApi	v1CreateSnapshot	POST /v1/instances/{instanceId}/snapshots	Create Instance Snapshot
CorelliumClient.CorelliumApi	v1DeleteImage	DELETE /v2/images/{imageId}	Delete Image
CorelliumClient.CorelliumApi	v1DeleteInstance	DELETE /v1/instances/{instanceId}	Remove Instance
CorelliumClient.CorelliumApi	v1GetImage	GET /v1/images/{imageId}	Get Image Metadata
CorelliumClient.CorelliumApi	v1GetImages	GET /v1/images	Get all Images Metadata
CorelliumClient.CorelliumApi	v1GetInstance	GET /v1/instances/{instanceId}	Get Instance
CorelliumClient.CorelliumApi	v1GetInstanceConsole	GET /v1/instances/{instanceId}/console	Get console websocket URL
CorelliumClient.CorelliumApi	v1GetInstanceGpios	GET /v1/instances/{instanceId}/gpios	Get Instance GPIOs
CorelliumClient.CorelliumApi	v1GetInstancePeripherals	GET /v1/instances/{instanceId}/peripherals	Get Instance Peripherals
CorelliumClient.CorelliumApi	v1GetInstanceScreenshot	GET /v1/instances/{instanceId}/screenshot.{format}	Get Instance Screenshot
CorelliumClient.CorelliumApi	v1GetInstanceState	GET /v1/instances/{instanceId}/state	Get state of Instance
CorelliumClient.CorelliumApi	v1GetInstances	GET /v1/instances	Get Instances
CorelliumClient.CorelliumApi	v1GetModelSoftware	GET /v1/models/{model}/software	Get Software for Model
CorelliumClient.CorelliumApi	v1GetModels	GET /v1/models	Get Supported Models
CorelliumClient.CorelliumApi	v1GetProject	GET /v1/projects/{projectId}	Get Project
CorelliumClient.CorelliumApi	v1GetProjectInstances	GET /v1/projects/{projectId}/instances	Get Instances in Project
CorelliumClient.CorelliumApi	v1GetProjectVpnConfig	GET /v1/projects/{projectId}/vpnconfig/{format}	Get Project VPN Configuration
CorelliumClient.CorelliumApi	v1GetProjects	GET /v1/projects	Get Projects
CorelliumClient.CorelliumApi	v1GetSnapshot	GET /v1/instances/{instanceId}/snapshots/{snapshotId}	Get Instance Snapshots
CorelliumClient.CorelliumApi	v1GetSnapshots	GET /v1/instances/{instanceId}/snapshots	Get Instance Snapshots
CorelliumClient.CorelliumApi	v1PatchInstance	PATCH /v1/instances/{instanceId}	Update Instance
CorelliumClient.CorelliumApi	v1PauseInstance	POST /v1/instances/{instanceId}/pause	Pause an Instance
CorelliumClient.CorelliumApi	v1Ready	GET /v1/ready	API Status
CorelliumClient.CorelliumApi	v1RebootInstance	POST /v1/instances/{instanceId}/reboot	Reboot an Instance
CorelliumClient.CorelliumApi	v1RestoreSnapshot	POST /v1/instances/{instanceId}/snapshots/{snapshotId}/restore	Restore a Snapshot
CorelliumClient.CorelliumApi	v1SetInstanceGpios	PUT /v1/instances/{instanceId}/gpios	Set Instance GPIOs
CorelliumClient.CorelliumApi	v1SetInstancePeripherals	PUT /v1/instances/{instanceId}/peripherals	Set Instance Peripherals
CorelliumClient.CorelliumApi	v1SetInstanceState	PUT /v1/instances/{instanceId}/state	Set state of Instance
CorelliumClient.CorelliumApi	v1SnapshotDelete	DELETE /v1/instances/{instanceId}/snapshots/{snapshotId}	Delete a Snapshot
CorelliumClient.CorelliumApi	v1SnapshotRename	PATCH /v1/instances/{instanceId}/snapshots/{snapshotId}	Rename a Snapshot
CorelliumClient.CorelliumApi	v1StartInstance	POST /v1/instances/{instanceId}/start	Start an Instance
CorelliumClient.CorelliumApi	v1StopInstance	POST /v1/instances/{instanceId}/stop	Stop an Instance
CorelliumClient.CorelliumApi	v1UnpauseInstance	POST /v1/instances/{instanceId}/unpause	Unpause an Instance
CorelliumClient.CorelliumApi	v1UploadImageData	POST /v1/images/{imageId}	Upload Image Data
CorelliumClient.CorelliumApi	v1UsersLogin	POST /v1/users/login	Log In

Documentation for Models

• CorelliumClient.ApiConflictError
• CorelliumClient.ApiError
• CorelliumClient.ApiNotFoundError
• CorelliumClient.ApiToken
• CorelliumClient.Bit
• CorelliumClient.Credentials
• CorelliumClient.Firmware
• CorelliumClient.GpioStateDefinition
• CorelliumClient.Image
• CorelliumClient.Instance
• CorelliumClient.InstanceBootOptions
• CorelliumClient.InstanceConsoleEndpoint
• CorelliumClient.InstanceCreateOptions
• CorelliumClient.InstanceNetmonState
• CorelliumClient.InstanceReturn
• CorelliumClient.InstanceServices
• CorelliumClient.InstanceStartOptions
• CorelliumClient.InstanceState
• CorelliumClient.InstanceStopOptions
• CorelliumClient.Model
• CorelliumClient.ModelSoftware
• CorelliumClient.PeripheralsData
• CorelliumClient.Project
• CorelliumClient.ProjectQuota
• CorelliumClient.ProjectSettings
• CorelliumClient.ProjectUsage
• CorelliumClient.Snapshot
• CorelliumClient.SnapshotCreationOptions
• CorelliumClient.SnapshotStatus
• CorelliumClient.Token
• CorelliumClient.UserError
• CorelliumClient.V1SetStateBody
• CorelliumClient.VolumeOptions
• CorelliumClient.VpnDefinition

Documentation for Authorization

BearerAuth

• Type: Bearer authentication (ApiToken or JWT)