Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@corellium/client-api

Package Overview
Dependencies
Maintainers
3
Versions
5
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@corellium/client-api

Corellium Client API

  • 0.3.2
  • latest
  • npm
  • Socket score
Version published
Weekly downloads
1
Maintainers
3
Weekly downloads
 
Created
Source

@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: 4.5.0-16775
  • Package version: 0.3.2
  • 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 defaultClient = CorelliumClient.ApiClient.instance;
// Configure Bearer (ApiToken or JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new CorelliumClient.CorelliumApi()
var projectId = "projectId_example"; // {String} Project ID - uuid
var projectKey = {
  "kind": "ssh",
  "label": "My New Key",
  "key": "ssh-ed25519 <key>"
}; // {ProjectKey} Key to add
api.v1AddProjectKey(projectId, projectKey).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

ClassMethodHTTP requestDescription
CorelliumClient.CorelliumApiv1AddProjectKeyPOST /v1/projects/{projectId}/keysAdd Project Authorized Key
CorelliumClient.CorelliumApiv1AddTeamRoleToProjectPUT /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId}Add team role to project
CorelliumClient.CorelliumApiv1AddUserRoleToProjectPUT /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId}Add user role to project
CorelliumClient.CorelliumApiv1AddUserToTeamPUT /v1/teams/{teamId}/users/{userId}Add user to team
CorelliumClient.CorelliumApiv1AgentAppReadyGET /v1/instances/{instanceId}/agent/v1/app/readyCheck if App subsystem is ready
CorelliumClient.CorelliumApiv1AgentDeleteFileDELETE /v1/instances/{instanceId}/agent/v1/file/device/{filePath}Delete a File on VM
CorelliumClient.CorelliumApiv1AgentGetFileGET /v1/instances/{instanceId}/agent/v1/file/device/{filePath}Download a File from VM
CorelliumClient.CorelliumApiv1AgentGetTempFilenamePOST /v1/instances/{instanceId}/agent/v1/file/tempGet the path for a new temp file
CorelliumClient.CorelliumApiv1AgentInstallAppPOST /v1/instances/{instanceId}/agent/v1/app/installInstall App at path
CorelliumClient.CorelliumApiv1AgentInstallProfilePOST /v1/instances/{instanceId}/agent/v1/profile/installInstall a Profile to VM
CorelliumClient.CorelliumApiv1AgentKillAppPOST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/killKill an App
CorelliumClient.CorelliumApiv1AgentListAppIconsGET /v1/instances/{instanceId}/agent/v1/app/iconsList App Icons
CorelliumClient.CorelliumApiv1AgentListAppsGET /v1/instances/{instanceId}/agent/v1/app/appsList Apps
CorelliumClient.CorelliumApiv1AgentListAppsStatusGET /v1/instances/{instanceId}/agent/v1/app/apps/updateList Apps Status
CorelliumClient.CorelliumApiv1AgentListProfilesGET /v1/instances/{instanceId}/agent/v1/profile/profilesList Profiles
CorelliumClient.CorelliumApiv1AgentRunAppPOST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/runRun an App
CorelliumClient.CorelliumApiv1AgentSetFileAttributesPATCH /v1/instances/{instanceId}/agent/v1/file/device/{filePath}Change Attrs of a File on VM
CorelliumClient.CorelliumApiv1AgentSystemGetAdbAuthGET /v1/instances/{instanceId}/agent/v1/system/adbauthGet ADB Auth Setting (AOSP only)
CorelliumClient.CorelliumApiv1AgentSystemGetNetworkGET /v1/instances/{instanceId}/agent/v1/system/networkGet IP of eth0 (AOSP only)
CorelliumClient.CorelliumApiv1AgentSystemGetPropPOST /v1/instances/{instanceId}/agent/v1/system/getpropGet System Property (AOSP only)
CorelliumClient.CorelliumApiv1AgentSystemInstallOpenGAppsPOST /v1/instances/{instanceId}/agent/v1/system/install-opengappsInstall OpenGApps (AOSP only)
CorelliumClient.CorelliumApiv1AgentSystemLockPOST /v1/instances/{instanceId}/agent/v1/system/lockLock Device (iOS Only)
CorelliumClient.CorelliumApiv1AgentSystemSetAdbAuthPUT /v1/instances/{instanceId}/agent/v1/system/adbauthSet ADB Auth Setting (AOSP only)
CorelliumClient.CorelliumApiv1AgentSystemShutdownPOST /v1/instances/{instanceId}/agent/v1/system/shutdownInstruct VM to halt
CorelliumClient.CorelliumApiv1AgentSystemUnlockPOST /v1/instances/{instanceId}/agent/v1/system/unlockUnlock Device (iOS Only)
CorelliumClient.CorelliumApiv1AgentUninstallAppPOST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstallUninstall an App
CorelliumClient.CorelliumApiv1AgentUninstallProfileDELETE /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId}Uninstall a Profile from VM
CorelliumClient.CorelliumApiv1AgentUploadFilePUT /v1/instances/{instanceId}/agent/v1/file/device/{filePath}Upload a file to VM
CorelliumClient.CorelliumApiv1AuthLoginPOST /v1/auth/loginLog In
CorelliumClient.CorelliumApiv1BtracePreauthorizeGET /v1/instances/{instanceId}/btrace-authorizePre-authorize an btrace download
CorelliumClient.CorelliumApiv1ClearCoreTraceDELETE /v1/instances/{instanceId}/straceClear CoreTrace logs
CorelliumClient.CorelliumApiv1ClearHyperTraceDELETE /v1/instances/{instanceId}/btraceClear HyperTrace logs
CorelliumClient.CorelliumApiv1ClearHyperTraceHooksPOST /v1/instances/{instanceId}/hooks/clearClear Hooks on an instance
CorelliumClient.CorelliumApiv1ClearInstancePanicsDELETE /v1/instances/{instanceId}/panicsClear Panics
CorelliumClient.CorelliumApiv1CreateHookPOST /v1/instances/{instanceId}/hooksCreate hypervisor hook for Instance
CorelliumClient.CorelliumApiv1CreateImagePOST /v1/imagesCreate a new Image
CorelliumClient.CorelliumApiv1CreateInstancePOST /v1/instancesCreate Instance
CorelliumClient.CorelliumApiv1CreateProjectPOST /v1/projectsCreate a Project
CorelliumClient.CorelliumApiv1CreateSnapshotPOST /v1/instances/{instanceId}/snapshotsCreate Instance Snapshot
CorelliumClient.CorelliumApiv1CreateSubscriberInvitePOST /v1/billing/invitesCreate Subscriber Invite
CorelliumClient.CorelliumApiv1CreateUserPOST /v1/usersCreate User
CorelliumClient.CorelliumApiv1DeleteHookDELETE /v1/hooks/{hookId}Delete an existing hypervisor hook
CorelliumClient.CorelliumApiv1DeleteImageDELETE /v2/images/{imageId}Delete Image
CorelliumClient.CorelliumApiv1DeleteInstanceDELETE /v1/instances/{instanceId}Remove Instance
CorelliumClient.CorelliumApiv1DeleteInstanceSnapshotDELETE /v1/instances/{instanceId}/snapshots/{snapshotId}Delete a Snapshot
CorelliumClient.CorelliumApiv1DeleteProjectDELETE /v1/projects/{projectId}Delete a Project
CorelliumClient.CorelliumApiv1DeleteSnapshotDELETE /v1/snapshots/{snapshotId}Delete a Snapshot
CorelliumClient.CorelliumApiv1DeleteUserDELETE /v1/users/{userId}Delete User
CorelliumClient.CorelliumApiv1DisableExposePortPOST /v1/instances/{instanceId}/exposeport/disableDisable an exposed port on an instance for device access.
CorelliumClient.CorelliumApiv1EnableExposePortPOST /v1/instances/{instanceId}/exposeport/enableEnable an exposed port on an instance for device access.
CorelliumClient.CorelliumApiv1ExecuteHyperTraceHooksPOST /v1/instances/{instanceId}/hooks/executeExecute Hooks on an instance
CorelliumClient.CorelliumApiv1GetHookByIdGET /v1/hooks/{hookId}Get hypervisor hook by id
CorelliumClient.CorelliumApiv1GetHooksGET /v1/instances/{instanceId}/hooksGet all hypervisor hooks for Instance
CorelliumClient.CorelliumApiv1GetImageGET /v1/images/{imageId}Get Image Metadata
CorelliumClient.CorelliumApiv1GetImagesGET /v1/imagesGet all Images Metadata
CorelliumClient.CorelliumApiv1GetInstanceGET /v1/instances/{instanceId}Get Instance
CorelliumClient.CorelliumApiv1GetInstanceConsoleGET /v1/instances/{instanceId}/consoleGet console websocket URL
CorelliumClient.CorelliumApiv1GetInstanceConsoleLogGET /v1/instances/{instanceId}/consoleLogGet Console Log
CorelliumClient.CorelliumApiv1GetInstanceGpiosGET /v1/instances/{instanceId}/gpiosGet Instance GPIOs
CorelliumClient.CorelliumApiv1GetInstancePanicsGET /v1/instances/{instanceId}/panicsGet Panics
CorelliumClient.CorelliumApiv1GetInstancePeripheralsGET /v1/instances/{instanceId}/peripheralsGet Instance Peripherals
CorelliumClient.CorelliumApiv1GetInstanceRateGET /v1/instances/{instanceId}/rateGet rate information
CorelliumClient.CorelliumApiv1GetInstanceScreenshotGET /v1/instances/{instanceId}/screenshot.{format}Get Instance Screenshot
CorelliumClient.CorelliumApiv1GetInstanceSnapshotGET /v1/instances/{instanceId}/snapshots/{snapshotId}Get Instance Snapshot
CorelliumClient.CorelliumApiv1GetInstanceSnapshotsGET /v1/instances/{instanceId}/snapshotsGet Instance Snapshots
CorelliumClient.CorelliumApiv1GetInstancesGET /v1/instancesGet Instances
CorelliumClient.CorelliumApiv1GetModelSoftwareGET /v1/models/{model}/softwareGet Software for Model
CorelliumClient.CorelliumApiv1GetModelsGET /v1/modelsGet Supported Models
CorelliumClient.CorelliumApiv1GetProjectGET /v1/projects/{projectId}Get a Project
CorelliumClient.CorelliumApiv1GetProjectInstancesGET /v1/projects/{projectId}/instancesGet Instances in Project
CorelliumClient.CorelliumApiv1GetProjectKeysGET /v1/projects/{projectId}/keysGet Project Authorized Keys
CorelliumClient.CorelliumApiv1GetProjectVpnConfigGET /v1/projects/{projectId}/vpnconfig/{format}Get Project VPN Configuration
CorelliumClient.CorelliumApiv1GetProjectsGET /v1/projectsGet Projects
CorelliumClient.CorelliumApiv1GetResetLinkInfoGET /v1/users/reset-link-infoSend Password Reset Link Info
CorelliumClient.CorelliumApiv1GetSnapshotGET /v1/snapshots/{snapshotId}Get Snapshot
CorelliumClient.CorelliumApiv1InstancesInstanceIdMessagePostPOST /v1/instances/{instanceId}/messageReceive a message on an iOS vm
CorelliumClient.CorelliumApiv1InstancesInstanceIdNetdumpPcapGetGET /v1/instances/{instanceId}/netdump.pcapDownload a netdump pcap file
CorelliumClient.CorelliumApiv1InstancesInstanceIdNetworkMonitorPcapGetGET /v1/instances/{instanceId}/networkMonitor.pcapDownload a Network Monitor pcap file
CorelliumClient.CorelliumApiv1KcrangeGET /v1/instances/{instanceId}/btrace-kcrangeGet Kernel extension ranges
CorelliumClient.CorelliumApiv1ListThreadsGET /v1/instances/{instanceId}/strace/thread-listGet Running Threads (CoreTrace)
CorelliumClient.CorelliumApiv1MediaPlayPOST /v1/instances/{instanceId}/media/playStart playing media
CorelliumClient.CorelliumApiv1MediaStopPOST /v1/instances/{instanceId}/media/stopStop playing media
CorelliumClient.CorelliumApiv1PatchInstancePATCH /v1/instances/{instanceId}Update Instance
CorelliumClient.CorelliumApiv1PauseInstancePOST /v1/instances/{instanceId}/pausePause an Instance
CorelliumClient.CorelliumApiv1PostInstanceInputPOST /v1/instances/{instanceId}/inputProvide Instance Input
CorelliumClient.CorelliumApiv1ReadyGET /v1/readyAPI Status
CorelliumClient.CorelliumApiv1RebootInstancePOST /v1/instances/{instanceId}/rebootReboot an Instance
CorelliumClient.CorelliumApiv1RemoveProjectKeyDELETE /v1/projects/{projectId}/keys/{keyId}Delete Project Authorized Key
CorelliumClient.CorelliumApiv1RemoveTeamRoleFromProjectDELETE /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId}Remove team role from project
CorelliumClient.CorelliumApiv1RemoveUserFromTeamDELETE /v1/teams/{teamId}/users/{userId}Remove user from team
CorelliumClient.CorelliumApiv1RemoveUserRoleFromProjectDELETE /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId}Remove user role from project
CorelliumClient.CorelliumApiv1RenameInstanceSnapshotPATCH /v1/instances/{instanceId}/snapshots/{snapshotId}Rename a Snapshot
CorelliumClient.CorelliumApiv1ResetUserPasswordPOST /v1/users/reset-passwordReset User Password
CorelliumClient.CorelliumApiv1RestoreBackupPOST /v1/instances/{instanceId}/restoreBackupRestore backup
CorelliumClient.CorelliumApiv1RestoreInstanceSnapshotPOST /v1/instances/{instanceId}/snapshots/{snapshotId}/restoreRestore a Snapshot
CorelliumClient.CorelliumApiv1RolesGET /v1/rolesGet all roles
CorelliumClient.CorelliumApiv1RotateInstancePOST /v1/instances/{instanceId}/rotateRotate device to specified orientation
CorelliumClient.CorelliumApiv1SendUserResetLinkPOST /v1/users/send-reset-linkSend Password Reset Link
CorelliumClient.CorelliumApiv1SetInstanceGpiosPUT /v1/instances/{instanceId}/gpiosSet Instance GPIOs
CorelliumClient.CorelliumApiv1SetInstancePeripheralsPUT /v1/instances/{instanceId}/peripheralsSet Instance Peripherals
CorelliumClient.CorelliumApiv1SetInstanceStatePUT /v1/instances/{instanceId}/stateSet state of Instance
CorelliumClient.CorelliumApiv1SnapshotRenamePATCH /v1/snapshots/{snapshotId}Rename a Snapshot
CorelliumClient.CorelliumApiv1StartCoreTracePOST /v1/instances/{instanceId}/strace/enableStart CoreTrace on an instance
CorelliumClient.CorelliumApiv1StartHyperTracePOST /v1/instances/{instanceId}/btrace/enableStart HyperTrace on an instance
CorelliumClient.CorelliumApiv1StartInstancePOST /v1/instances/{instanceId}/startStart an Instance
CorelliumClient.CorelliumApiv1StartNetdumpPOST /v1/instances/{instanceId}/netdump/enableStart Enhanced Network Monitor on an instance.
CorelliumClient.CorelliumApiv1StartNetworkMonitorPOST /v1/instances/{instanceId}/sslsplit/enableStart Network Monitor on an instance.
CorelliumClient.CorelliumApiv1StopCoreTracePOST /v1/instances/{instanceId}/strace/disableStop CoreTrace on an instance.
CorelliumClient.CorelliumApiv1StopHyperTracePOST /v1/instances/{instanceId}/btrace/disableStop HyperTrace on an instance.
CorelliumClient.CorelliumApiv1StopInstancePOST /v1/instances/{instanceId}/stopStop an Instance
CorelliumClient.CorelliumApiv1StopNetdumpPOST /v1/instances/{instanceId}/netdump/disableStop Enhanced Network Monitor on an instance.
CorelliumClient.CorelliumApiv1StopNetworkMonitorPOST /v1/instances/{instanceId}/sslsplit/disableStop Network Monitor on an instance.
CorelliumClient.CorelliumApiv1TeamChangePATCH /v1/teams/{teamId}Update team
CorelliumClient.CorelliumApiv1TeamCreatePOST /v1/teamsCreate team
CorelliumClient.CorelliumApiv1TeamDeleteDELETE /v1/teams/{teamId}Delete team
CorelliumClient.CorelliumApiv1TeamsGET /v1/teamsGet teams
CorelliumClient.CorelliumApiv1UnpauseInstancePOST /v1/instances/{instanceId}/unpauseUnpause an Instance
CorelliumClient.CorelliumApiv1UpdateHookPUT /v1/hooks/{hookId}Update an existing hypervisor hook
CorelliumClient.CorelliumApiv1UpdateProjectPATCH /v1/projects/{projectId}Update a Project
CorelliumClient.CorelliumApiv1UpdateProjectSettingsPATCH /v1/projects/{projectId}/settingsChange Project Settings
CorelliumClient.CorelliumApiv1UpdateUserPATCH /v1/users/{userId}Update User
CorelliumClient.CorelliumApiv1UpgradeInstancePOST /v1/instances/{instanceId}/upgradeUpgrade iOS version
CorelliumClient.CorelliumApiv1UploadImageDataPOST /v1/images/{imageId}Upload Image Data
CorelliumClient.CorelliumApiv1UserAgreeTermsPOST /v1/users/agreeConsent to the current terms and conditions
CorelliumClient.CorelliumApiv1UsersChangePasswordPostPOST /v1/users/change-passwordChange User Password
CorelliumClient.CorelliumApiv1UsersLoginPOST /v1/users/loginLog In
CorelliumClient.CorelliumApiv2GetInstanceQuickConnectCommandGET /v2/instances/{instanceId}/quickConnectCommandRecommended SSH Command for Quick Connect
CorelliumClient.CorelliumApiv2GetInstanceStateGET /v2/instances/{instanceId}/stateGet state of Instance

Documentation for Models

Documentation for Authorization

BearerAuth

  • Type: Bearer authentication (ApiToken or JWT)

FAQs

Package last updated on 26 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Risky Business Podcast: Why Open Source Software Needs Better Malware Tracking

Security News

Risky Business Podcast: Why Open Source Software Needs Better Malware Tracking

In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.

By Sarah Gooding  -  Nov 20, 2024
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc