@arm-avh/avh-api

AvhApi - JavaScript client for @arm-avh/avh-api

This documents the Arm Virtual Hosting REST API. For other examples and API clients such as python or javascript please see API Clients (python/javascript). For a guide on using this interface please see API Quickstart

Links

• API Quickstart
• API Clients (python/javascript)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.15.0-15704
• Package version: 1.0.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 @arm-avh/avh-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 @arm-avh/avh-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 AvhApi = require('@arm-avh/avh-api');


var api = new AvhApi.ArmApi()
var trialEmail = "trialEmail_example"; // {String} Trial Email
api.trialStatus(trialEmail).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.avh.arm.com/api

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AvhApi.ArmApi | trialStatus | GET /v1/billing/trial-status/{trialEmail} | Get Trial Status AvhApi.ArmApi | v1AddProjectKey | POST /v1/projects/{projectId}/keys | Add Project Authorized Key AvhApi.ArmApi | v1AddTeamRoleToProject | PUT /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Add team role to project AvhApi.ArmApi | v1AddUserRoleToProject | PUT /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Add user role to project AvhApi.ArmApi | v1AddUserToTeam | PUT /v1/teams/{teamId}/users/{userId} | Add user to team AvhApi.ArmApi | v1AuthLogin | POST /v1/auth/login | Log In AvhApi.ArmApi | v1BtracePreauthorize | GET /v1/instances/{instanceId}/btrace-authorize | Pre-authorize an btrace download AvhApi.ArmApi | v1ClearCoreTrace | DELETE /v1/instances/{instanceId}/strace | Clear CoreTrace logs AvhApi.ArmApi | v1ClearHyperTrace | DELETE /v1/instances/{instanceId}/btrace | Clear HyperTrace logs AvhApi.ArmApi | v1ClearHyperTraceHooks | POST /v1/instances/{instanceId}/hooks/clear | Clear Hooks on an instance AvhApi.ArmApi | v1ClearInstancePanics | DELETE /v1/instances/{instanceId}/panics | Clear Panics AvhApi.ArmApi | v1CreateHook | POST /v1/instances/{instanceId}/hooks | Create hypervisor hook for Instance AvhApi.ArmApi | v1CreateImage | POST /v1/images | Create a new Image AvhApi.ArmApi | v1CreateInstance | POST /v1/instances | Create Instance AvhApi.ArmApi | v1CreateProject | POST /v1/projects | Create a Project AvhApi.ArmApi | v1CreateSnapshot | POST /v1/instances/{instanceId}/snapshots | Create Instance Snapshot AvhApi.ArmApi | v1CreateSubscriberInvite | POST /v1/billing/invites | Create Subscriber Invite AvhApi.ArmApi | v1DeleteHook | DELETE /v1/hooks/{hookId} | Delete an existing hypervisor hook AvhApi.ArmApi | v1DeleteImage | DELETE /v2/images/{imageId} | Delete Image AvhApi.ArmApi | v1DeleteInstance | DELETE /v1/instances/{instanceId} | Remove Instance AvhApi.ArmApi | v1DeleteInstanceSnapshot | DELETE /v1/instances/{instanceId}/snapshots/{snapshotId} | Delete a Snapshot AvhApi.ArmApi | v1DeleteProject | DELETE /v1/projects/{projectId} | Delete a Project AvhApi.ArmApi | v1DeleteSnapshot | DELETE /v1/snapshots/{snapshotId} | Delete a Snapshot AvhApi.ArmApi | v1DisableExposePort | POST /v1/instances/{instanceId}/exposeport/disable | Disable an exposed port on an instance for device access. AvhApi.ArmApi | v1EnableExposePort | POST /v1/instances/{instanceId}/exposeport/enable | Enable an exposed port on an instance for device access. AvhApi.ArmApi | v1ExecuteHyperTraceHooks | POST /v1/instances/{instanceId}/hooks/execute | Execute Hooks on an instance AvhApi.ArmApi | v1GetHookById | GET /v1/hooks/{hookId} | Get hypervisor hook by id AvhApi.ArmApi | v1GetHooks | GET /v1/instances/{instanceId}/hooks | Get all hypervisor hooks for Instance AvhApi.ArmApi | v1GetImage | GET /v1/images/{imageId} | Get Image Metadata AvhApi.ArmApi | v1GetImages | GET /v1/images | Get all Images Metadata AvhApi.ArmApi | v1GetInstance | GET /v1/instances/{instanceId} | Get Instance AvhApi.ArmApi | v1GetInstanceConsole | GET /v1/instances/{instanceId}/console | Get console websocket URL AvhApi.ArmApi | v1GetInstanceConsoleLog | GET /v1/instances/{instanceId}/consoleLog | Get Console Log AvhApi.ArmApi | v1GetInstanceGpios | GET /v1/instances/{instanceId}/gpios | Get Instance GPIOs AvhApi.ArmApi | v1GetInstancePanics | GET /v1/instances/{instanceId}/panics | Get Panics AvhApi.ArmApi | v1GetInstancePeripherals | GET /v1/instances/{instanceId}/peripherals | Get Instance Peripherals AvhApi.ArmApi | v1GetInstanceQuickConnectCommand | GET /v1/instances/{instanceId}/quickConnectCommand | Recommended SSH Command for Quick Connect AvhApi.ArmApi | v1GetInstanceScreenshot | GET /v1/instances/{instanceId}/screenshot.{format} | Get Instance Screenshot AvhApi.ArmApi | v1GetInstanceSnapshot | GET /v1/instances/{instanceId}/snapshots/{snapshotId} | Get Instance Snapshot AvhApi.ArmApi | v1GetInstanceSnapshots | GET /v1/instances/{instanceId}/snapshots | Get Instance Snapshots AvhApi.ArmApi | v1GetInstanceState | GET /v1/instances/{instanceId}/state | Get state of Instance AvhApi.ArmApi | v1GetInstances | GET /v1/instances | Get Instances AvhApi.ArmApi | v1GetModelSoftware | GET /v1/models/{model}/software | Get Software for Model AvhApi.ArmApi | v1GetModels | GET /v1/models | Get Supported Models AvhApi.ArmApi | v1GetProject | GET /v1/projects/{projectId} | Get a Project AvhApi.ArmApi | v1GetProjectInstances | GET /v1/projects/{projectId}/instances | Get Instances in Project AvhApi.ArmApi | v1GetProjectKeys | GET /v1/projects/{projectId}/keys | Get Project Authorized Keys AvhApi.ArmApi | v1GetProjectVpnConfig | GET /v1/projects/{projectId}/vpnconfig/{format} | Get Project VPN Configuration AvhApi.ArmApi | v1GetProjects | GET /v1/projects | Get Projects AvhApi.ArmApi | v1GetSnapshot | GET /v1/snapshots/{snapshotId} | Get Snapshot AvhApi.ArmApi | v1Kcrange | GET /v1/instances/{instanceId}/btrace-kcrange | Get Kernel extension ranges AvhApi.ArmApi | v1ListThreads | GET /v1/instances/{instanceId}/strace/thread-list | Get Running Threads (CoreTrace) AvhApi.ArmApi | v1MediaPlay | POST /v1/instances/{instanceId}/media/play | Start playing media AvhApi.ArmApi | v1MediaStop | POST /v1/instances/{instanceId}/media/stop | Stop playing media AvhApi.ArmApi | v1PatchInstance | PATCH /v1/instances/{instanceId} | Update Instance AvhApi.ArmApi | v1PauseInstance | POST /v1/instances/{instanceId}/pause | Pause an Instance AvhApi.ArmApi | v1PostInstanceInput | POST /v1/instances/{instanceId}/input | Provide Instance Input AvhApi.ArmApi | v1Ready | GET /v1/ready | API Status AvhApi.ArmApi | v1RebootInstance | POST /v1/instances/{instanceId}/reboot | Reboot an Instance AvhApi.ArmApi | v1RemoveProjectKey | DELETE /v1/projects/{projectId}/keys/{keyId} | Delete Project Authorized Key AvhApi.ArmApi | v1RemoveTeamRoleFromProject | DELETE /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Remove team role from project AvhApi.ArmApi | v1RemoveUserFromTeam | DELETE /v1/teams/{teamId}/users/{userId} | Remove user from team AvhApi.ArmApi | v1RemoveUserRoleFromProject | DELETE /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Remove user role from project AvhApi.ArmApi | v1RenameInstanceSnapshot | PATCH /v1/instances/{instanceId}/snapshots/{snapshotId} | Rename a Snapshot AvhApi.ArmApi | v1RestoreInstanceSnapshot | POST /v1/instances/{instanceId}/snapshots/{snapshotId}/restore | Restore a Snapshot AvhApi.ArmApi | v1Roles | GET /v1/roles | Get all roles AvhApi.ArmApi | v1SetInstanceGpios | PUT /v1/instances/{instanceId}/gpios | Set Instance GPIOs AvhApi.ArmApi | v1SetInstancePeripherals | PUT /v1/instances/{instanceId}/peripherals | Set Instance Peripherals AvhApi.ArmApi | v1SetInstanceState | PUT /v1/instances/{instanceId}/state | Set state of Instance AvhApi.ArmApi | v1SnapshotRename | PATCH /v1/snapshots/{snapshotId} | Rename a Snapshot AvhApi.ArmApi | v1StartCoreTrace | POST /v1/instances/{instanceId}/strace/enable | Start CoreTrace on an instance AvhApi.ArmApi | v1StartHyperTrace | POST /v1/instances/{instanceId}/btrace/enable | Start HyperTrace on an instance AvhApi.ArmApi | v1StartInstance | POST /v1/instances/{instanceId}/start | Start an Instance AvhApi.ArmApi | v1StartNetworkMonitor | POST /v1/instances/{instanceId}/sslsplit/enable | Start Network Monitor on an instance. AvhApi.ArmApi | v1StopCoreTrace | POST /v1/instances/{instanceId}/strace/disable | Stop CoreTrace on an instance. AvhApi.ArmApi | v1StopHyperTrace | POST /v1/instances/{instanceId}/btrace/disable | Stop HyperTrace on an instance. AvhApi.ArmApi | v1StopInstance | POST /v1/instances/{instanceId}/stop | Stop an Instance AvhApi.ArmApi | v1StopNetworkMonitor | POST /v1/instances/{instanceId}/sslsplit/disable | Stop Network Monitor on an instance. AvhApi.ArmApi | v1TeamChange | PATCH /v1/teams/{teamId} | Update team AvhApi.ArmApi | v1TeamCreate | POST /v1/teams | Create team AvhApi.ArmApi | v1TeamDelete | DELETE /v1/teams/{teamId} | Delete team AvhApi.ArmApi | v1Teams | GET /v1/teams | Get teams AvhApi.ArmApi | v1UnpauseInstance | POST /v1/instances/{instanceId}/unpause | Unpause an Instance AvhApi.ArmApi | v1UpdateHook | PUT /v1/hooks/{hookId} | Update an existing hypervisor hook AvhApi.ArmApi | v1UpdateProject | PATCH /v1/projects/{projectId} | Update a Project AvhApi.ArmApi | v1UpdateProjectSettings | PATCH /v1/projects/{projectId}/settings | Change Project Settings AvhApi.ArmApi | v1UploadImageData | POST /v1/images/{imageId} | Upload Image Data AvhApi.ArmApi | v1WebPlayerAllowedDomains | GET /v1/webplayer/allowedDomains | Retrieve the list of allowed domains for all Web Player sessions AvhApi.ArmApi | v1WebPlayerCreateSession | POST /v1/webplayer | Create a new Web Player Session AvhApi.ArmApi | v1WebPlayerDestroySession | DELETE /v1/webplayer/{sessionId} | Tear down a Web Player Session AvhApi.ArmApi | v1WebPlayerListSessions | GET /v1/webplayer | List all Web Player sessions AvhApi.ArmApi | v1WebPlayerSessionInfo | GET /v1/webplayer/{sessionId} | Retrieve Web Player Session Information

Documentation for Models

• AvhApi.Address
• AvhApi.AgentApp
• AvhApi.AgentAppReadyResponse
• AvhApi.AgentAppStatus
• AvhApi.AgentAppsList
• AvhApi.AgentAppsStatusList
• AvhApi.AgentError
• AvhApi.AgentIcons
• AvhApi.AgentInstallBody
• AvhApi.AgentProfilesReturn
• AvhApi.AgentSystemAdbAuth
• AvhApi.AgentSystemGetPropBody
• AvhApi.AgentValueReturn
• AvhApi.AgreedAck
• AvhApi.ApiConflictError
• AvhApi.ApiError
• AvhApi.ApiInternalConsistencyError
• AvhApi.ApiNotFoundError
• AvhApi.ApiToken
• AvhApi.Bit
• AvhApi.BtraceEnableOptions
• AvhApi.Button
• AvhApi.CouponOptions
• AvhApi.CreateTeam
• AvhApi.CreatedBy
• AvhApi.Credentials
• AvhApi.DomainOptions
• AvhApi.Extension
• AvhApi.Features
• AvhApi.FileChanges
• AvhApi.Firmware
• AvhApi.GpioStateDefinition
• AvhApi.GpiosState
• AvhApi.GrantTrialRequestResponse
• AvhApi.Hook
• AvhApi.Image
• AvhApi.Instance
• AvhApi.InstanceBootOptions
• AvhApi.InstanceBootOptionsAdditionalTag
• AvhApi.InstanceConsoleEndpoint
• AvhApi.InstanceCreateOptions
• AvhApi.InstanceInput
• AvhApi.InstanceNetmonState
• AvhApi.InstanceReturn
• AvhApi.InstanceServices
• AvhApi.InstanceStartOptions
• AvhApi.InstanceState
• AvhApi.InstanceStopOptions
• AvhApi.Invitation
• AvhApi.InviteRevokeParams
• AvhApi.InviteRevokeParamsIds
• AvhApi.Kcrange
• AvhApi.KernelTask
• AvhApi.KernelThread
• AvhApi.MediaPlayBody
• AvhApi.Model
• AvhApi.ModelSoftware
• AvhApi.PasswordChangeBody
• AvhApi.PasswordResetBody
• AvhApi.PatchInstanceOptions
• AvhApi.PeripheralsData
• AvhApi.Plan
• AvhApi.Project
• AvhApi.ProjectKey
• AvhApi.ProjectQuota
• AvhApi.ProjectSettings
• AvhApi.ProjectUsage
• AvhApi.RateInfo
• AvhApi.ResetLinkBody
• AvhApi.Role
• AvhApi.RotateBody
• AvhApi.Snapshot
• AvhApi.SnapshotCreationOptions
• AvhApi.SnapshotStatus
• AvhApi.SubscriberInvite
• AvhApi.Team
• AvhApi.TeamCreate
• AvhApi.TextInput
• AvhApi.Token
• AvhApi.TouchCurveInput
• AvhApi.TouchInput
• AvhApi.Trial
• AvhApi.TrialExtension
• AvhApi.TrialRequestMetadata
• AvhApi.TrialRequestOptions
• AvhApi.UpdateExtension
• AvhApi.User
• AvhApi.UserError
• AvhApi.V1CreateHookParameters
• AvhApi.V1LoadExtensionParameters
• AvhApi.V1SetStateBody
• AvhApi.ValidationError
• AvhApi.VolumeOptions
• AvhApi.VpnDefinition
• AvhApi.WebPlayerCreateSessionRequest
• AvhApi.WebPlayerSession

Documentation for Authorization

BearerAuth

• Type: Bearer authentication (ApiToken or JWT)