https://github.com/corellium/go-corellium-api-client

REST API to manage your virtual devices.
https://github.com/corellium/go-corellium-api-client
Last synced: 29 days ago
JSON representation
REST API to manage your virtual devices.
Host: GitHub
URL: https://github.com/corellium/go-corellium-api-client
Owner: corellium
Created: 2023-10-03T13:08:08.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2025-05-07T19:26:31.000Z (about 1 year ago)
Last Synced: 2025-11-12T08:33:04.717Z (8 months ago)
Language: Shell
Size: 993 KB
Stars: 2
Watchers: 4
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          # Go API client for corellium

REST API to manage your virtual devices.

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 7.3.0-27831

- Package version: 1.0.0

- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```shell

go get github.com/stretchr/testify/assert

go get golang.org/x/net/context

```

Put the package under your project folder and add the following in import:

```golang

import corellium "github.com/corellium/go-corellium-api-client"

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.

```golang

ctx := context.WithValue(context.Background(), corellium.ContextServerIndex, 1)

```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.

```golang

ctx := context.WithValue(context.Background(), corellium.ContextServerVariables, map[string]string{

	"basePath": "v2",

})

```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.

An operation is uniquely identified by `"{classname}Service.{nickname}"` string.

Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

```golang

ctx := context.WithValue(context.Background(), corellium.ContextOperationServerIndices, map[string]int{

	"{classname}Service.{nickname}": 2,

})

ctx = context.WithValue(context.Background(), corellium.ContextOperationServerVariables, map[string]map[string]string{

	"{classname}Service.{nickname}": {

		"port": "8443",

	},

})

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*CorelliumApi* | [**CreateAssessment**](docs/CorelliumApi.md#createassessment) | **Post** /v1/services/matrix/{instanceId}/assessments | Create assessment

*CorelliumApi* | [**DeleteAssessment**](docs/CorelliumApi.md#deleteassessment) | **Delete** /v1/services/matrix/{instanceId}/assessments/{assessmentId} | Delete assessment

*CorelliumApi* | [**DownloadReport**](docs/CorelliumApi.md#downloadreport) | **Get** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/download | Download report

*CorelliumApi* | [**GetAssessmentById**](docs/CorelliumApi.md#getassessmentbyid) | **Get** /v1/services/matrix/{instanceId}/assessments/{assessmentId} | Get assessment by ID

*CorelliumApi* | [**GetAssessmentsByInstanceId**](docs/CorelliumApi.md#getassessmentsbyinstanceid) | **Get** /v1/services/matrix/{instanceId}/instances/{instanceId}/assessments | Get assessments by instanceId

*CorelliumApi* | [**RunTests**](docs/CorelliumApi.md#runtests) | **Post** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/test | Update assessment state and execute MATRIX tests

*CorelliumApi* | [**StartMonitoring**](docs/CorelliumApi.md#startmonitoring) | **Post** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/start | Update assessment state and begin device monitoring

*CorelliumApi* | [**StopMonitoring**](docs/CorelliumApi.md#stopmonitoring) | **Post** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/stop | Update assessment state and stop device monitoring

*CorelliumApi* | [**V1AcceptSharedSnapshot**](docs/CorelliumApi.md#v1acceptsharedsnapshot) | **Post** /v1/snapshots/accept | Accept a snapshot shared with you

*CorelliumApi* | [**V1ActivityExport**](docs/CorelliumApi.md#v1activityexport) | **Post** /v1/activity/export | Start activity export

*CorelliumApi* | [**V1ActivityList**](docs/CorelliumApi.md#v1activitylist) | **Get** /v1/activity | Get resource activities

*CorelliumApi* | [**V1AddProjectKey**](docs/CorelliumApi.md#v1addprojectkey) | **Post** /v1/projects/{projectId}/keys | Add Project Authorized Key

*CorelliumApi* | [**V1AddTeamRoleToProject**](docs/CorelliumApi.md#v1addteamroletoproject) | **Put** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Add team role to project

*CorelliumApi* | [**V1AddUserRoleToProject**](docs/CorelliumApi.md#v1adduserroletoproject) | **Put** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Add user role to project

*CorelliumApi* | [**V1AddUserToTeam**](docs/CorelliumApi.md#v1addusertoteam) | **Put** /v1/teams/{teamId}/users/{userId} | Add user to team

*CorelliumApi* | [**V1AgentAppReady**](docs/CorelliumApi.md#v1agentappready) | **Get** /v1/instances/{instanceId}/agent/v1/app/ready | Check if App subsystem is ready

*CorelliumApi* | [**V1AgentDeleteFile**](docs/CorelliumApi.md#v1agentdeletefile) | **Delete** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Delete a File on VM

*CorelliumApi* | [**V1AgentGetFile**](docs/CorelliumApi.md#v1agentgetfile) | **Get** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Download a File from VM

*CorelliumApi* | [**V1AgentGetTempFilename**](docs/CorelliumApi.md#v1agentgettempfilename) | **Post** /v1/instances/{instanceId}/agent/v1/file/temp | Get the path for a new temp file

*CorelliumApi* | [**V1AgentInstallApp**](docs/CorelliumApi.md#v1agentinstallapp) | **Post** /v1/instances/{instanceId}/agent/v1/app/install | Install App at path

*CorelliumApi* | [**V1AgentInstallProfile**](docs/CorelliumApi.md#v1agentinstallprofile) | **Post** /v1/instances/{instanceId}/agent/v1/profile/install | Install a Profile to VM

*CorelliumApi* | [**V1AgentKillApp**](docs/CorelliumApi.md#v1agentkillapp) | **Post** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill | Kill an App

*CorelliumApi* | [**V1AgentListAppIcons**](docs/CorelliumApi.md#v1agentlistappicons) | **Get** /v1/instances/{instanceId}/agent/v1/app/icons | List App Icons

*CorelliumApi* | [**V1AgentListApps**](docs/CorelliumApi.md#v1agentlistapps) | **Get** /v1/instances/{instanceId}/agent/v1/app/apps | List Apps

*CorelliumApi* | [**V1AgentListAppsStatus**](docs/CorelliumApi.md#v1agentlistappsstatus) | **Get** /v1/instances/{instanceId}/agent/v1/app/apps/update | List Apps Status

*CorelliumApi* | [**V1AgentListProfiles**](docs/CorelliumApi.md#v1agentlistprofiles) | **Get** /v1/instances/{instanceId}/agent/v1/profile/profiles | List Profiles

*CorelliumApi* | [**V1AgentRunApp**](docs/CorelliumApi.md#v1agentrunapp) | **Post** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run | Run an App

*CorelliumApi* | [**V1AgentSetFileAttributes**](docs/CorelliumApi.md#v1agentsetfileattributes) | **Patch** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Change Attrs of a File on VM

*CorelliumApi* | [**V1AgentSystemGetAdbAuth**](docs/CorelliumApi.md#v1agentsystemgetadbauth) | **Get** /v1/instances/{instanceId}/agent/v1/system/adbauth | Get ADB Auth Setting (AOSP only)

*CorelliumApi* | [**V1AgentSystemGetNetwork**](docs/CorelliumApi.md#v1agentsystemgetnetwork) | **Get** /v1/instances/{instanceId}/agent/v1/system/network | Get IP of eth0 (AOSP only)

*CorelliumApi* | [**V1AgentSystemGetProp**](docs/CorelliumApi.md#v1agentsystemgetprop) | **Post** /v1/instances/{instanceId}/agent/v1/system/getprop | Get System Property (AOSP only)

*CorelliumApi* | [**V1AgentSystemInstallOpenGApps**](docs/CorelliumApi.md#v1agentsysteminstallopengapps) | **Post** /v1/instances/{instanceId}/agent/v1/system/install-opengapps | Install OpenGApps (AOSP only)

*CorelliumApi* | [**V1AgentSystemLock**](docs/CorelliumApi.md#v1agentsystemlock) | **Post** /v1/instances/{instanceId}/agent/v1/system/lock | Lock Device (iOS Only)

*CorelliumApi* | [**V1AgentSystemSetAdbAuth**](docs/CorelliumApi.md#v1agentsystemsetadbauth) | **Put** /v1/instances/{instanceId}/agent/v1/system/adbauth | Set ADB Auth Setting (AOSP only)

*CorelliumApi* | [**V1AgentSystemSetHostname**](docs/CorelliumApi.md#v1agentsystemsethostname) | **Post** /v1/instances/{instanceId}/agent/v1/system/setHostname | Set Hostname of instance

*CorelliumApi* | [**V1AgentSystemShutdown**](docs/CorelliumApi.md#v1agentsystemshutdown) | **Post** /v1/instances/{instanceId}/agent/v1/system/shutdown | Instruct VM to halt

*CorelliumApi* | [**V1AgentSystemUnlock**](docs/CorelliumApi.md#v1agentsystemunlock) | **Post** /v1/instances/{instanceId}/agent/v1/system/unlock | Unlock Device (iOS Only)

*CorelliumApi* | [**V1AgentUninstallApp**](docs/CorelliumApi.md#v1agentuninstallapp) | **Post** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall | Uninstall an App

*CorelliumApi* | [**V1AgentUninstallProfile**](docs/CorelliumApi.md#v1agentuninstallprofile) | **Delete** /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId} | Uninstall a Profile from VM

*CorelliumApi* | [**V1AgentUploadFile**](docs/CorelliumApi.md#v1agentuploadfile) | **Put** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Upload a file to VM

*CorelliumApi* | [**V1AuthLogin**](docs/CorelliumApi.md#v1authlogin) | **Post** /v1/auth/login | Log In

*CorelliumApi* | [**V1BtracePreauthorize**](docs/CorelliumApi.md#v1btracepreauthorize) | **Get** /v1/instances/{instanceId}/btrace-authorize | Pre-authorize an btrace download

*CorelliumApi* | [**V1CheckSubdomainExistence**](docs/CorelliumApi.md#v1checksubdomainexistence) | **Post** /v1/domain/check | Check the existence of a subdomain

*CorelliumApi* | [**V1ClearCoreTrace**](docs/CorelliumApi.md#v1clearcoretrace) | **Delete** /v1/instances/{instanceId}/strace | Clear CoreTrace logs

*CorelliumApi* | [**V1ClearHyperTrace**](docs/CorelliumApi.md#v1clearhypertrace) | **Delete** /v1/instances/{instanceId}/btrace | Clear HyperTrace logs

*CorelliumApi* | [**V1ClearHyperTraceHooks**](docs/CorelliumApi.md#v1clearhypertracehooks) | **Post** /v1/instances/{instanceId}/hooks/clear | Clear Hooks on an instance

*CorelliumApi* | [**V1ClearInstancePanics**](docs/CorelliumApi.md#v1clearinstancepanics) | **Delete** /v1/instances/{instanceId}/panics | Clear Panics

*CorelliumApi* | [**V1CreateDomainAuthProvider**](docs/CorelliumApi.md#v1createdomainauthprovider) | **Post** /v1/domain/{domainId}/auth | Create a new auth provider for a domain

*CorelliumApi* | [**V1CreateHook**](docs/CorelliumApi.md#v1createhook) | **Post** /v1/instances/{instanceId}/hooks | Create hypervisor hook for Instance

*CorelliumApi* | [**V1CreateImage**](docs/CorelliumApi.md#v1createimage) | **Post** /v1/images | Create a new Image

*CorelliumApi* | [**V1CreateInstance**](docs/CorelliumApi.md#v1createinstance) | **Post** /v1/instances | Create Instance

*CorelliumApi* | [**V1CreateNetworkConnection**](docs/CorelliumApi.md#v1createnetworkconnection) | **Post** /v1/network/connections | Create a new Network Connection

*CorelliumApi* | [**V1CreateProject**](docs/CorelliumApi.md#v1createproject) | **Post** /v1/projects | Create a Project

*CorelliumApi* | [**V1CreateSnapshot**](docs/CorelliumApi.md#v1createsnapshot) | **Post** /v1/instances/{instanceId}/snapshots | Create Instance Snapshot

*CorelliumApi* | [**V1CreateUser**](docs/CorelliumApi.md#v1createuser) | **Post** /v1/users | Create User

*CorelliumApi* | [**V1DeleteDomainAuthProvider**](docs/CorelliumApi.md#v1deletedomainauthprovider) | **Delete** /v1/domain/{domainId}/auth/{providerId} | Delete an auth provider from a domain

*CorelliumApi* | [**V1DeleteExtension**](docs/CorelliumApi.md#v1deleteextension) | **Delete** /v1/extensions/{extensionId} | Delete an existing extension

*CorelliumApi* | [**V1DeleteHook**](docs/CorelliumApi.md#v1deletehook) | **Delete** /v1/hooks/{hookId} | Delete an existing hypervisor hook

*CorelliumApi* | [**V1DeleteImage**](docs/CorelliumApi.md#v1deleteimage) | **Delete** /v2/images/{imageId} | Delete Image

*CorelliumApi* | [**V1DeleteInstance**](docs/CorelliumApi.md#v1deleteinstance) | **Delete** /v1/instances/{instanceId} | Remove Instance

*CorelliumApi* | [**V1DeleteInstanceSnapshot**](docs/CorelliumApi.md#v1deleteinstancesnapshot) | **Delete** /v1/instances/{instanceId}/snapshots/{snapshotId} | Delete an Instance Snapshot

*CorelliumApi* | [**V1DeleteNetworkConnection**](docs/CorelliumApi.md#v1deletenetworkconnection) | **Delete** /v1/network/connections/{id} | Delete an existing Network Connection

*CorelliumApi* | [**V1DeleteProject**](docs/CorelliumApi.md#v1deleteproject) | **Delete** /v1/projects/{projectId} | Delete a Project

*CorelliumApi* | [**V1DeleteSnapshot**](docs/CorelliumApi.md#v1deletesnapshot) | **Delete** /v1/snapshots/{snapshotId} | Delete a Snapshot

*CorelliumApi* | [**V1DeleteSnapshotPermissions**](docs/CorelliumApi.md#v1deletesnapshotpermissions) | **Delete** /v1/snapshots/{snapshotId}/permissions | Delete member(s)

*CorelliumApi* | [**V1DeleteUser**](docs/CorelliumApi.md#v1deleteuser) | **Delete** /v1/users/{userId} | Delete User

*CorelliumApi* | [**V1DisableExposePort**](docs/CorelliumApi.md#v1disableexposeport) | **Post** /v1/instances/{instanceId}/exposeport/disable | Disable an exposed port on an instance for device access.

*CorelliumApi* | [**V1DownloadActivity**](docs/CorelliumApi.md#v1downloadactivity) | **Get** /v1/activity/export/{taskId}/download | Download activity

*CorelliumApi* | [**V1EnableExposePort**](docs/CorelliumApi.md#v1enableexposeport) | **Post** /v1/instances/{instanceId}/exposeport/enable | Enable an exposed port on an instance for device access.

*CorelliumApi* | [**V1ExecuteHyperTraceHooks**](docs/CorelliumApi.md#v1executehypertracehooks) | **Post** /v1/instances/{instanceId}/hooks/execute | Execute Hooks on an instance

*CorelliumApi* | [**V1GetActivityExportStatus**](docs/CorelliumApi.md#v1getactivityexportstatus) | **Get** /v1/activity/export/{taskId} | Get export task status

*CorelliumApi* | [**V1GetActivityExportTasks**](docs/CorelliumApi.md#v1getactivityexporttasks) | **Get** /v1/activity/export | Get all export tasks for user

*CorelliumApi* | [**V1GetConfig**](docs/CorelliumApi.md#v1getconfig) | **Get** /v1/config | Get all configs

*CorelliumApi* | [**V1GetDomainAuthProviders**](docs/CorelliumApi.md#v1getdomainauthproviders) | **Get** /v1/domain/{domainId}/auth | Return all configured auth providers for a domain (including globally configured providers)

*CorelliumApi* | [**V1GetExtensionById**](docs/CorelliumApi.md#v1getextensionbyid) | **Get** /v1/extensions/{extensionId} | Get extension by id

*CorelliumApi* | [**V1GetExtensions**](docs/CorelliumApi.md#v1getextensions) | **Get** /v1/extensions | Get all extensions

*CorelliumApi* | [**V1GetHookById**](docs/CorelliumApi.md#v1gethookbyid) | **Get** /v1/hooks/{hookId} | Get hypervisor hook by id

*CorelliumApi* | [**V1GetHooks**](docs/CorelliumApi.md#v1gethooks) | **Get** /v1/instances/{instanceId}/hooks | Get all hypervisor hooks for Instance

*CorelliumApi* | [**V1GetImage**](docs/CorelliumApi.md#v1getimage) | **Get** /v1/images/{imageId} | Get Image Metadata

*CorelliumApi* | [**V1GetImages**](docs/CorelliumApi.md#v1getimages) | **Get** /v1/images | Get all Images Metadata

*CorelliumApi* | [**V1GetInstance**](docs/CorelliumApi.md#v1getinstance) | **Get** /v1/instances/{instanceId} | Get Instance

*CorelliumApi* | [**V1GetInstanceConsole**](docs/CorelliumApi.md#v1getinstanceconsole) | **Get** /v1/instances/{instanceId}/console | Get console websocket URL

*CorelliumApi* | [**V1GetInstanceConsoleLog**](docs/CorelliumApi.md#v1getinstanceconsolelog) | **Get** /v1/instances/{instanceId}/consoleLog | Get Console Log

*CorelliumApi* | [**V1GetInstanceGpios**](docs/CorelliumApi.md#v1getinstancegpios) | **Get** /v1/instances/{instanceId}/gpios | Get Instance GPIOs

*CorelliumApi* | [**V1GetInstancePanics**](docs/CorelliumApi.md#v1getinstancepanics) | **Get** /v1/instances/{instanceId}/panics | Get Panics

*CorelliumApi* | [**V1GetInstancePeripherals**](docs/CorelliumApi.md#v1getinstanceperipherals) | **Get** /v1/instances/{instanceId}/peripherals | Get Instance Peripherals

*CorelliumApi* | [**V1GetInstanceScreenshot**](docs/CorelliumApi.md#v1getinstancescreenshot) | **Get** /v1/instances/{instanceId}/screenshot.{format} | Get Instance Screenshot

*CorelliumApi* | [**V1GetInstanceSnapshot**](docs/CorelliumApi.md#v1getinstancesnapshot) | **Get** /v1/instances/{instanceId}/snapshots/{snapshotId} | Get Instance Snapshot

*CorelliumApi* | [**V1GetInstanceSnapshots**](docs/CorelliumApi.md#v1getinstancesnapshots) | **Get** /v1/instances/{instanceId}/snapshots | Get Instance Snapshots

*CorelliumApi* | [**V1GetInstances**](docs/CorelliumApi.md#v1getinstances) | **Get** /v1/instances | Get Instances

*CorelliumApi* | [**V1GetModelSoftware**](docs/CorelliumApi.md#v1getmodelsoftware) | **Get** /v1/models/{model}/software | Get Software for Model

*CorelliumApi* | [**V1GetModels**](docs/CorelliumApi.md#v1getmodels) | **Get** /v1/models | Get Supported Models

*CorelliumApi* | [**V1GetNetworkConnection**](docs/CorelliumApi.md#v1getnetworkconnection) | **Get** /v1/network/connections/{id} | Return the configuration and per project statuses for a single network provider.

*CorelliumApi* | [**V1GetProject**](docs/CorelliumApi.md#v1getproject) | **Get** /v1/projects/{projectId} | Get a Project

*CorelliumApi* | [**V1GetProjectInstances**](docs/CorelliumApi.md#v1getprojectinstances) | **Get** /v1/projects/{projectId}/instances | Get Instances in Project

*CorelliumApi* | [**V1GetProjectKeys**](docs/CorelliumApi.md#v1getprojectkeys) | **Get** /v1/projects/{projectId}/keys | Get Project Authorized Keys

*CorelliumApi* | [**V1GetProjectNetworkLog**](docs/CorelliumApi.md#v1getprojectnetworklog) | **Get** /v1/projects/{projectId}/network/log | Retrieve the network connection log for a project

*CorelliumApi* | [**V1GetProjectNetworkStatus**](docs/CorelliumApi.md#v1getprojectnetworkstatus) | **Get** /v1/projects/{projectId}/network/status | Retrieve the network connection status for a project

*CorelliumApi* | [**V1GetProjectVpnConfig**](docs/CorelliumApi.md#v1getprojectvpnconfig) | **Get** /v1/projects/{projectId}/vpnconfig/{format} | Get Project VPN Configuration

*CorelliumApi* | [**V1GetProjects**](docs/CorelliumApi.md#v1getprojects) | **Get** /v1/projects | Get Projects

*CorelliumApi* | [**V1GetResetLinkInfo**](docs/CorelliumApi.md#v1getresetlinkinfo) | **Get** /v1/users/reset-link-info | Send Password Reset Link Info

*CorelliumApi* | [**V1GetSharedSnapshots**](docs/CorelliumApi.md#v1getsharedsnapshots) | **Get** /v1/snapshots/shared | Fetch shared snapshots

*CorelliumApi* | [**V1GetSnapshot**](docs/CorelliumApi.md#v1getsnapshot) | **Get** /v1/snapshots/{snapshotId} | Get Snapshot

*CorelliumApi* | [**V1InstancesInstanceIdMessagePost**](docs/CorelliumApi.md#v1instancesinstanceidmessagepost) | **Post** /v1/instances/{instanceId}/message | Inject a message into an iOS VM

*CorelliumApi* | [**V1InstancesInstanceIdNetdumpPcapGet**](docs/CorelliumApi.md#v1instancesinstanceidnetdumppcapget) | **Get** /v1/instances/{instanceId}/netdump.pcap | Download a netdump pcap file

*CorelliumApi* | [**V1InstancesInstanceIdNetworkMonitorPcapGet**](docs/CorelliumApi.md#v1instancesinstanceidnetworkmonitorpcapget) | **Get** /v1/instances/{instanceId}/networkMonitor.pcap | Download a Network Monitor pcap file

*CorelliumApi* | [**V1Kcrange**](docs/CorelliumApi.md#v1kcrange) | **Get** /v1/instances/{instanceId}/btrace-kcrange | Get Kernel extension ranges

*CorelliumApi* | [**V1ListNetworkConnections**](docs/CorelliumApi.md#v1listnetworkconnections) | **Get** /v1/network/connections | List available network connections

*CorelliumApi* | [**V1ListNetworkInterfaces**](docs/CorelliumApi.md#v1listnetworkinterfaces) | **Get** /v1/network/interfaces | List available physical network interfaces

*CorelliumApi* | [**V1ListNetworkProviders**](docs/CorelliumApi.md#v1listnetworkproviders) | **Get** /v1/network/providers | List available network providers

*CorelliumApi* | [**V1ListThreads**](docs/CorelliumApi.md#v1listthreads) | **Get** /v1/instances/{instanceId}/strace/thread-list | Get Running Threads (CoreTrace)

*CorelliumApi* | [**V1LoadExtension**](docs/CorelliumApi.md#v1loadextension) | **Post** /v1/extensions | Load an extension

*CorelliumApi* | [**V1MediaPlay**](docs/CorelliumApi.md#v1mediaplay) | **Post** /v1/instances/{instanceId}/media/play | Start playing media

*CorelliumApi* | [**V1MediaStop**](docs/CorelliumApi.md#v1mediastop) | **Post** /v1/instances/{instanceId}/media/stop | Stop playing media

*CorelliumApi* | [**V1ParseExtensionJson**](docs/CorelliumApi.md#v1parseextensionjson) | **Post** /v1/extensions/parse/extension.json | Validates extension.json

*CorelliumApi* | [**V1PartialUpdateNetworkConnection**](docs/CorelliumApi.md#v1partialupdatenetworkconnection) | **Patch** /v1/network/connections/{id} | Update Network Connection (partial)

*CorelliumApi* | [**V1PatchInstance**](docs/CorelliumApi.md#v1patchinstance) | **Patch** /v1/instances/{instanceId} | Update Instance

*CorelliumApi* | [**V1PatchInstanceReadOnly**](docs/CorelliumApi.md#v1patchinstancereadonly) | **Patch** /v1/instances/{instanceId}/read-only | Update Instance Read Only

*CorelliumApi* | [**V1PauseInstance**](docs/CorelliumApi.md#v1pauseinstance) | **Post** /v1/instances/{instanceId}/pause | Pause an Instance

*CorelliumApi* | [**V1PostInstanceInput**](docs/CorelliumApi.md#v1postinstanceinput) | **Post** /v1/instances/{instanceId}/input | Provide Instance Input

*CorelliumApi* | [**V1Ready**](docs/CorelliumApi.md#v1ready) | **Get** /v1/ready | API Status

*CorelliumApi* | [**V1RebootInstance**](docs/CorelliumApi.md#v1rebootinstance) | **Post** /v1/instances/{instanceId}/reboot | Reboot an Instance

*CorelliumApi* | [**V1RemoveProjectKey**](docs/CorelliumApi.md#v1removeprojectkey) | **Delete** /v1/projects/{projectId}/keys/{keyId} | Delete Project Authorized Key

*CorelliumApi* | [**V1RemoveTeamRoleFromProject**](docs/CorelliumApi.md#v1removeteamrolefromproject) | **Delete** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Remove team role from project

*CorelliumApi* | [**V1RemoveUserFromTeam**](docs/CorelliumApi.md#v1removeuserfromteam) | **Delete** /v1/teams/{teamId}/users/{userId} | Remove user from team

*CorelliumApi* | [**V1RemoveUserRoleFromProject**](docs/CorelliumApi.md#v1removeuserrolefromproject) | **Delete** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Remove user role from project

*CorelliumApi* | [**V1RenameInstanceSnapshot**](docs/CorelliumApi.md#v1renameinstancesnapshot) | **Patch** /v1/instances/{instanceId}/snapshots/{snapshotId} | Rename an Instance Snapshot

*CorelliumApi* | [**V1ResetUserPassword**](docs/CorelliumApi.md#v1resetuserpassword) | **Post** /v1/users/reset-password | Reset User Password

*CorelliumApi* | [**V1RestoreBackup**](docs/CorelliumApi.md#v1restorebackup) | **Post** /v1/instances/{instanceId}/restoreBackup | Restore backup

*CorelliumApi* | [**V1RestoreInstanceSnapshot**](docs/CorelliumApi.md#v1restoreinstancesnapshot) | **Post** /v1/instances/{instanceId}/snapshots/{snapshotId}/restore | Restore an Instance Snapshot

*CorelliumApi* | [**V1Roles**](docs/CorelliumApi.md#v1roles) | **Get** /v1/roles | Get all roles

*CorelliumApi* | [**V1RotateInstance**](docs/CorelliumApi.md#v1rotateinstance) | **Post** /v1/instances/{instanceId}/rotate | Rotate device to specified orientation

*CorelliumApi* | [**V1SendUserResetLink**](docs/CorelliumApi.md#v1senduserresetlink) | **Post** /v1/users/send-reset-link | Send Password Reset Link

*CorelliumApi* | [**V1SetInstanceGpios**](docs/CorelliumApi.md#v1setinstancegpios) | **Put** /v1/instances/{instanceId}/gpios | Set Instance GPIOs

*CorelliumApi* | [**V1SetInstancePeripherals**](docs/CorelliumApi.md#v1setinstanceperipherals) | **Put** /v1/instances/{instanceId}/peripherals | Set Instance Peripherals

*CorelliumApi* | [**V1SetInstanceState**](docs/CorelliumApi.md#v1setinstancestate) | **Put** /v1/instances/{instanceId}/state | Set state of Instance

*CorelliumApi* | [**V1SetSnapshotPermissions**](docs/CorelliumApi.md#v1setsnapshotpermissions) | **Post** /v1/snapshots/{snapshotId}/permissions | Set member list

*CorelliumApi* | [**V1ShareSnapshot**](docs/CorelliumApi.md#v1sharesnapshot) | **Post** /v1/snapshots/{snapshotId}/share | Share snapshot

*CorelliumApi* | [**V1SnapshotRename**](docs/CorelliumApi.md#v1snapshotrename) | **Patch** /v1/snapshots/{snapshotId} | Rename a Snapshot

*CorelliumApi* | [**V1StartCoreTrace**](docs/CorelliumApi.md#v1startcoretrace) | **Post** /v1/instances/{instanceId}/strace/enable | Start CoreTrace on an instance

*CorelliumApi* | [**V1StartHyperTrace**](docs/CorelliumApi.md#v1starthypertrace) | **Post** /v1/instances/{instanceId}/btrace/enable | Start HyperTrace on an instance

*CorelliumApi* | [**V1StartInstance**](docs/CorelliumApi.md#v1startinstance) | **Post** /v1/instances/{instanceId}/start | Start an Instance

*CorelliumApi* | [**V1StartNetdump**](docs/CorelliumApi.md#v1startnetdump) | **Post** /v1/instances/{instanceId}/netdump/enable | Start Enhanced Network Monitor on an instance.

*CorelliumApi* | [**V1StartNetworkMonitor**](docs/CorelliumApi.md#v1startnetworkmonitor) | **Post** /v1/instances/{instanceId}/sslsplit/enable | Start Network Monitor on an instance.

*CorelliumApi* | [**V1StopCoreTrace**](docs/CorelliumApi.md#v1stopcoretrace) | **Post** /v1/instances/{instanceId}/strace/disable | Stop CoreTrace on an instance.

*CorelliumApi* | [**V1StopHyperTrace**](docs/CorelliumApi.md#v1stophypertrace) | **Post** /v1/instances/{instanceId}/btrace/disable | Stop HyperTrace on an instance.

*CorelliumApi* | [**V1StopInstance**](docs/CorelliumApi.md#v1stopinstance) | **Post** /v1/instances/{instanceId}/stop | Stop an Instance

*CorelliumApi* | [**V1StopNetdump**](docs/CorelliumApi.md#v1stopnetdump) | **Post** /v1/instances/{instanceId}/netdump/disable | Stop Enhanced Network Monitor on an instance.

*CorelliumApi* | [**V1StopNetworkMonitor**](docs/CorelliumApi.md#v1stopnetworkmonitor) | **Post** /v1/instances/{instanceId}/sslsplit/disable | Stop Network Monitor on an instance.

*CorelliumApi* | [**V1TeamChange**](docs/CorelliumApi.md#v1teamchange) | **Patch** /v1/teams/{teamId} | Update team

*CorelliumApi* | [**V1TeamCreate**](docs/CorelliumApi.md#v1teamcreate) | **Post** /v1/teams | Create team

*CorelliumApi* | [**V1TeamDelete**](docs/CorelliumApi.md#v1teamdelete) | **Delete** /v1/teams/{teamId} | Delete team

*CorelliumApi* | [**V1Teams**](docs/CorelliumApi.md#v1teams) | **Get** /v1/teams | Get teams

*CorelliumApi* | [**V1UnpauseInstance**](docs/CorelliumApi.md#v1unpauseinstance) | **Post** /v1/instances/{instanceId}/unpause | Unpause an Instance

*CorelliumApi* | [**V1UpdateDomainAuthProvider**](docs/CorelliumApi.md#v1updatedomainauthprovider) | **Put** /v1/domain/{domainId}/auth/{providerId} | Update an auth provider for a domain

*CorelliumApi* | [**V1UpdateExtension**](docs/CorelliumApi.md#v1updateextension) | **Put** /v1/extensions/{extensionId} | Update an existing extension

*CorelliumApi* | [**V1UpdateHook**](docs/CorelliumApi.md#v1updatehook) | **Put** /v1/hooks/{hookId} | Update an existing hypervisor hook

*CorelliumApi* | [**V1UpdateNetworkConnection**](docs/CorelliumApi.md#v1updatenetworkconnection) | **Put** /v1/network/connections/{id} | Update Network Connection

*CorelliumApi* | [**V1UpdateProject**](docs/CorelliumApi.md#v1updateproject) | **Patch** /v1/projects/{projectId} | Update a Project

*CorelliumApi* | [**V1UpdateProjectSettings**](docs/CorelliumApi.md#v1updateprojectsettings) | **Patch** /v1/projects/{projectId}/settings | Change Project Settings

*CorelliumApi* | [**V1UpdateUser**](docs/CorelliumApi.md#v1updateuser) | **Patch** /v1/users/{userId} | Update User

*CorelliumApi* | [**V1UpgradeInstance**](docs/CorelliumApi.md#v1upgradeinstance) | **Post** /v1/instances/{instanceId}/upgrade | Upgrade iOS version

*CorelliumApi* | [**V1UploadImageData**](docs/CorelliumApi.md#v1uploadimagedata) | **Post** /v1/images/{imageId} | Upload Image Data

*CorelliumApi* | [**V1UserAgreeTerms**](docs/CorelliumApi.md#v1useragreeterms) | **Post** /v1/users/agree | Consent to the current terms and conditions

*CorelliumApi* | [**V1UsersChangePasswordPost**](docs/CorelliumApi.md#v1userschangepasswordpost) | **Post** /v1/users/change-password | Change User Password

*CorelliumApi* | [**V1UsersLogin**](docs/CorelliumApi.md#v1userslogin) | **Post** /v1/users/login | Log In

*CorelliumApi* | [**V1WebPlayerAllowedDomains**](docs/CorelliumApi.md#v1webplayeralloweddomains) | **Get** /v1/webplayer/allowedDomains | Retrieve the list of allowed domains for all Webplayer sessions

*CorelliumApi* | [**V1WebPlayerCreateSession**](docs/CorelliumApi.md#v1webplayercreatesession) | **Post** /v1/webplayer | Create a new Webplayer Session

*CorelliumApi* | [**V1WebPlayerDestroySession**](docs/CorelliumApi.md#v1webplayerdestroysession) | **Delete** /v1/webplayer/{sessionId} | Tear down a Webplayer Session

*CorelliumApi* | [**V1WebPlayerListSessions**](docs/CorelliumApi.md#v1webplayerlistsessions) | **Get** /v1/webplayer | List all Webplayer sessions

*CorelliumApi* | [**V1WebPlayerSessionInfo**](docs/CorelliumApi.md#v1webplayersessioninfo) | **Get** /v1/webplayer/{sessionId} | Retrieve Webplayer Session Information

*CorelliumApi* | [**V2GetInstanceQuickConnectCommand**](docs/CorelliumApi.md#v2getinstancequickconnectcommand) | **Get** /v2/instances/{instanceId}/quickConnectCommand | Recommended SSH Command for Quick Connect

*CorelliumApi* | [**V2GetInstanceState**](docs/CorelliumApi.md#v2getinstancestate) | **Get** /v2/instances/{instanceId}/state | Get state of Instance

## Documentation For Models

 - [Activity](docs/Activity.md)

 - [ActivityExportDto](docs/ActivityExportDto.md)

 - [ActivityExportResponse](docs/ActivityExportResponse.md)

 - [ActivityList](docs/ActivityList.md)

 - [ActivityRequest](docs/ActivityRequest.md)

 - [Address](docs/Address.md)

 - [AgentApp](docs/AgentApp.md)

 - [AgentAppReadyResponse](docs/AgentAppReadyResponse.md)

 - [AgentAppStatus](docs/AgentAppStatus.md)

 - [AgentAppsList](docs/AgentAppsList.md)

 - [AgentAppsStatusList](docs/AgentAppsStatusList.md)

 - [AgentError](docs/AgentError.md)

 - [AgentIcons](docs/AgentIcons.md)

 - [AgentInstallBody](docs/AgentInstallBody.md)

 - [AgentProfilesReturn](docs/AgentProfilesReturn.md)

 - [AgentSystemAdbAuth](docs/AgentSystemAdbAuth.md)

 - [AgentSystemGetPropBody](docs/AgentSystemGetPropBody.md)

 - [AgentSystemSetHostnameBody](docs/AgentSystemSetHostnameBody.md)

 - [AgentValueReturn](docs/AgentValueReturn.md)

 - [AgreedAck](docs/AgreedAck.md)

 - [AllowedDomainsResponse](docs/AllowedDomainsResponse.md)

 - [ApiConflictError](docs/ApiConflictError.md)

 - [ApiError](docs/ApiError.md)

 - [ApiInternalConsistencyError](docs/ApiInternalConsistencyError.md)

 - [ApiNotFoundError](docs/ApiNotFoundError.md)

 - [ApiToken](docs/ApiToken.md)

 - [Assessment](docs/Assessment.md)

 - [AssessmentIdStatus](docs/AssessmentIdStatus.md)

 - [AuthProvider](docs/AuthProvider.md)

 - [Bit](docs/Bit.md)

 - [BtraceEnableOptions](docs/BtraceEnableOptions.md)

 - [Button](docs/Button.md)

 - [CheckSubdomainResponse](docs/CheckSubdomainResponse.md)

 - [ConfigResponse](docs/ConfigResponse.md)

 - [ConfigResponseMaintenance](docs/ConfigResponseMaintenance.md)

 - [CouponOptions](docs/CouponOptions.md)

 - [CreateAssessmentDto](docs/CreateAssessmentDto.md)

 - [CreateNetworkConnectionOptions](docs/CreateNetworkConnectionOptions.md)

 - [CreateTeam](docs/CreateTeam.md)

 - [CreatedBy](docs/CreatedBy.md)

 - [Credentials](docs/Credentials.md)

 - [DomainAuthProviderRequest](docs/DomainAuthProviderRequest.md)

 - [DomainAuthProviderResponse](docs/DomainAuthProviderResponse.md)

 - [DomainOptions](docs/DomainOptions.md)

 - [Extension](docs/Extension.md)

 - [Features](docs/Features.md)

 - [FileChanges](docs/FileChanges.md)

 - [Firmware](docs/Firmware.md)

 - [GetAssessmentsByInstanceId500Response](docs/GetAssessmentsByInstanceId500Response.md)

 - [GpioStateDefinition](docs/GpioStateDefinition.md)

 - [GpiosState](docs/GpiosState.md)

 - [GrantTrialRequestResponse](docs/GrantTrialRequestResponse.md)

 - [Hook](docs/Hook.md)

 - [Image](docs/Image.md)

 - [InputResponse](docs/InputResponse.md)

 - [Instance](docs/Instance.md)

 - [InstanceAgentState](docs/InstanceAgentState.md)

 - [InstanceBootOptions](docs/InstanceBootOptions.md)

 - [InstanceBootOptionsAdditionalTag](docs/InstanceBootOptionsAdditionalTag.md)

 - [InstanceConsoleEndpoint](docs/InstanceConsoleEndpoint.md)

 - [InstanceCreateOptions](docs/InstanceCreateOptions.md)

 - [InstanceInput](docs/InstanceInput.md)

 - [InstanceNetdumpState](docs/InstanceNetdumpState.md)

 - [InstanceNetmonState](docs/InstanceNetmonState.md)

 - [InstanceReturn](docs/InstanceReturn.md)

 - [InstanceServices](docs/InstanceServices.md)

 - [InstanceStartOptions](docs/InstanceStartOptions.md)

 - [InstanceState](docs/InstanceState.md)

 - [InstanceStopOptions](docs/InstanceStopOptions.md)

 - [InstanceUpgradeBody](docs/InstanceUpgradeBody.md)

 - [Invitation](docs/Invitation.md)

 - [InviteRevokeParams](docs/InviteRevokeParams.md)

 - [InviteRevokeParamsIds](docs/InviteRevokeParamsIds.md)

 - [Kcrange](docs/Kcrange.md)

 - [KernelTask](docs/KernelTask.md)

 - [KernelThread](docs/KernelThread.md)

 - [Logging](docs/Logging.md)

 - [Maintenance](docs/Maintenance.md)

 - [MediaPlayBody](docs/MediaPlayBody.md)

 - [MeteredSubscriptionUsage](docs/MeteredSubscriptionUsage.md)

 - [Model](docs/Model.md)

 - [ModelSoftware](docs/ModelSoftware.md)

 - [NetdumpFilter](docs/NetdumpFilter.md)

 - [NetworkConnection](docs/NetworkConnection.md)

 - [NetworkConnectionOffsetPaginationResult](docs/NetworkConnectionOffsetPaginationResult.md)

 - [NetworkConnectionProvider](docs/NetworkConnectionProvider.md)

 - [NetworkConnectionProviderOffsetPaginationResult](docs/NetworkConnectionProviderOffsetPaginationResult.md)

 - [NetworkStatusResponse](docs/NetworkStatusResponse.md)

 - [OpenIDConfig](docs/OpenIDConfig.md)

 - [Pagination](docs/Pagination.md)

 - [PasswordChangeBody](docs/PasswordChangeBody.md)

 - [PasswordResetBody](docs/PasswordResetBody.md)

 - [PatchInstanceOptions](docs/PatchInstanceOptions.md)

 - [PatchInstanceReadOnly](docs/PatchInstanceReadOnly.md)

 - [PeripheralsData](docs/PeripheralsData.md)

 - [Plan](docs/Plan.md)

 - [PostShareSnapshotRequestPayload](docs/PostShareSnapshotRequestPayload.md)

 - [Project](docs/Project.md)

 - [ProjectKey](docs/ProjectKey.md)

 - [ProjectNetworkState](docs/ProjectNetworkState.md)

 - [ProjectQuota](docs/ProjectQuota.md)

 - [ProjectSettings](docs/ProjectSettings.md)

 - [ProjectUsage](docs/ProjectUsage.md)

 - [ProxyConfig](docs/ProxyConfig.md)

 - [ResetLinkBody](docs/ResetLinkBody.md)

 - [Role](docs/Role.md)

 - [RotateBody](docs/RotateBody.md)

 - [SharedSnapshotsInfo](docs/SharedSnapshotsInfo.md)

 - [Snapshot](docs/Snapshot.md)

 - [SnapshotCreationOptions](docs/SnapshotCreationOptions.md)

 - [SnapshotMember](docs/SnapshotMember.md)

 - [SnapshotOwner](docs/SnapshotOwner.md)

 - [SnapshotPermissionsRequestPayload](docs/SnapshotPermissionsRequestPayload.md)

 - [SnapshotSharing](docs/SnapshotSharing.md)

 - [SnapshotSharingPermissions](docs/SnapshotSharingPermissions.md)

 - [SnapshotStatus](docs/SnapshotStatus.md)

 - [SslsplitFilter](docs/SslsplitFilter.md)

 - [SubscriberInvite](docs/SubscriberInvite.md)

 - [Team](docs/Team.md)

 - [TeamCreate](docs/TeamCreate.md)

 - [TestAssessmentDto](docs/TestAssessmentDto.md)

 - [TextInput](docs/TextInput.md)

 - [Token](docs/Token.md)

 - [TouchCurveInput](docs/TouchCurveInput.md)

 - [TouchInput](docs/TouchInput.md)

 - [TouchInputButtonsInner](docs/TouchInputButtonsInner.md)

 - [Trial](docs/Trial.md)

 - [TrialExtension](docs/TrialExtension.md)

 - [TrialRequestMetadata](docs/TrialRequestMetadata.md)

 - [TrialRequestOptions](docs/TrialRequestOptions.md)

 - [UpdateAssessmentDto](docs/UpdateAssessmentDto.md)

 - [UpdateExtension](docs/UpdateExtension.md)

 - [UpdateNetworkConnectionOptions](docs/UpdateNetworkConnectionOptions.md)

 - [User](docs/User.md)

 - [UserError](docs/UserError.md)

 - [UserSnapshots](docs/UserSnapshots.md)

 - [V1CheckSubdomainExistenceParameters](docs/V1CheckSubdomainExistenceParameters.md)

 - [V1CreateHookParameters](docs/V1CreateHookParameters.md)

 - [V1LoadExtensionParameters](docs/V1LoadExtensionParameters.md)

 - [V1SetStateBody](docs/V1SetStateBody.md)

 - [ValidationError](docs/ValidationError.md)

 - [VolumeOptions](docs/VolumeOptions.md)

 - [VpnDefinition](docs/VpnDefinition.md)

 - [WebPlayerCreateSessionRequest](docs/WebPlayerCreateSessionRequest.md)

 - [WebPlayerSession](docs/WebPlayerSession.md)

## Documentation For Authorization

### BearerAuth

- **Type**: HTTP Bearer token authentication

Example

```golang

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")

r, err := client.Service.Operation(auth, args)

```

## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains

a number of utility functions to easily obtain pointers to values of basic types.

Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`

* `PtrInt`

* `PtrInt32`

* `PtrInt64`

* `PtrFloat`

* `PtrFloat32`

* `PtrFloat64`

* `PtrString`

* `PtrTime`

## Author
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/corellium/go-corellium-api-client

Awesome Lists containing this project

README
