{"_id":"@arm-avh/avh-api","_rev":"5-6e0cc157d82d5ad7da036fac57e049a7","name":"@arm-avh/avh-api","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@arm-avh/avh-api","version":"1.0.0","license":"Apache2","_id":"@arm-avh/avh-api@1.0.0","maintainers":[{"name":"sbingner1","email":"sam@corellium.com"},{"name":"sbingner","email":"sam@bingner.com"}],"dist":{"shasum":"435f22aaeda7fd4d48f442d94e23b9766dc0a3a1","tarball":"https://registry.npmjs.org/@arm-avh/avh-api/-/avh-api-1.0.0.tgz","fileCount":39,"integrity":"sha512-KekPtk1kDCiNHbRIQ7mX5FRq+JeoTa4QNAUHE6dQ+Mr/jO36jE9M/jzZx+my0hgRH8ltJLDudwcQRdcIKKDEaw==","signatures":[{"sig":"MEUCIQChNQ7NoCRZZux6ACriId1JWOOFGonoS9x69r+gf7+BvgIgblX0KNnDkpR3aUlZM7v2orAgUQmub/nP4e5AuVZgFf0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":238698,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiZzdQACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqo6w//U505cDAHWAjhW3htVa/4NRS3TurYxGqOOk6PmKzWLoHQ0i4F\r\nIzg3SY/+PaZEKvMcpfBt2uMFcCcx6nK+wtp10m4IcSwg1vxyE3PSSn6l8Qaz\r\npLadrK3ECtMzmtIWj4m3FCFXy6w+3x5TvUBfBzgltFj5CStUaPMeNo0+qVU+\r\nGrlIRqrjhyQINido1J8st2jm2aomWe09A+7yb7AZmOnsz00LnZUcDg8eoaMM\r\nDE9sML8SifH53iXgbjb5Ieu/LBRTIsQGjmpfTW3uUYcYGDAKkWkt3cgJOhsM\r\n2Toy/XxY7IFRdokI1JneOfWKD9k/HrOC9kp2jxzCKvw14sRH9cJSENizr6/j\r\nWk/Ho+M+NRAGlj6WNXGBiJ5Ig/GMsjqRNbXex2FX0YFreN/0E/Axegba/eoS\r\n5PSERKmAG8XLbxNPq7OyfJuy8o9KBk4lLKluXXvWbGo05SS/U89VTgiSlKW6\r\nZPwfLqYU1NuPaHG/i88dnRrRwDu5NWTDM249sGSXcB5CrRfQQ/rdBYngSwuU\r\nnbED3/JbUuU7XZyVhIVspLl0Nz9emIskBlvgcSeVw0DMvCHfo8yrli4yvZL0\r\niKspQv4NVjNvseBA+xQeQiDJ8VqaCWLTl3uBa5FPDmFRlKcGkCvHQHNFuALa\r\nBYOhgAB9l2GFrwlGIOdXL6cQVkYGh9EXDME=\r\n=zgio\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","browser":{"fs":false},"scripts":{"test":"mocha --require @babel/register --recursive","build":"babel src -d dist","prepare":"npm run build"},"_npmUser":{"name":"sbingner","email":"sam@bingner.com"},"_npmVersion":"6.14.10","description":"Arm Virtual Hosting API","directories":{},"_nodeVersion":"14.15.4","dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.0.1","sinon":"^7.2.0","expect.js":"^0.3.1","@babel/core":"^7.0.0","@babel/register":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/avh-api_1.0.0_1650931534560_0.23697380870920437","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@arm-avh/avh-api","version":"1.0.1","license":"Apache-2.0","_id":"@arm-avh/avh-api@1.0.1","maintainers":[{"name":"sbingner1","email":"sam@corellium.com"},{"name":"sbingner","email":"sam@bingner.com"}],"dist":{"shasum":"e462b387ca70ca6bdf643920aca4b967314e0c9b","tarball":"https://registry.npmjs.org/@arm-avh/avh-api/-/avh-api-1.0.1.tgz","fileCount":39,"integrity":"sha512-ZBlwGhBMu3Q4coWb9etIHYq6a5zu3bn4SG1iMVw68b7wP8Tj7zhJQnOWX9WpfqpUy9NfYfwX7D2pSkXG+k8jNA==","signatures":[{"sig":"MEQCIEvTf+6sHb5IIjwealvNQgRDlKKL/b0R7ICBwl0Pfa6jAiAOmcYkRdyokqPQsic4/utqAH2HyJGHtDY0MH1JbBHy8A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":238701,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiZzjKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqMDQ/8DNdmNJaZ/TRr850H/cyyX1sHMGo5pj6iPfjdmGhoCghacNS2\r\nBhCGYxaGeDtNpCHxbz5C2oVsYPysNDwgb8EftpMPEeml9Nw5QPCr3I+viPs1\r\n1SBmz1BTwHuVzxHFCzi9ODBOWwskKn84c+bV3rNx39E/pjl4bnS4jTsdkq3O\r\n8Lo0OEw2bXmb7oZJIgoiH6rn3rdtRj45n69ps95/MemWpoYOH+laI2g5IOSW\r\nOCqGGce92htLSRBvZlhwMnwFYyzs/BivwLdgVpQLZWSkczJB2csrXrIPAm67\r\nK6xJ8LUP8Q6nI+uvIMkkgKXhVIu6nLXP+dcMqlYQJLD4Dlu7OrESXjPqyvhn\r\nfCVwUXv1bOlMh5Baex3YGWsQIAKy6P2vx9jXFGzcd8oIzy/I4MAVwNFTXSl7\r\nFtqzx6Trev1cpi7wYMiCYjdbpaxXpUkJNtnx4GQNvrQ58THhWTUGLVuWaeHM\r\n7SIMc5zbELmPE7BvQXCt/V2m308e1iGHOXXotWfQilgQ7q7wReCFjolUXWWl\r\ndmo7GAGwoKBnW5EqRVTE/jTSAmd0AwVvY7qFHAvlGQpCagDV/mZT9UVShFP6\r\n1YIPDwoePIG1lwX17ZNEVhqMYeSQq20IjJaPYVSxnDv7UY/5xt1kD5fa59cZ\r\nzyyQMT1GmTTZ8psp8ZjmY/LA7O3uf1k6mS4=\r\n=JM8H\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","browser":{"fs":false},"scripts":{"test":"mocha --require @babel/register --recursive","build":"babel src -d dist","prepare":"npm run build"},"_npmUser":{"name":"sbingner","email":"sam@bingner.com"},"_npmVersion":"6.14.10","description":"Arm Virtual Hosting API","directories":{},"_nodeVersion":"14.15.4","dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.0.1","sinon":"^7.2.0","expect.js":"^0.3.1","@babel/core":"^7.0.0","@babel/register":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/avh-api_1.0.1_1650931914155_0.7018767509039461","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@arm-avh/avh-api","version":"1.0.2","license":"Apache-2.0","_id":"@arm-avh/avh-api@1.0.2","maintainers":[{"name":"sbingner","email":"sam@bingner.com"}],"dist":{"shasum":"e49c9e8adbcfea7f84df79bfab8c7cee1997a71a","tarball":"https://registry.npmjs.org/@arm-avh/avh-api/-/avh-api-1.0.2.tgz","fileCount":101,"integrity":"sha512-LWbTo2Jn9L8/KK86YNUR1g0rcb40HBaIXzeR/Cl3THO8+85Of2ZdMi1tsFHkfnsJaMbZgM/FftNx51wGVREb6A==","signatures":[{"sig":"MEUCIBP47xGG8eFa0tKKG1ddUmiqoHK5w8z6ARzp5DIeMpI5AiEAp3KlVho1udWipx+9N9g/7ZBwKLTrs04EeX1v/ns9u78=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":667278,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjmQywACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoMrw/7BL1VyjoWDLhgmbFNR6jnYdZl6NAcE6Jg3vPMCnuUmscHA+FL\r\nD9olQAqnFeQrRF4FbhZsNCIzjpvshQwBHUx6xFPJcHTAsBx1xhd9zkpeVLHB\r\nPjsL/bTloUf4UA+zX8iDYRqUNYudVHOziK4jVXUL8xVSA/pgf9uhCmCYRrx+\r\nqgYrI2rSwBIOKpWxR7N8jkBigSC44IeJ9enaLnzOHDj4fu77+m3KxAgMBM8r\r\nRTMSTfMMsSS2lDxmMUVStYKAbySjxjtKuCXrKMJjWgNbQqF1WKUsEcESJxqv\r\n8WFSyIgPBJs5jlKFPzATEFn/pfbxAxFx0MIrlobcb0mk+7QABXI6/6moVhw+\r\n+2PbbzOXnflXkYf585NCM8ZU81fRor8Ehgva+sIsKDmDypIoe1qsUEyu41Nz\r\ni9c3C7RxbaeH1VcjdOLUoYI08nzQrKmfAj9sF3jMOpOGet4DnGXJDGHoHsJq\r\nvAUcaQ1fzMEHTFLP3TSGiYlNjI7CwwE93/ilXelWUTTZiEL0KTSnhcZYChjL\r\nmbGsMixACKQ3t9sbOngT+tvm/S6slLuT8QLWKnzzeXiaBq0zB7i/ZevHUiA6\r\nNA0AlMhX6iRNNcuk4FXaYUz2LBlVffRj7dZGMTNJCroBZMYV97XayJdGhmMf\r\nW7qOgpBwpp9iD9+BeLyV8ZNdHV8zz7mKtcM=\r\n=JcQx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","browser":{"fs":false},"scripts":{"test":"mocha --require @babel/register --recursive","build":"babel src -d dist","prepare":"npm run build"},"_npmUser":{"name":"sbingner","email":"sam@bingner.com"},"_npmVersion":"6.14.10","description":"Arm Virtual Hosting API","directories":{},"_nodeVersion":"12.20.1","dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.0.1","sinon":"^7.2.0","expect.js":"^0.3.1","@babel/core":"^7.0.0","@babel/register":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/avh-api_1.0.2_1670974640145_0.473415391382914","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-04-26T00:05:34.466Z","modified":"2025-05-09T20:43:18.534Z","1.0.0":"2022-04-26T00:05:36.344Z","1.0.1":"2022-04-26T00:11:54.581Z","1.0.2":"2022-12-13T23:37:20.280Z"},"license":"Apache-2.0","description":"Arm Virtual Hosting API","maintainers":[{"email":"sam@bingner.com","name":"sbingner"},{"email":"matthew@hrshbrgr.net","name":"hershbergien"}],"readme":"# @arm-avh/avh-api\n\nAvhApi - JavaScript client for @arm-avh/avh-api\n\n  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)](https://github.com/ARM-software/avh-api).\n  For a guide on using this interface please see [API Quickstart](https://intercom.help/arm-avh/en/articles/6134791-quickstart-for-the-api-docs)\n  ## Links\n  - [API Quickstart](https://intercom.help/arm-avh/en/articles/6134791-quickstart-for-the-api-docs)\n  - [API Clients (python/javascript)](https://github.com/arm-software/avh-api)\n  \nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 3.15.0-15704\n- Package version: 1.0.2\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install @arm-avh/avh-api --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo 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:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nTo 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:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install GIT_USER_ID/GIT_REPO_ID --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file):\n\n```shell\nbrowserify main.js > bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar AvhApi = require('@arm-avh/avh-api');\n\n\nvar api = new AvhApi.ArmApi()\nvar trialEmail = \"trialEmail_example\"; // {String} Trial Email\napi.trialStatus(trialEmail).then(function(data) {\n  console.log('API called successfully. Returned data: ' + data);\n}, function(error) {\n  console.error(error);\n});\n\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.avh.arm.com/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AvhApi.ArmApi* | [**trialStatus**](docs/ArmApi.md#trialStatus) | **GET** /v1/billing/trial-status/{trialEmail} | Get Trial Status\n*AvhApi.ArmApi* | [**v1AddProjectKey**](docs/ArmApi.md#v1AddProjectKey) | **POST** /v1/projects/{projectId}/keys | Add Project Authorized Key\n*AvhApi.ArmApi* | [**v1AddTeamRoleToProject**](docs/ArmApi.md#v1AddTeamRoleToProject) | **PUT** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Add team role to project\n*AvhApi.ArmApi* | [**v1AddUserRoleToProject**](docs/ArmApi.md#v1AddUserRoleToProject) | **PUT** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Add user role to project\n*AvhApi.ArmApi* | [**v1AddUserToTeam**](docs/ArmApi.md#v1AddUserToTeam) | **PUT** /v1/teams/{teamId}/users/{userId} | Add user to team\n*AvhApi.ArmApi* | [**v1AuthLogin**](docs/ArmApi.md#v1AuthLogin) | **POST** /v1/auth/login | Log In\n*AvhApi.ArmApi* | [**v1BtracePreauthorize**](docs/ArmApi.md#v1BtracePreauthorize) | **GET** /v1/instances/{instanceId}/btrace-authorize | Pre-authorize an btrace download\n*AvhApi.ArmApi* | [**v1ClearCoreTrace**](docs/ArmApi.md#v1ClearCoreTrace) | **DELETE** /v1/instances/{instanceId}/strace | Clear CoreTrace logs\n*AvhApi.ArmApi* | [**v1ClearHyperTrace**](docs/ArmApi.md#v1ClearHyperTrace) | **DELETE** /v1/instances/{instanceId}/btrace | Clear HyperTrace logs\n*AvhApi.ArmApi* | [**v1ClearHyperTraceHooks**](docs/ArmApi.md#v1ClearHyperTraceHooks) | **POST** /v1/instances/{instanceId}/hooks/clear | Clear Hooks on an instance\n*AvhApi.ArmApi* | [**v1ClearInstancePanics**](docs/ArmApi.md#v1ClearInstancePanics) | **DELETE** /v1/instances/{instanceId}/panics | Clear Panics\n*AvhApi.ArmApi* | [**v1CreateHook**](docs/ArmApi.md#v1CreateHook) | **POST** /v1/instances/{instanceId}/hooks | Create hypervisor hook for Instance\n*AvhApi.ArmApi* | [**v1CreateImage**](docs/ArmApi.md#v1CreateImage) | **POST** /v1/images | Create a new Image\n*AvhApi.ArmApi* | [**v1CreateInstance**](docs/ArmApi.md#v1CreateInstance) | **POST** /v1/instances | Create Instance\n*AvhApi.ArmApi* | [**v1CreateProject**](docs/ArmApi.md#v1CreateProject) | **POST** /v1/projects | Create a Project\n*AvhApi.ArmApi* | [**v1CreateSnapshot**](docs/ArmApi.md#v1CreateSnapshot) | **POST** /v1/instances/{instanceId}/snapshots | Create Instance Snapshot\n*AvhApi.ArmApi* | [**v1CreateSubscriberInvite**](docs/ArmApi.md#v1CreateSubscriberInvite) | **POST** /v1/billing/invites | Create Subscriber Invite\n*AvhApi.ArmApi* | [**v1DeleteHook**](docs/ArmApi.md#v1DeleteHook) | **DELETE** /v1/hooks/{hookId} | Delete an existing hypervisor hook\n*AvhApi.ArmApi* | [**v1DeleteImage**](docs/ArmApi.md#v1DeleteImage) | **DELETE** /v2/images/{imageId} | Delete Image\n*AvhApi.ArmApi* | [**v1DeleteInstance**](docs/ArmApi.md#v1DeleteInstance) | **DELETE** /v1/instances/{instanceId} | Remove Instance\n*AvhApi.ArmApi* | [**v1DeleteInstanceSnapshot**](docs/ArmApi.md#v1DeleteInstanceSnapshot) | **DELETE** /v1/instances/{instanceId}/snapshots/{snapshotId} | Delete a Snapshot\n*AvhApi.ArmApi* | [**v1DeleteProject**](docs/ArmApi.md#v1DeleteProject) | **DELETE** /v1/projects/{projectId} | Delete a Project\n*AvhApi.ArmApi* | [**v1DeleteSnapshot**](docs/ArmApi.md#v1DeleteSnapshot) | **DELETE** /v1/snapshots/{snapshotId} | Delete a Snapshot\n*AvhApi.ArmApi* | [**v1DisableExposePort**](docs/ArmApi.md#v1DisableExposePort) | **POST** /v1/instances/{instanceId}/exposeport/disable | Disable an exposed port on an instance for device access.\n*AvhApi.ArmApi* | [**v1EnableExposePort**](docs/ArmApi.md#v1EnableExposePort) | **POST** /v1/instances/{instanceId}/exposeport/enable | Enable an exposed port on an instance for device access.\n*AvhApi.ArmApi* | [**v1ExecuteHyperTraceHooks**](docs/ArmApi.md#v1ExecuteHyperTraceHooks) | **POST** /v1/instances/{instanceId}/hooks/execute | Execute Hooks on an instance\n*AvhApi.ArmApi* | [**v1GetHookById**](docs/ArmApi.md#v1GetHookById) | **GET** /v1/hooks/{hookId} | Get hypervisor hook by id\n*AvhApi.ArmApi* | [**v1GetHooks**](docs/ArmApi.md#v1GetHooks) | **GET** /v1/instances/{instanceId}/hooks | Get all hypervisor hooks for Instance\n*AvhApi.ArmApi* | [**v1GetImage**](docs/ArmApi.md#v1GetImage) | **GET** /v1/images/{imageId} | Get Image Metadata\n*AvhApi.ArmApi* | [**v1GetImages**](docs/ArmApi.md#v1GetImages) | **GET** /v1/images | Get all Images Metadata\n*AvhApi.ArmApi* | [**v1GetInstance**](docs/ArmApi.md#v1GetInstance) | **GET** /v1/instances/{instanceId} | Get Instance\n*AvhApi.ArmApi* | [**v1GetInstanceConsole**](docs/ArmApi.md#v1GetInstanceConsole) | **GET** /v1/instances/{instanceId}/console | Get console websocket URL\n*AvhApi.ArmApi* | [**v1GetInstanceConsoleLog**](docs/ArmApi.md#v1GetInstanceConsoleLog) | **GET** /v1/instances/{instanceId}/consoleLog | Get Console Log\n*AvhApi.ArmApi* | [**v1GetInstanceGpios**](docs/ArmApi.md#v1GetInstanceGpios) | **GET** /v1/instances/{instanceId}/gpios | Get Instance GPIOs\n*AvhApi.ArmApi* | [**v1GetInstancePanics**](docs/ArmApi.md#v1GetInstancePanics) | **GET** /v1/instances/{instanceId}/panics | Get Panics\n*AvhApi.ArmApi* | [**v1GetInstancePeripherals**](docs/ArmApi.md#v1GetInstancePeripherals) | **GET** /v1/instances/{instanceId}/peripherals | Get Instance Peripherals\n*AvhApi.ArmApi* | [**v1GetInstanceQuickConnectCommand**](docs/ArmApi.md#v1GetInstanceQuickConnectCommand) | **GET** /v1/instances/{instanceId}/quickConnectCommand | Recommended SSH Command for Quick Connect\n*AvhApi.ArmApi* | [**v1GetInstanceScreenshot**](docs/ArmApi.md#v1GetInstanceScreenshot) | **GET** /v1/instances/{instanceId}/screenshot.{format} | Get Instance Screenshot\n*AvhApi.ArmApi* | [**v1GetInstanceSnapshot**](docs/ArmApi.md#v1GetInstanceSnapshot) | **GET** /v1/instances/{instanceId}/snapshots/{snapshotId} | Get Instance Snapshot\n*AvhApi.ArmApi* | [**v1GetInstanceSnapshots**](docs/ArmApi.md#v1GetInstanceSnapshots) | **GET** /v1/instances/{instanceId}/snapshots | Get Instance Snapshots\n*AvhApi.ArmApi* | [**v1GetInstanceState**](docs/ArmApi.md#v1GetInstanceState) | **GET** /v1/instances/{instanceId}/state | Get state of Instance\n*AvhApi.ArmApi* | [**v1GetInstances**](docs/ArmApi.md#v1GetInstances) | **GET** /v1/instances | Get Instances\n*AvhApi.ArmApi* | [**v1GetModelSoftware**](docs/ArmApi.md#v1GetModelSoftware) | **GET** /v1/models/{model}/software | Get Software for Model\n*AvhApi.ArmApi* | [**v1GetModels**](docs/ArmApi.md#v1GetModels) | **GET** /v1/models | Get Supported Models\n*AvhApi.ArmApi* | [**v1GetProject**](docs/ArmApi.md#v1GetProject) | **GET** /v1/projects/{projectId} | Get a Project\n*AvhApi.ArmApi* | [**v1GetProjectInstances**](docs/ArmApi.md#v1GetProjectInstances) | **GET** /v1/projects/{projectId}/instances | Get Instances in Project\n*AvhApi.ArmApi* | [**v1GetProjectKeys**](docs/ArmApi.md#v1GetProjectKeys) | **GET** /v1/projects/{projectId}/keys | Get Project Authorized Keys\n*AvhApi.ArmApi* | [**v1GetProjectVpnConfig**](docs/ArmApi.md#v1GetProjectVpnConfig) | **GET** /v1/projects/{projectId}/vpnconfig/{format} | Get Project VPN Configuration\n*AvhApi.ArmApi* | [**v1GetProjects**](docs/ArmApi.md#v1GetProjects) | **GET** /v1/projects | Get Projects\n*AvhApi.ArmApi* | [**v1GetSnapshot**](docs/ArmApi.md#v1GetSnapshot) | **GET** /v1/snapshots/{snapshotId} | Get Snapshot\n*AvhApi.ArmApi* | [**v1Kcrange**](docs/ArmApi.md#v1Kcrange) | **GET** /v1/instances/{instanceId}/btrace-kcrange | Get Kernel extension ranges\n*AvhApi.ArmApi* | [**v1ListThreads**](docs/ArmApi.md#v1ListThreads) | **GET** /v1/instances/{instanceId}/strace/thread-list | Get Running Threads (CoreTrace)\n*AvhApi.ArmApi* | [**v1MediaPlay**](docs/ArmApi.md#v1MediaPlay) | **POST** /v1/instances/{instanceId}/media/play | Start playing media\n*AvhApi.ArmApi* | [**v1MediaStop**](docs/ArmApi.md#v1MediaStop) | **POST** /v1/instances/{instanceId}/media/stop | Stop playing media\n*AvhApi.ArmApi* | [**v1PatchInstance**](docs/ArmApi.md#v1PatchInstance) | **PATCH** /v1/instances/{instanceId} | Update Instance\n*AvhApi.ArmApi* | [**v1PauseInstance**](docs/ArmApi.md#v1PauseInstance) | **POST** /v1/instances/{instanceId}/pause | Pause an Instance\n*AvhApi.ArmApi* | [**v1PostInstanceInput**](docs/ArmApi.md#v1PostInstanceInput) | **POST** /v1/instances/{instanceId}/input | Provide Instance Input\n*AvhApi.ArmApi* | [**v1Ready**](docs/ArmApi.md#v1Ready) | **GET** /v1/ready | API Status\n*AvhApi.ArmApi* | [**v1RebootInstance**](docs/ArmApi.md#v1RebootInstance) | **POST** /v1/instances/{instanceId}/reboot | Reboot an Instance\n*AvhApi.ArmApi* | [**v1RemoveProjectKey**](docs/ArmApi.md#v1RemoveProjectKey) | **DELETE** /v1/projects/{projectId}/keys/{keyId} | Delete Project Authorized Key\n*AvhApi.ArmApi* | [**v1RemoveTeamRoleFromProject**](docs/ArmApi.md#v1RemoveTeamRoleFromProject) | **DELETE** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Remove team role from project\n*AvhApi.ArmApi* | [**v1RemoveUserFromTeam**](docs/ArmApi.md#v1RemoveUserFromTeam) | **DELETE** /v1/teams/{teamId}/users/{userId} | Remove user from team\n*AvhApi.ArmApi* | [**v1RemoveUserRoleFromProject**](docs/ArmApi.md#v1RemoveUserRoleFromProject) | **DELETE** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Remove user role from project\n*AvhApi.ArmApi* | [**v1RenameInstanceSnapshot**](docs/ArmApi.md#v1RenameInstanceSnapshot) | **PATCH** /v1/instances/{instanceId}/snapshots/{snapshotId} | Rename a Snapshot\n*AvhApi.ArmApi* | [**v1RestoreInstanceSnapshot**](docs/ArmApi.md#v1RestoreInstanceSnapshot) | **POST** /v1/instances/{instanceId}/snapshots/{snapshotId}/restore | Restore a Snapshot\n*AvhApi.ArmApi* | [**v1Roles**](docs/ArmApi.md#v1Roles) | **GET** /v1/roles | Get all roles\n*AvhApi.ArmApi* | [**v1SetInstanceGpios**](docs/ArmApi.md#v1SetInstanceGpios) | **PUT** /v1/instances/{instanceId}/gpios | Set Instance GPIOs\n*AvhApi.ArmApi* | [**v1SetInstancePeripherals**](docs/ArmApi.md#v1SetInstancePeripherals) | **PUT** /v1/instances/{instanceId}/peripherals | Set Instance Peripherals\n*AvhApi.ArmApi* | [**v1SetInstanceState**](docs/ArmApi.md#v1SetInstanceState) | **PUT** /v1/instances/{instanceId}/state | Set state of Instance\n*AvhApi.ArmApi* | [**v1SnapshotRename**](docs/ArmApi.md#v1SnapshotRename) | **PATCH** /v1/snapshots/{snapshotId} | Rename a Snapshot\n*AvhApi.ArmApi* | [**v1StartCoreTrace**](docs/ArmApi.md#v1StartCoreTrace) | **POST** /v1/instances/{instanceId}/strace/enable | Start CoreTrace on an instance\n*AvhApi.ArmApi* | [**v1StartHyperTrace**](docs/ArmApi.md#v1StartHyperTrace) | **POST** /v1/instances/{instanceId}/btrace/enable | Start HyperTrace on an instance\n*AvhApi.ArmApi* | [**v1StartInstance**](docs/ArmApi.md#v1StartInstance) | **POST** /v1/instances/{instanceId}/start | Start an Instance\n*AvhApi.ArmApi* | [**v1StartNetworkMonitor**](docs/ArmApi.md#v1StartNetworkMonitor) | **POST** /v1/instances/{instanceId}/sslsplit/enable | Start Network Monitor on an instance.\n*AvhApi.ArmApi* | [**v1StopCoreTrace**](docs/ArmApi.md#v1StopCoreTrace) | **POST** /v1/instances/{instanceId}/strace/disable | Stop CoreTrace on an instance.\n*AvhApi.ArmApi* | [**v1StopHyperTrace**](docs/ArmApi.md#v1StopHyperTrace) | **POST** /v1/instances/{instanceId}/btrace/disable | Stop HyperTrace on an instance.\n*AvhApi.ArmApi* | [**v1StopInstance**](docs/ArmApi.md#v1StopInstance) | **POST** /v1/instances/{instanceId}/stop | Stop an Instance\n*AvhApi.ArmApi* | [**v1StopNetworkMonitor**](docs/ArmApi.md#v1StopNetworkMonitor) | **POST** /v1/instances/{instanceId}/sslsplit/disable | Stop Network Monitor on an instance.\n*AvhApi.ArmApi* | [**v1TeamChange**](docs/ArmApi.md#v1TeamChange) | **PATCH** /v1/teams/{teamId} | Update team\n*AvhApi.ArmApi* | [**v1TeamCreate**](docs/ArmApi.md#v1TeamCreate) | **POST** /v1/teams | Create team\n*AvhApi.ArmApi* | [**v1TeamDelete**](docs/ArmApi.md#v1TeamDelete) | **DELETE** /v1/teams/{teamId} | Delete team\n*AvhApi.ArmApi* | [**v1Teams**](docs/ArmApi.md#v1Teams) | **GET** /v1/teams | Get teams\n*AvhApi.ArmApi* | [**v1UnpauseInstance**](docs/ArmApi.md#v1UnpauseInstance) | **POST** /v1/instances/{instanceId}/unpause | Unpause an Instance\n*AvhApi.ArmApi* | [**v1UpdateHook**](docs/ArmApi.md#v1UpdateHook) | **PUT** /v1/hooks/{hookId} | Update an existing hypervisor hook\n*AvhApi.ArmApi* | [**v1UpdateProject**](docs/ArmApi.md#v1UpdateProject) | **PATCH** /v1/projects/{projectId} | Update a Project\n*AvhApi.ArmApi* | [**v1UpdateProjectSettings**](docs/ArmApi.md#v1UpdateProjectSettings) | **PATCH** /v1/projects/{projectId}/settings | Change Project Settings\n*AvhApi.ArmApi* | [**v1UploadImageData**](docs/ArmApi.md#v1UploadImageData) | **POST** /v1/images/{imageId} | Upload Image Data\n*AvhApi.ArmApi* | [**v1WebPlayerAllowedDomains**](docs/ArmApi.md#v1WebPlayerAllowedDomains) | **GET** /v1/webplayer/allowedDomains | Retrieve the list of allowed domains for all Web Player sessions\n*AvhApi.ArmApi* | [**v1WebPlayerCreateSession**](docs/ArmApi.md#v1WebPlayerCreateSession) | **POST** /v1/webplayer | Create a new Web Player Session\n*AvhApi.ArmApi* | [**v1WebPlayerDestroySession**](docs/ArmApi.md#v1WebPlayerDestroySession) | **DELETE** /v1/webplayer/{sessionId} | Tear down a Web Player Session\n*AvhApi.ArmApi* | [**v1WebPlayerListSessions**](docs/ArmApi.md#v1WebPlayerListSessions) | **GET** /v1/webplayer | List all Web Player sessions\n*AvhApi.ArmApi* | [**v1WebPlayerSessionInfo**](docs/ArmApi.md#v1WebPlayerSessionInfo) | **GET** /v1/webplayer/{sessionId} | Retrieve Web Player Session Information\n\n\n## Documentation for Models\n\n - [AvhApi.Address](docs/Address.md)\n - [AvhApi.AgentApp](docs/AgentApp.md)\n - [AvhApi.AgentAppReadyResponse](docs/AgentAppReadyResponse.md)\n - [AvhApi.AgentAppStatus](docs/AgentAppStatus.md)\n - [AvhApi.AgentAppsList](docs/AgentAppsList.md)\n - [AvhApi.AgentAppsStatusList](docs/AgentAppsStatusList.md)\n - [AvhApi.AgentError](docs/AgentError.md)\n - [AvhApi.AgentIcons](docs/AgentIcons.md)\n - [AvhApi.AgentInstallBody](docs/AgentInstallBody.md)\n - [AvhApi.AgentProfilesReturn](docs/AgentProfilesReturn.md)\n - [AvhApi.AgentSystemAdbAuth](docs/AgentSystemAdbAuth.md)\n - [AvhApi.AgentSystemGetPropBody](docs/AgentSystemGetPropBody.md)\n - [AvhApi.AgentValueReturn](docs/AgentValueReturn.md)\n - [AvhApi.AgreedAck](docs/AgreedAck.md)\n - [AvhApi.ApiConflictError](docs/ApiConflictError.md)\n - [AvhApi.ApiError](docs/ApiError.md)\n - [AvhApi.ApiInternalConsistencyError](docs/ApiInternalConsistencyError.md)\n - [AvhApi.ApiNotFoundError](docs/ApiNotFoundError.md)\n - [AvhApi.ApiToken](docs/ApiToken.md)\n - [AvhApi.Bit](docs/Bit.md)\n - [AvhApi.BtraceEnableOptions](docs/BtraceEnableOptions.md)\n - [AvhApi.Button](docs/Button.md)\n - [AvhApi.CouponOptions](docs/CouponOptions.md)\n - [AvhApi.CreateTeam](docs/CreateTeam.md)\n - [AvhApi.CreatedBy](docs/CreatedBy.md)\n - [AvhApi.Credentials](docs/Credentials.md)\n - [AvhApi.DomainOptions](docs/DomainOptions.md)\n - [AvhApi.Extension](docs/Extension.md)\n - [AvhApi.Features](docs/Features.md)\n - [AvhApi.FileChanges](docs/FileChanges.md)\n - [AvhApi.Firmware](docs/Firmware.md)\n - [AvhApi.GpioStateDefinition](docs/GpioStateDefinition.md)\n - [AvhApi.GpiosState](docs/GpiosState.md)\n - [AvhApi.GrantTrialRequestResponse](docs/GrantTrialRequestResponse.md)\n - [AvhApi.Hook](docs/Hook.md)\n - [AvhApi.Image](docs/Image.md)\n - [AvhApi.Instance](docs/Instance.md)\n - [AvhApi.InstanceBootOptions](docs/InstanceBootOptions.md)\n - [AvhApi.InstanceBootOptionsAdditionalTag](docs/InstanceBootOptionsAdditionalTag.md)\n - [AvhApi.InstanceConsoleEndpoint](docs/InstanceConsoleEndpoint.md)\n - [AvhApi.InstanceCreateOptions](docs/InstanceCreateOptions.md)\n - [AvhApi.InstanceInput](docs/InstanceInput.md)\n - [AvhApi.InstanceNetmonState](docs/InstanceNetmonState.md)\n - [AvhApi.InstanceReturn](docs/InstanceReturn.md)\n - [AvhApi.InstanceServices](docs/InstanceServices.md)\n - [AvhApi.InstanceStartOptions](docs/InstanceStartOptions.md)\n - [AvhApi.InstanceState](docs/InstanceState.md)\n - [AvhApi.InstanceStopOptions](docs/InstanceStopOptions.md)\n - [AvhApi.Invitation](docs/Invitation.md)\n - [AvhApi.InviteRevokeParams](docs/InviteRevokeParams.md)\n - [AvhApi.InviteRevokeParamsIds](docs/InviteRevokeParamsIds.md)\n - [AvhApi.Kcrange](docs/Kcrange.md)\n - [AvhApi.KernelTask](docs/KernelTask.md)\n - [AvhApi.KernelThread](docs/KernelThread.md)\n - [AvhApi.MediaPlayBody](docs/MediaPlayBody.md)\n - [AvhApi.Model](docs/Model.md)\n - [AvhApi.ModelSoftware](docs/ModelSoftware.md)\n - [AvhApi.PasswordChangeBody](docs/PasswordChangeBody.md)\n - [AvhApi.PasswordResetBody](docs/PasswordResetBody.md)\n - [AvhApi.PatchInstanceOptions](docs/PatchInstanceOptions.md)\n - [AvhApi.PeripheralsData](docs/PeripheralsData.md)\n - [AvhApi.Plan](docs/Plan.md)\n - [AvhApi.Project](docs/Project.md)\n - [AvhApi.ProjectKey](docs/ProjectKey.md)\n - [AvhApi.ProjectQuota](docs/ProjectQuota.md)\n - [AvhApi.ProjectSettings](docs/ProjectSettings.md)\n - [AvhApi.ProjectUsage](docs/ProjectUsage.md)\n - [AvhApi.RateInfo](docs/RateInfo.md)\n - [AvhApi.ResetLinkBody](docs/ResetLinkBody.md)\n - [AvhApi.Role](docs/Role.md)\n - [AvhApi.RotateBody](docs/RotateBody.md)\n - [AvhApi.Snapshot](docs/Snapshot.md)\n - [AvhApi.SnapshotCreationOptions](docs/SnapshotCreationOptions.md)\n - [AvhApi.SnapshotStatus](docs/SnapshotStatus.md)\n - [AvhApi.SubscriberInvite](docs/SubscriberInvite.md)\n - [AvhApi.Team](docs/Team.md)\n - [AvhApi.TeamCreate](docs/TeamCreate.md)\n - [AvhApi.TextInput](docs/TextInput.md)\n - [AvhApi.Token](docs/Token.md)\n - [AvhApi.TouchCurveInput](docs/TouchCurveInput.md)\n - [AvhApi.TouchInput](docs/TouchInput.md)\n - [AvhApi.Trial](docs/Trial.md)\n - [AvhApi.TrialExtension](docs/TrialExtension.md)\n - [AvhApi.TrialRequestMetadata](docs/TrialRequestMetadata.md)\n - [AvhApi.TrialRequestOptions](docs/TrialRequestOptions.md)\n - [AvhApi.UpdateExtension](docs/UpdateExtension.md)\n - [AvhApi.User](docs/User.md)\n - [AvhApi.UserError](docs/UserError.md)\n - [AvhApi.V1CreateHookParameters](docs/V1CreateHookParameters.md)\n - [AvhApi.V1LoadExtensionParameters](docs/V1LoadExtensionParameters.md)\n - [AvhApi.V1SetStateBody](docs/V1SetStateBody.md)\n - [AvhApi.ValidationError](docs/ValidationError.md)\n - [AvhApi.VolumeOptions](docs/VolumeOptions.md)\n - [AvhApi.VpnDefinition](docs/VpnDefinition.md)\n - [AvhApi.WebPlayerCreateSessionRequest](docs/WebPlayerCreateSessionRequest.md)\n - [AvhApi.WebPlayerSession](docs/WebPlayerSession.md)\n\n\n## Documentation for Authorization\n\n\n\n### BearerAuth\n\n- **Type**: Bearer authentication (ApiToken or JWT)\n\n","readmeFilename":"README.md"}