Skip to content

About

Golang Language API Client for Corellium

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

2 stars

Watchers

4 watching

Forks

1 fork
Report repository
BranchesTags

Latest commit

 

History

44 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
.openapi-generator
.openapi-generator
 
 
api
api
 
 
docs
docs
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
api_activity.go
api_activity.go
 
 
api_activity_v1.go
api_activity_v1.go
 
 
api_agent.go
api_agent.go
 
 
api_agent_v1.go
api_agent_v1.go
 
 
api_assessments.go
api_assessments.go
 
 
api_assessments_v1.go
api_assessments_v1.go
 
 
api_authentication.go
api_authentication.go
 
 
api_authentication_v1.go
api_authentication_v1.go
 
 
api_billing.go
api_billing.go
 
 
api_cluster.go
api_cluster.go
 
 
api_cluster_administration_config.go
api_cluster_administration_config.go
 
 
api_cluster_administration_firmware_service.go
api_cluster_administration_firmware_service.go
 
 
api_cluster_administration_nodes.go
api_cluster_administration_nodes.go
 
 
api_cluster_snapshots.go
api_cluster_snapshots.go
 
 
api_config.go
api_config.go
 
 
api_config_v1.go
api_config_v1.go
 
 
api_core_trace.go
api_core_trace.go
 
 
api_core_trace_v1.go
api_core_trace_v1.go
 
 
api_domain.go
api_domain.go
 
 
api_domain_auth_provider.go
api_domain_auth_provider.go
 
 
api_domain_auth_providers.go
api_domain_auth_providers.go
 
 
api_domain_v1.go
api_domain_v1.go
 
 
api_extensions.go
api_extensions.go
 
 
api_extensions_v1.go
api_extensions_v1.go
 
 
api_external_services.go
api_external_services.go
 
 
api_firmware_service.go
api_firmware_service.go
 
 
api_flavors.go
api_flavors.go
 
 
api_hyper_trace.go
api_hyper_trace.go
 
 
api_hyper_trace_v1.go
api_hyper_trace_v1.go
 
 
api_hypertune.go
api_hypertune.go
 
 
api_hypervisor_hooks.go
api_hypervisor_hooks.go
 
 
api_hypervisor_hooks_v1.go
api_hypervisor_hooks_v1.go
 
 
api_images.go
api_images.go
 
 
api_images_v1.go
api_images_v1.go
 
 
api_images_v2.go
api_images_v2.go
 
 
api_instances.go
api_instances.go
 
 
api_instances_v1.go
api_instances_v1.go
 
 
api_instances_v2.go
api_instances_v2.go
 
 
api_interconnects.go
api_interconnects.go
 
 
api_interconnects_v1.go
api_interconnects_v1.go
 
 
api_invites.go
api_invites.go
 
 
api_invites_v1.go
api_invites_v1.go
 
 
api_models.go
api_models.go
 
 
api_models_v1.go
api_models_v1.go
 
 
api_net_connect.go
api_net_connect.go
 
 
api_net_connect_v1.go
api_net_connect_v1.go
 
 
api_projects.go
api_projects.go
 
 
api_projects_v1.go
api_projects_v1.go
 
 
api_ram_dump.go
api_ram_dump.go
 
 
api_ram_dump_v1.go
api_ram_dump_v1.go
 
 
api_roles.go
api_roles.go
 
 
api_roles_v1.go
api_roles_v1.go
 
 
api_snapshot_sharing.go
api_snapshot_sharing.go
 
 
api_snapshot_sharing_v1.go
api_snapshot_sharing_v1.go
 
 
api_snapshots.go
api_snapshots.go
 
 
api_snapshots_v1.go
api_snapshots_v1.go
 
 
api_status.go
api_status.go
 
 
api_status_v1.go
api_status_v1.go
 
 
api_storage.go
api_storage.go
 
 
api_storage_v1.go
api_storage_v1.go
 
 
api_teams.go
api_teams.go
 
 
api_teams_v1.go
api_teams_v1.go
 
 
api_totp.go
api_totp.go
 
 
api_users.go
api_users.go
 
 
api_users_v1.go
api_users_v1.go
 
 
api_web_player.go
api_web_player.go
 
 
api_web_player_v1.go
api_web_player_v1.go
 
 
client.go
client.go
 
 
configuration.go
configuration.go
 
 
corellium_client.go
corellium_client.go
 
 
git_push.sh
git_push.sh
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
model_accept_snapshot_body.go
model_accept_snapshot_body.go
 
 
model_accept_snapshot_request_payload.go
model_accept_snapshot_request_payload.go
 
 
model_account_setup_response.go
model_account_setup_response.go
 
 
model_activity.go
model_activity.go
 
 
model_activity_export_dto.go
model_activity_export_dto.go
 
 
model_activity_export_format.go
model_activity_export_format.go
 
 
model_activity_export_response.go
model_activity_export_response.go
 
 
model_activity_export_status.go
model_activity_export_status.go
 
 
model_activity_export_task.go
model_activity_export_task.go
 
 
model_activity_export_task_list.go
model_activity_export_task_list.go
 
 
model_activity_list.go
model_activity_list.go
 
 
model_activity_list_response.go
model_activity_list_response.go
 
 
model_activity_request.go
model_activity_request.go
 
 
model_activity_resource_not_starts_with_filter.go
model_activity_resource_not_starts_with_filter.go
 
 
model_activity_resource_starts_with_filter.go
model_activity_resource_starts_with_filter.go
 
 
model_activity_v1.go
model_activity_v1.go
 
 
model_address.go
model_address.go
 
 

Repository files navigation

Go API client for corellium

REST API to manage your virtual devices.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 0.1.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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:

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

To use a proxy, set the environment variable HTTP_PROXY:

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 corellium.ContextServerIndex of type int.

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 corellium.ContextServerVariables of type map[string]string.

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 corellium.ContextOperationServerIndices and corellium.ContextOperationServerVariables context maps.

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",
	},
})

Quick start

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	client := corellium.NewCorelliumClient(corellium.NewConfiguration())

	// Authenticate with a Corellium API token (or JWT bearer), read from the
	// context per request. basePath defaults to https://app.corellium.com/api.
	ctx := context.WithValue(context.Background(), corellium.ContextAccessToken, os.Getenv("CORELLIUM_API_TOKEN"))

	instances, _, err := client.Instances.List(ctx).Execute()
	if err != nil {
		panic(err)
	}
	fmt.Println(instances)
}

Authentication

The access token is a Corellium API token or JWT bearer, supplied per request through the corellium.ContextAccessToken context value:

ctx := context.WithValue(context.Background(), corellium.ContextAccessToken, "<token>")

No token is required for public endpoints (login, auth-provider metadata). If you only have credentials, log in first to obtain a token — note that Username holds your account email:

client := corellium.NewCorelliumClient(corellium.NewConfiguration())
res, _, err := client.Auth.Login(context.Background()).LoginBody(corellium.LoginBody{
	Username: corellium.PtrString("me@example.com"),
	Password: corellium.PtrString("..."),
}).Execute()
if err != nil {
	panic(err)
}
ctx := context.WithValue(context.Background(), corellium.ContextAccessToken, res.Token)

Namespaces & versioning

Operations are grouped into namespaces: client.Instances.*, client.Projects.*, client.Snapshots.*, and so on.

  • Unversioned paths (client.Instances.List) resolve to the latest version of each operation — a per-operation blend.
  • Pinned paths (client.V1.*, client.V3.*) bind to a specific version forever.
client.Instances.List(ctx).Execute()     // latest
client.V3.Instances.List(ctx).Execute()  // pinned to v3

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivityAPI V3CreateActivityExport Post /v3/activity/export Start activity export
ActivityAPI V3DownloadActivity Get /v3/activity/export/{taskId}/download Download activity for a given task
ActivityAPI V3GetActivityExportStatus Get /v3/activity/export/{taskId} Get export task status
ActivityAPI V3GetActivityExportTasks Get /v3/activity/export Get all export tasks for user
ActivityAPI V3ListActivities Get /v3/activity Get resource activities
ActivityV1API V1ActivityExport Post /v1/activity/export Start activity export
ActivityV1API V1ActivityList Get /v1/activity Get resource activities
ActivityV1API V1DownloadActivity Get /v1/activity/export/{taskId}/download Download activity
ActivityV1API V1GetActivityExportStatus Get /v1/activity/export/{taskId} Get export task status
ActivityV1API V1GetActivityExportTasks Get /v1/activity/export Get all export tasks for user
AgentAPI V3DeleteFileAgent Delete /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Delete a file on VM
AgentAPI V3GetAdbAuthAgent Get /v3/instances/{instanceId}/agent/v1/system/adbauth Get ADB auth setting
AgentAPI V3GetAppReadyAgent Get /v3/instances/{instanceId}/agent/v1/app/ready Check if app subsystem is ready
AgentAPI V3GetContainerHealthAgent Get /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/is-healthy Get container health
AgentAPI V3GetFileAgent Get /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Download a file from VM
AgentAPI V3GetNetworkAgent Get /v3/instances/{instanceId}/agent/v1/system/network Get eth0 IP address
AgentAPI V3GetPropAgent Post /v3/instances/{instanceId}/agent/v1/system/getprop Get a system property
AgentAPI V3GetRemoteItStatusAgent Get /v3/instances/{instanceId}/agent/v1/remoteit/status Get Remote.It status
AgentAPI V3GetTempFileAgent Post /v3/instances/{instanceId}/agent/v1/file/temp Get a temp file path on VM
AgentAPI V3InstallAgent Post /v3/instances/{instanceId}/agent/v1/app/install Install app at path
AgentAPI V3InstallOpenGappsAgent Post /v3/instances/{instanceId}/agent/v1/system/install-opengapps Install OpenGApps
AgentAPI V3InstallProfileAgent Post /v3/instances/{instanceId}/agent/v1/profile/install Install a profile
AgentAPI V3InstallRemoteItAgent Post /v3/instances/{instanceId}/agent/v1/remoteit/install Install Remote.It
AgentAPI V3KillAppAgent Post /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill Kill an app
AgentAPI V3KillFridaAgent Post /v3/instances/{instanceId}/agent/v1/frida/run-frida-kill Kill Frida
AgentAPI V3ListAppIconsAgent Get /v3/instances/{instanceId}/agent/v1/app/icons List app icons
AgentAPI V3ListAppsAgent Get /v3/instances/{instanceId}/agent/v1/app/apps List apps
AgentAPI V3ListAppsStatusAgent Get /v3/instances/{instanceId}/agent/v1/app/apps/update List apps status
AgentAPI V3ListContainersAgent Get /v3/instances/{instanceId}/agent/v1/container/containers List containers
AgentAPI V3ListFridaProcessesAgent Post /v3/instances/{instanceId}/agent/v1/frida/run-frida-ps List Frida processes
AgentAPI V3ListProfilesAgent Get /v3/instances/{instanceId}/agent/v1/profile/profiles List profiles
AgentAPI V3LockAgent Post /v3/instances/{instanceId}/agent/v1/system/lock Lock device
AgentAPI V3PreauthorizeFileArchiveDownloadAgent Post /v3/instances/{instanceId}/agent-authorize/v1/file/download Pre-authorize an archive download from VM
AgentAPI V3PreauthorizeFileDownloadAgent Post /v3/instances/{instanceId}/agent-authorize/v1/file/device/{filePath} Pre-authorize a file download from VM
AgentAPI V3RunAppAgent Post /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run Run an app
AgentAPI V3RunFridaAgent Post /v3/instances/{instanceId}/agent/v1/frida/run-frida Run Frida
AgentAPI V3SetAdbAuthAgent Put /v3/instances/{instanceId}/agent/v1/system/adbauth Set ADB auth setting
AgentAPI V3SetDevicePropertiesAgent Post /v3/instances/{instanceId}/agent/v1/system/setDeviceProperties Set device properties
AgentAPI V3SetFileAttributesAgent Patch /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Change attributes of a file on VM
AgentAPI V3SetHostnameAgent Post /v3/instances/{instanceId}/agent/v1/system/setHostname Set instance hostname
AgentAPI V3ShutdownAgent Post /v3/instances/{instanceId}/agent/v1/system/shutdown Shut down instance
AgentAPI V3StartContainerAgent Post /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start Start a container
AgentAPI V3StartContainerAppAgent Post /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application/{packageName}/{activityName} Start an app in a container
AgentAPI V3StartContainerAppMonitoredAgent Post /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application-and-monitor/{packageName}/{activityName} Start and monitor an app in a container
AgentAPI V3StopContainerAgent Post /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop Stop a container
AgentAPI V3StopContainerAppAgent Post /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop-application-if-monitored Stop a monitored app in a container
AgentAPI V3UninstallAppAgent Post /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall Uninstall an app
AgentAPI V3UninstallProfileAgent Delete /v3/instances/{instanceId}/agent/v1/profile/profiles/{profileId} Uninstall a profile
AgentAPI V3UninstallRemoteItAgent Post /v3/instances/{instanceId}/agent/v1/remoteit/uninstall Uninstall Remote.It
AgentAPI V3UnlockAgent Post /v3/instances/{instanceId}/agent/v1/system/unlock Unlock device
AgentAPI V3UploadFileAgent Put /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Upload a file to VM
AgentV1API V1AgentAppReady Get /v1/instances/{instanceId}/agent/v1/app/ready Check if App subsystem is ready
AgentV1API V1AgentDeleteFile Delete /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Delete a File on VM
AgentV1API V1AgentGetFile Get /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Download a File from VM
AgentV1API V1AgentGetTempFilename Post /v1/instances/{instanceId}/agent/v1/file/temp Get the path for a new temp file
AgentV1API V1AgentInstallApp Post /v1/instances/{instanceId}/agent/v1/app/install Install App at path
AgentV1API V1AgentInstallProfile Post /v1/instances/{instanceId}/agent/v1/profile/install Install a Profile to VM
AgentV1API V1AgentKillApp Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill Kill an App
AgentV1API V1AgentListAppIcons Get /v1/instances/{instanceId}/agent/v1/app/icons List App Icons
AgentV1API V1AgentListApps Get /v1/instances/{instanceId}/agent/v1/app/apps List Apps
AgentV1API V1AgentListAppsStatus Get /v1/instances/{instanceId}/agent/v1/app/apps/update List Apps Status
AgentV1API V1AgentListProfiles Get /v1/instances/{instanceId}/agent/v1/profile/profiles List Profiles
AgentV1API V1AgentRunApp Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run Run an App
AgentV1API V1AgentSetFileAttributes Patch /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Change Attrs of a File on VM
AgentV1API V1AgentSystemGetAdbAuth Get /v1/instances/{instanceId}/agent/v1/system/adbauth Get ADB Auth Setting (AOSP only)
AgentV1API V1AgentSystemGetNetwork Get /v1/instances/{instanceId}/agent/v1/system/network Get IP of eth0 (AOSP only)
AgentV1API V1AgentSystemGetProp Post /v1/instances/{instanceId}/agent/v1/system/getprop Get System Property (AOSP only)
AgentV1API V1AgentSystemInstallOpenGApps Post /v1/instances/{instanceId}/agent/v1/system/install-opengapps Install OpenGApps (AOSP only)
AgentV1API V1AgentSystemLock Post /v1/instances/{instanceId}/agent/v1/system/lock Lock Device (iOS Only)
AgentV1API V1AgentSystemSetAdbAuth Put /v1/instances/{instanceId}/agent/v1/system/adbauth Set ADB Auth Setting (AOSP only)
AgentV1API V1AgentSystemSetHostname Post /v1/instances/{instanceId}/agent/v1/system/setHostname Set Hostname of instance
AgentV1API V1AgentSystemShutdown Post /v1/instances/{instanceId}/agent/v1/system/shutdown Instruct VM to halt
AgentV1API V1AgentSystemUnlock Post /v1/instances/{instanceId}/agent/v1/system/unlock Unlock Device (iOS Only)
AgentV1API V1AgentUninstallApp Post /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall Uninstall an App
AgentV1API V1AgentUninstallProfile Delete /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId} Uninstall a Profile from VM
AgentV1API V1AgentUploadFile Put /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Upload a file to VM
AssessmentsAPI V3CreateAssessment Post /v3/services/matrix/{instanceId}/assessments Create an assessment.
AssessmentsAPI V3CreateReportModification Post /v3/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Create report modifications.
AssessmentsAPI V3DeleteAssessment Delete /v3/services/matrix/{instanceId}/assessments/{assessmentId} Delete an assessment.
AssessmentsAPI V3DeleteReportModification Delete /v3/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Delete report modifications.
AssessmentsAPI V3DownloadReport Get /v3/services/matrix/{instanceId}/assessments/{assessmentId}/download Download an assessment report.
AssessmentsAPI V3GetAssessmentById Get /v3/services/matrix/{instanceId}/assessments/{assessmentId} Get an assessment by ID.
AssessmentsAPI V3GetAssessmentsByInstanceId Get /v3/services/matrix/{instanceId}/instances/{targetInstanceId}/assessments List assessments for an instance.
AssessmentsAPI V3PatchAssessment Patch /v3/services/matrix/{instanceId}/assessments/{assessmentId} Update an assessment status.
AssessmentsAPI V3RunTests Post /v3/services/matrix/{instanceId}/assessments/{assessmentId}/test Run assessment tests.
AssessmentsAPI V3StartMonitoring Post /v3/services/matrix/{instanceId}/assessments/{assessmentId}/start Start assessment monitoring.
AssessmentsAPI V3StopMonitoring Post /v3/services/matrix/{instanceId}/assessments/{assessmentId}/stop Stop assessment monitoring.
AssessmentsV1API V1CreateAssessment Post /v1/services/matrix/{instanceId}/assessments Create an assessment.
AssessmentsV1API V1CreateReportModification Post /v1/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Create report modifications.
AssessmentsV1API V1DeleteAssessment Delete /v1/services/matrix/{instanceId}/assessments/{assessmentId} Delete an assessment.
AssessmentsV1API V1DeleteReportModification Delete /v1/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Delete report modifications.
AssessmentsV1API V1DownloadReport Get /v1/services/matrix/{instanceId}/assessments/{assessmentId}/download Download an assessment report.
AssessmentsV1API V1GetAssessmentById Get /v1/services/matrix/{instanceId}/assessments/{assessmentId} Get an assessment by ID.
AssessmentsV1API V1GetAssessmentsByInstanceId Get /v1/services/matrix/{instanceId}/instances/{targetInstanceId}/assessments List assessments for an instance.
AssessmentsV1API V1PatchAssessment Patch /v1/services/matrix/{instanceId}/assessments/{assessmentId} Update an assessment status.
AssessmentsV1API V1RunTests Post /v1/services/matrix/{instanceId}/assessments/{assessmentId}/test Run assessment tests.
AssessmentsV1API V1StartMonitoring Post /v1/services/matrix/{instanceId}/assessments/{assessmentId}/start Start assessment monitoring.
AssessmentsV1API V1StopMonitoring Post /v1/services/matrix/{instanceId}/assessments/{assessmentId}/stop Stop assessment monitoring.
AuthenticationAPI V3AuthLogin Post /v3/auth/login Log in
AuthenticationAPI V3AuthLogout Post /v3/auth/logout Log out
AuthenticationAPI V3DeleteApiToken Delete /v3/auth/apitoken Delete API token
AuthenticationAPI V3FetchAuthProviderMetadata Get /v3/auth/providers/fetch-metadata Fetch SAML metadata
AuthenticationAPI V3GenerateApiToken Post /v3/auth/apitoken Generate API token
AuthenticationAPI V3GetAuthProviderAuthorizationUrl Get /v3/auth/providers/{providerId}/authorization_url Get provider authorization URL
AuthenticationAPI V3GetAuthProviderCallback Get /v3/auth/providers/{providerId}/callback Authentication provider callback (GET)
AuthenticationAPI V3GetAuthProviderSpMetadata Get /v3/auth/providers/{providerId}/spmetadata Get service provider metadata
AuthenticationAPI V3ListAuthProviderTypes Get /v3/auth/providers/types List authentication provider types
AuthenticationAPI V3ListAuthProviders Get /v3/auth/providers List authentication providers
AuthenticationAPI V3PostAuthProviderCallback Post /v3/auth/providers/{providerId}/callback Authentication provider callback (POST)
AuthenticationV1API V1AuthLogin Post /v1/auth/login Log In
AuthenticationV1API V1DeleteApiToken Delete /v1/auth/apitoken Delete API token
AuthenticationV1API V1GenerateApiToken Post /v1/auth/apitoken Generate API token
BillingAPI V3CancelSubscription Post /v3/billing/cancel Cancel a subscription
BillingAPI V3GetBillingSummary Get /v3/billing/summary Get billing summary
BillingAPI V3GetDeviceUsage Get /v3/billing/usage Get device usage
BillingAPI V3GetMeteredSubscriptionUsage Get /v3/billing/subscription/metered/usage Get metered subscription usage
BillingAPI V3GetSubscription Get /v3/billing/subscription Get the current subscription
BillingAPI V3SubscribeToTrial Post /v3/billing/trials/subscribe Subscribe to a trial
BillingAPI V3UncancelSubscription Post /v3/billing/uncancel Uncancel a subscription
ClusterAPI V3DeleteClusterSnapshot Delete /v3/cluster/snapshots/{snapshotId} Delete cluster snapshot
ClusterAPI V3GetClusterConfig Get /v3/cluster/config Get cluster configuration
ClusterAPI V3GetClusterNode Get /v3/cluster/nodes/{nodeId} Get cluster node
ClusterAPI V3GetClusterNodeConsole Get /v3/cluster/nodes/{nodeId}/console Get node console websocket URL
ClusterAPI V3GetClusterSnapshot Get /v3/cluster/snapshots/{snapshotId} Get cluster snapshot
ClusterAPI V3ListClusterNodes Get /v3/cluster/nodes List cluster nodes
ClusterAPI V3ListClusterSnapshots Get /v3/cluster/snapshots List cluster snapshots
ClusterAPI V3PatchClusterConfig Patch /v3/cluster/config Update cluster configuration
ClusterAdministrationConfigAPI V1GetClusterConfig Get /v1/cluster/config Get cluster configuration
ClusterAdministrationConfigAPI V1PatchClusterConfig Patch /v1/cluster/config Update cluster configuration
ClusterAdministrationFirmwareServiceAPI V1CreateAssetsFirmwareService Post /v1/cluster/firmware-service/firmware-assets Add firmware assets via the firmware service
ClusterAdministrationFirmwareServiceAPI V1CreateImage Post /v1/images Create a new Image
ClusterAdministrationFirmwareServiceAPI V1DeleteAssetFirmwareService Delete /v1/cluster/firmware-service/firmware-assets/{assetURL} Delete a firmware asset by its URL
ClusterAdministrationFirmwareServiceAPI V1DeleteFirmwareFirmwareService Delete /v1/cluster/firmware-service/firmwares/{filename} Delete a firmware by filename from the firmware service
ClusterAdministrationFirmwareServiceAPI V1GetAssetExtendedFirmwareService Get /v1/cluster/firmware-service/firmware-assets/{assetURL}/extended Fetch extended firmware-asset details including instances and associated IPSWs
ClusterAdministrationFirmwareServiceAPI V1GetConfigFirmwareService Get /v1/cluster/firmware-service/config Fetch firmware service configuration
ClusterAdministrationFirmwareServiceAPI V1GetInstallFirmwareStatus Get /v1/images/install-firmware/{taskId} Query install firmware request status.
ClusterAdministrationFirmwareServiceAPI V1InstallFirmware Post /v1/images/install-firmware Installs a firmware for cluster-wide use
ClusterAdministrationFirmwareServiceAPI V1InstallFirmwareAssets Post /v1/images/install-firmware-assets Installs firmware assets for cluster-wide use
ClusterAdministrationFirmwareServiceAPI V1ListAssetsFirmwareService Get /v1/cluster/firmware-service/firmware-assets Fetch firmware assets from the firmware service
ClusterAdministrationFirmwareServiceAPI V1ListDevicesFirmwareService Get /v1/cluster/firmware-service/devices Fetch devices from the firmware service
ClusterAdministrationFirmwareServiceAPI V1ListFirmwaresFirmwareService Get /v1/cluster/firmware-service/firmwares Fetch firmwares from the firmware service
ClusterAdministrationFirmwareServiceAPI V1PatchConfigFirmwareService Patch /v1/cluster/firmware-service/config Update firmware service configuration
ClusterAdministrationFirmwareServiceAPI V1UploadImageData Post /v1/images/{imageId} Upload Image Data
ClusterAdministrationNodesAPI V1GetClusterNodes Get /v1/cluster/nodes/{nodeId} Get node details by ID
ClusterAdministrationNodesAPI V1GetConsoleClusterNodes Get /v1/cluster/nodes/{nodeId}/console Access node console via SSH
ClusterAdministrationNodesAPI V1ListClusterNodes Get /v1/cluster/nodes List servers in the cluster
ClusterSnapshotsAPI V1DeleteClusterSnapshot Delete /v1/cluster/snapshots/{snapshotId} Delete a Cluster Snapshot
ClusterSnapshotsAPI V1GetClusterSnapshot Get /v1/cluster/snapshots/{snapshotId} Get Cluster Snapshot
ClusterSnapshotsAPI V1GetClusterSnapshots Get /v1/cluster/snapshots Get Cluster Snapshots
ConfigAPI V3GetConfig Get /v3/config Get deployment configuration
ConfigAPI V3GetVersion Get /v3/version Get the platform version
ConfigV1API V1GetConfig Get /v1/config Get all configs
CoreTraceAPI V3ClearCoreTrace Delete /v3/instances/{instanceId}/strace Clear CoreTrace output
CoreTraceAPI V3ListThreads Get /v3/instances/{instanceId}/strace/thread-list List running processes (CoreTrace)
CoreTraceAPI V3StartCoreTrace Post /v3/instances/{instanceId}/strace/enable Start CoreTrace
CoreTraceAPI V3StopCoreTrace Post /v3/instances/{instanceId}/strace/disable Stop CoreTrace
CoreTraceAPI V3StracePreauthorize Get /v3/instances/{instanceId}/strace-authorize Get a CoreTrace download token
CoreTraceV1API V1ClearCoreTrace Delete /v1/instances/{instanceId}/strace Clear CoreTrace logs
CoreTraceV1API V1ListThreads Get /v1/instances/{instanceId}/strace/thread-list Get Running Threads (CoreTrace)
CoreTraceV1API V1StartCoreTrace Post /v1/instances/{instanceId}/strace/enable Start CoreTrace on an instance
CoreTraceV1API V1StopCoreTrace Post /v1/instances/{instanceId}/strace/disable Stop CoreTrace on an instance.
DomainAPI V3CreateDomainWelcomeMessage Post /v3/domain/welcome Create a welcome message for a domain
DomainAPI V3DeleteDomainWelcomeMessage Delete /v3/domain/welcome Delete the welcome message for the authenticated user's domain
DomainAPI V3GetDomainImageUpload Get /v3/domain/image-upload/{type}/{imageId}/{name} Get image upload status
DomainAPI V3GetDomainWelcomeMessage Get /v3/domain/welcome Get the welcome message for the authenticated user's domain
DomainAPI V3ListDomainSoftware Get /v3/domain/software List domain-level firmware images
DomainAPI V3PatchDomainWelcomeMessage Patch /v3/domain/welcome Update a welcome message for a domain
DomainAPI V3PutDomainImageUpload Put /v3/domain/image-upload/{type}/{imageId}/{name} Upload image chunk
DomainAuthProviderAPI V1CreateDomainAuthProvider Post /v1/domain/{domainId}/auth Create a new auth provider for a domain
DomainAuthProviderAPI V1DeleteDomainAuthProvider Delete /v1/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
DomainAuthProviderAPI V1GetDomainAuthProviders Get /v1/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
DomainAuthProviderAPI V1UpdateDomainAuthProvider Put /v1/domain/{domainId}/auth/{providerId} Update an auth provider for a domain
DomainAuthProvidersAPI V3CreateDomainAuthProvider Post /v3/domain/{domainId}/auth Create a new auth provider for a domain
DomainAuthProvidersAPI V3DeleteDomainAuthProvider Delete /v3/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
DomainAuthProvidersAPI V3ListDomainAuthProviders Get /v3/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
DomainAuthProvidersAPI V3PatchDomainAuthProvider Patch /v3/domain/{domainId}/auth/{providerId} Partially update an auth provider for a domain
DomainAuthProvidersAPI V3UpdateDomainAuthProvider Put /v3/domain/{domainId}/auth/{providerId} Update an auth provider for a domain
DomainV1API V1CreateDomainWelcomeMessage Post /v1/domain/welcome Create a welcome message for a domain
DomainV1API V1DeleteDomainWelcomeMessage Delete /v1/domain/welcome Delete the welcome message for the authenticated user's domain
DomainV1API V1GetDomainWelcomeMessage Get /v1/domain/welcome Get the welcome message for the authenticated user's domain
DomainV1API V1UpdateDomainWelcomeMessage Patch /v1/domain/welcome Update a welcome message for a domain
ExtensionsAPI V3DeleteExtension Delete /v3/extensions/{extensionId} Delete an existing extension
ExtensionsAPI V3GetExtensionById Get /v3/extensions/{extensionId} Get extension by ID
ExtensionsAPI V3ListExtensions Get /v3/extensions List all extensions
ExtensionsAPI V3LoadExtension Post /v3/extensions Load an extension
ExtensionsAPI V3ParseExtensionJson Post /v3/extensions/parse/extension.json Validates extension.json
ExtensionsAPI V3UpdateExtension Put /v3/extensions/{extensionId} Update an existing extension
ExtensionsV1API V1DeleteExtension Delete /v1/extensions/{extensionId} Delete an existing extension
ExtensionsV1API V1GetExtensionById Get /v1/extensions/{extensionId} Get extension by id
ExtensionsV1API V1GetExtensions Get /v1/extensions Get all extensions
ExtensionsV1API V1LoadExtension Post /v1/extensions Load an extension
ExtensionsV1API V1ParseExtensionJson Post /v1/extensions/parse/extension.json Validates extension.json
ExtensionsV1API V1UpdateExtension Put /v1/extensions/{extensionId} Update an existing extension
ExternalServicesAPI DeleteExternalService Delete /{apiVersion}/external-services/{serviceName}/{path} Proxy a DELETE request to an external service
ExternalServicesAPI GetExternalService Get /{apiVersion}/external-services/{serviceName}/{path} Proxy a GET request to an external service
ExternalServicesAPI PatchExternalService Patch /{apiVersion}/external-services/{serviceName}/{path} Proxy a PATCH request to an external service
ExternalServicesAPI PostExternalService Post /{apiVersion}/external-services/{serviceName}/{path} Proxy a POST request to an external service
ExternalServicesAPI PutExternalService Put /{apiVersion}/external-services/{serviceName}/{path} Proxy a PUT request to an external service
FirmwareServiceAPI V3CreateFirmwareAssets Post /v3/cluster/firmware-service/firmware-assets Add firmware assets
FirmwareServiceAPI V3DeleteFirmware Delete /v3/cluster/firmware-service/firmwares/{filename} Delete a firmware
FirmwareServiceAPI V3DeleteFirmwareAsset Delete /v3/cluster/firmware-service/firmware-assets/{assetUrl} Delete a firmware asset
FirmwareServiceAPI V3GetFirmwareAssetExtended Get /v3/cluster/firmware-service/firmware-assets/{assetUrl}/extended Get extended firmware asset info
FirmwareServiceAPI V3GetFirmwareServiceConfig Get /v3/cluster/firmware-service/config Get firmware service configuration
FirmwareServiceAPI V3ListFirmwareAssets Get /v3/cluster/firmware-service/firmware-assets List firmware assets
FirmwareServiceAPI V3ListFirmwareDevices Get /v3/cluster/firmware-service/devices List firmware service devices
FirmwareServiceAPI V3ListFirmwares Get /v3/cluster/firmware-service/firmwares List firmwares
FirmwareServiceAPI V3PatchFirmwareServiceConfig Patch /v3/cluster/firmware-service/config Update firmware service configuration
FlavorsAPI V3GetFrame Get /v3/flavors/{flavorId} Get the device frame layout for a model
FlavorsAPI V3GetFrameImage Get /v3/flavors/{flavorId}/image Get the device frame image for a model
FlavorsAPI V3GetProductImage Get /v3/flavors/{flavorId}/productimage Get the product image for a model
HyperTraceAPI V3BtracePreauthorize Get /v3/instances/{instanceId}/btrace-authorize Get a HyperTrace download token
HyperTraceAPI V3ClearHyperTrace Delete /v3/instances/{instanceId}/btrace Clear HyperTrace output
HyperTraceAPI V3GetInstanceKcrange Get /v3/instances/{instanceId}/btrace-kcrange List kernel extension address ranges
HyperTraceAPI V3StartHyperTrace Post /v3/instances/{instanceId}/btrace/enable Start HyperTrace
HyperTraceAPI V3StopHyperTrace Post /v3/instances/{instanceId}/btrace/disable Stop HyperTrace
HyperTraceV1API V1BtracePreauthorize Get /v1/instances/{instanceId}/btrace-authorize Pre-authorize an btrace download
HyperTraceV1API V1ClearHyperTrace Delete /v1/instances/{instanceId}/btrace Clear HyperTrace logs
HyperTraceV1API V1Kcrange Get /v1/instances/{instanceId}/btrace-kcrange Get Kernel extension ranges
HyperTraceV1API V1StartHyperTrace Post /v1/instances/{instanceId}/btrace/enable Start HyperTrace on an instance
HyperTraceV1API V1StopHyperTrace Post /v1/instances/{instanceId}/btrace/disable Stop HyperTrace on an instance.
HypertuneAPI V3HypertuneHash Get /v3/hypertune/hash Get Hypertune state hash
HypertuneAPI V3HypertuneInit Get /v3/hypertune/init Get Hypertune initialization data
HypervisorHooksAPI V3ClearHyperTraceHooks Post /v3/instances/{instanceId}/hooks/clear Stop hypervisor hooks
HypervisorHooksAPI V3CreateHook Post /v3/instances/{instanceId}/hooks Create a hypervisor hook for an instance
HypervisorHooksAPI V3DeleteHook Delete /v3/hooks/{hookId} Delete a hypervisor hook
HypervisorHooksAPI V3ExecuteHyperTraceHooks Post /v3/instances/{instanceId}/hooks/execute Run hypervisor hooks
HypervisorHooksAPI V3GetHook Get /v3/hooks/{hookId} Get a hypervisor hook by ID
HypervisorHooksAPI V3ListHooks Get /v3/instances/{instanceId}/hooks List hypervisor hooks for an instance
HypervisorHooksAPI V3UpdateHook Put /v3/hooks/{hookId} Update a hypervisor hook
HypervisorHooksV1API V1ClearHyperTraceHooks Post /v1/instances/{instanceId}/hooks/clear Clear Hooks on an instance
HypervisorHooksV1API V1CreateHook Post /v1/instances/{instanceId}/hooks Create hypervisor hook for Instance
HypervisorHooksV1API V1DeleteHook Delete /v1/hooks/{hookId} Delete an existing hypervisor hook
HypervisorHooksV1API V1ExecuteHyperTraceHooks Post /v1/instances/{instanceId}/hooks/execute Execute Hooks on an instance
HypervisorHooksV1API V1GetHookById Get /v1/hooks/{hookId} Get hypervisor hook by id
HypervisorHooksV1API V1GetHooks Get /v1/instances/{instanceId}/hooks Get all hypervisor hooks for Instance
HypervisorHooksV1API V1UpdateHook Put /v1/hooks/{hookId} Update an existing hypervisor hook
ImagesAPI V3CreateImage Post /v3/images Create an image
ImagesAPI V3DeleteImage Delete /v3/images/{imageId} Delete an image
ImagesAPI V3GetImage Get /v3/images/{imageId} Get image metadata
ImagesAPI V3GetImageChunk Get /v3/images/{imageId}/file Check whether an image chunk was already uploaded
ImagesAPI V3GetImageFirmwareInfo Post /v3/images/{imageId}/fwinfo Get firmware info embedded in an image
ImagesAPI V3GetInstallFirmwareStatus Get /v3/images/install-firmware/{taskId} Get install-firmware task status
ImagesAPI V3InstallFirmware Post /v3/images/install-firmware Install firmware cluster-wide
ImagesAPI V3InstallFirmwareAssets Post /v3/images/install-firmware-assets Install firmware assets cluster-wide
ImagesAPI V3ListImages Get /v3/images List image metadata
ImagesAPI V3UploadImageChunk Put /v3/images/{imageId}/file Upload one chunk of an image file
ImagesAPI V3UploadImageData Post /v3/images/{imageId} Upload image file contents
ImagesV1API V1GetImage Get /v1/images/{imageId} Get Image Metadata
ImagesV1API V1GetImages Get /v1/images Get all Images Metadata
ImagesV2API V1DeleteImage Delete /v2/images/{imageId} Delete Image
InstancesAPI V3AttachInstanceInterface Post /v3/instances/{instanceId}/interfaces Connect an I/O interface
InstancesAPI V3ClearInstancePanics Delete /v3/instances/{instanceId}/panics Clear kernel panics
InstancesAPI V3CreateInstance Post /v3/instances Create a device
InstancesAPI V3DeleteInstance Delete /v3/instances/{instanceId} Remove Instance
InstancesAPI V3DetachInstanceInterface Delete /v3/instances/{instanceId}/interfaces/{interfaceId} Disconnect an I/O interface
InstancesAPI V3DisableExposePort Post /v3/instances/{instanceId}/exposeport/disable Stop exposing the device port
InstancesAPI V3DownloadNetdumpPcap Get /v3/instances/{instanceId}/netdump.pcap Download the Enhanced Network Monitor capture
InstancesAPI V3DownloadNetworkMonitorPcap Get /v3/instances/{instanceId}/networkMonitor.pcap Download the Network Monitor capture
InstancesAPI V3EnableExposePort Post /v3/instances/{instanceId}/exposeport/enable Expose the device port
InstancesAPI V3GetInstance Get /v3/instances/{instanceId} Get a device
InstancesAPI V3GetInstanceConsole Get /v3/instances/{instanceId}/console Get console websocket URL
InstancesAPI V3GetInstanceConsoleLog Get /v3/instances/{instanceId}/consoleLog Read the console log
InstancesAPI V3GetInstanceGpios Get /v3/instances/{instanceId}/gpios Read board LEDs, buttons and switches
InstancesAPI V3GetInstanceImageUpload Get /v3/instances/{instance}/image-upload/{type}/{imageId}/{name} Get image upload status
InstancesAPI V3GetInstancePanics Get /v3/instances/{instanceId}/panics List kernel panics
InstancesAPI V3GetInstancePeripherals Get /v3/instances/{instanceId}/peripherals Read simulated sensors
InstancesAPI V3GetInstanceQuickConnectCommand Get /v3/instances/{instanceId}/quickConnectCommand Get the SSH quick-connect command
InstancesAPI V3GetInstanceScreenshot Get /v3/instances/{instanceId}/screenshot.{format} Take a screenshot
InstancesAPI V3GetInstanceState Get /v3/instances/{instanceId}/state Get a device's state
InstancesAPI V3InjectMessage Post /v3/instances/{instanceId}/message Send an SMS message to an iOS device
InstancesAPI V3KernelPreauthorize Get /v3/instances/{instanceId}/kernel-authorize Get a kernel download token
InstancesAPI V3ListInstances Get /v3/instances List Instances
InstancesAPI V3MediaPlay Post /v3/instances/{instanceId}/media/play Play a video or audio file into the device
InstancesAPI V3MediaStop Post /v3/instances/{instanceId}/media/stop Stop playing media
InstancesAPI V3PatchInstance Patch /v3/instances/{instanceId} Change device settings
InstancesAPI V3PatchInstanceReadOnly Patch /v3/instances/{instanceId}/read-only Update Instance Read Only
InstancesAPI V3PauseInstance Post /v3/instances/{instanceId}/pause Pause a device
InstancesAPI V3PostInstanceInput Post /v3/instances/{instanceId}/input Provide Instance Input
InstancesAPI V3PutInstanceImageUpload Put /v3/instances/{instance}/image-upload/{type}/{imageId}/{name} Upload image chunk
InstancesAPI V3RebootInstance Post /v3/instances/{instanceId}/reboot Restart a device
InstancesAPI V3RestoreBackup Post /v3/instances/{instanceId}/restoreBackup Restore a backup onto a device
InstancesAPI V3RotateInstance Post /v3/instances/{instanceId}/rotate Rotate the device
InstancesAPI V3SetInstanceGpios Put /v3/instances/{instanceId}/gpios Press board buttons or flip switches
InstancesAPI V3SetInstancePeripherals Put /v3/instances/{instanceId}/peripherals Change simulated sensors
InstancesAPI V3StartInstance Post /v3/instances/{instanceId}/start Turn a device on
InstancesAPI V3StartNetdump Post /v3/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor
InstancesAPI V3StartNetworkMonitor Post /v3/instances/{instanceId}/sslsplit/enable Start Network Monitor
InstancesAPI V3StopInstance Post /v3/instances/{instanceId}/stop Turn a device off
InstancesAPI V3StopNetdump Post /v3/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor
InstancesAPI V3StopNetworkMonitor Post /v3/instances/{instanceId}/sslsplit/disable Stop Network Monitor
InstancesAPI V3UnpauseInstance Post /v3/instances/{instanceId}/unpause Resume a paused device
InstancesAPI V3UpgradeInstance Post /v3/instances/{instanceId}/upgrade Upgrade the iOS version
InstancesAPI V3ValidateInstanceToken Post /v3/instances/{instanceId}/token/validate Check a device connection token
InstancesV1API V1AttachInstanceInterface Post /v1/instances/{instanceId}/interfaces Attach I/O Interface
InstancesV1API V1ClearInstancePanics Delete /v1/instances/{instanceId}/panics Clear Panics
InstancesV1API V1CreateInstance Post /v1/instances Create Instance
InstancesV1API V1DeleteInstance Delete /v1/instances/{instanceId} Remove Instance
InstancesV1API V1DetachInstanceInterface Delete /v1/instances/{instanceId}/interfaces/{interfaceId} Detach I/O Interface
InstancesV1API V1DisableExposePort Post /v1/instances/{instanceId}/exposeport/disable Disable an exposed port on an instance for device access.
InstancesV1API V1DownloadNetdumpPcapInstances Get /v1/instances/{instanceId}/netdump.pcap Download a netdump pcap file
InstancesV1API V1DownloadNetworkMonitorPcapInstances Get /v1/instances/{instanceId}/networkMonitor.pcap Download a Network Monitor pcap file
InstancesV1API V1EnableExposePort Post /v1/instances/{instanceId}/exposeport/enable Enable an exposed port on an instance for device access.
InstancesV1API V1GetInstance Get /v1/instances/{instanceId} Get Instance
InstancesV1API V1GetInstanceConsole Get /v1/instances/{instanceId}/console Get console websocket URL
InstancesV1API V1GetInstanceConsoleLog Get /v1/instances/{instanceId}/consoleLog Get Console Log
InstancesV1API V1GetInstanceGpios Get /v1/instances/{instanceId}/gpios Get Instance GPIOs
InstancesV1API V1GetInstancePanics Get /v1/instances/{instanceId}/panics Get Panics
InstancesV1API V1GetInstancePeripherals Get /v1/instances/{instanceId}/peripherals Get Instance Peripherals
InstancesV1API V1GetInstanceScreenshot Get /v1/instances/{instanceId}/screenshot.{format} Get Instance Screenshot
InstancesV1API V1GetInstances Get /v1/instances Get Instances
InstancesV1API V1InjectMessageInstances Post /v1/instances/{instanceId}/message Inject a message into an iOS VM
InstancesV1API V1MediaPlay Post /v1/instances/{instanceId}/media/play Start playing media
InstancesV1API V1MediaStop Post /v1/instances/{instanceId}/media/stop Stop playing media
InstancesV1API V1PatchInstance Patch /v1/instances/{instanceId} Update Instance
InstancesV1API V1PatchInstanceReadOnly Patch /v1/instances/{instanceId}/read-only Update Instance Read Only
InstancesV1API V1PauseInstance Post /v1/instances/{instanceId}/pause Pause an Instance
InstancesV1API V1PostInstanceInput Post /v1/instances/{instanceId}/input Provide Instance Input
InstancesV1API V1RebootInstance Post /v1/instances/{instanceId}/reboot Reboot an Instance
InstancesV1API V1RestoreBackup Post /v1/instances/{instanceId}/restoreBackup Restore backup
InstancesV1API V1RotateInstance Post /v1/instances/{instanceId}/rotate Rotate device to specified orientation
InstancesV1API V1SetInstanceGpios Put /v1/instances/{instanceId}/gpios Set Instance GPIOs
InstancesV1API V1SetInstancePeripherals Put /v1/instances/{instanceId}/peripherals Update Instance Peripherals
InstancesV1API V1SetInstanceState Put /v1/instances/{instanceId}/state Set state of Instance
InstancesV1API V1StartInstance Post /v1/instances/{instanceId}/start Start an Instance
InstancesV1API V1StartNetdump Post /v1/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor on an instance.
InstancesV1API V1StartNetworkMonitor Post /v1/instances/{instanceId}/sslsplit/enable Start Network Monitor on an instance.
InstancesV1API V1StopInstance Post /v1/instances/{instanceId}/stop Stop an Instance
InstancesV1API V1StopNetdump Post /v1/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor on an instance.
InstancesV1API V1StopNetworkMonitor Post /v1/instances/{instanceId}/sslsplit/disable Stop Network Monitor on an instance.
InstancesV1API V1UnpauseInstance Post /v1/instances/{instanceId}/unpause Unpause an Instance
InstancesV1API V1UpgradeInstance Post /v1/instances/{instanceId}/upgrade Upgrade iOS version
InstancesV2API V2GetInstanceQuickConnectCommand Get /v2/instances/{instanceId}/quickConnectCommand Recommended SSH Command for Quick Connect
InstancesV2API V2GetInstanceState Get /v2/instances/{instanceId}/state Get state of Instance
InterconnectsAPI V3CreateInterconnect Post /v3/interconnects Create I/O Interconnect
InterconnectsAPI V3DeleteInterconnect Delete /v3/interconnects/{interconnectId} Delete I/O Interconnect
InterconnectsAPI V3GetInterconnect Get /v3/interconnects/{interconnectId} Get Interconnect
InterconnectsAPI V3ListInterconnects Get /v3/interconnects List I/O Interconnects
InterconnectsAPI V3PatchInterconnect Patch /v3/interconnects/{interconnectId} Patch I/O Interconnect
InterconnectsAPI V3UpdateInterconnect Put /v3/interconnects/{interconnectId} Update I/O Interconnect
InterconnectsV1API V1CreateInterconnect Post /v1/interconnects Create I/O Interconnect
InterconnectsV1API V1DeleteInterconnect Delete /v1/interconnects/{interconnectId} Delete I/O Interconnect
InterconnectsV1API V1GetInterconnect Get /v1/interconnects/{interconnectId} Get Interconnect
InterconnectsV1API V1ListInterconnects Get /v1/interconnects Get all I/O Interconnects
InterconnectsV1API V1PatchInterconnect Patch /v1/interconnects/{interconnectId} Partial Update Interconnect
InterconnectsV1API V1UpdateInterconnect Put /v1/interconnects/{interconnectId} Update Interconnect
InvitesAPI V3CreateInvites Post /v3/invites Create invites
InvitesAPI V3EditInvites Post /v3/invites/edit Edit invites
InvitesAPI V3GetInviteByToken Post /v3/invites-by-token Get an invite by token
InvitesAPI V3ListInvites Get /v3/invites List invites
InvitesAPI V3RevokeInvites Post /v3/invites/revoke Revoke invites
InvitesAPI V3SignupFromInvite Post /v3/invites/signup Sign up from an invite
InvitesV1API V1CreateUserInvites Post /v1/invites Create Invite
InvitesV1API V1EditInvites Post /v1/invites/edit
InvitesV1API V1Invites Get /v1/invites Get Invites
InvitesV1API V1InvitesByToken Get /v1/invites-by-token
InvitesV1API V1RevokeUserInvite Post /v1/invites/revoke Revoke Invite
InvitesV1API V1UserCreateFromInvite Post /v1/invites/signup
ModelsAPI V3GetModelSoftware Get /v3/models/{model}/software List software for a model
ModelsAPI V3GetModels Get /v3/models List device models
ModelsV1API V1GetModelSoftware Get /v1/models/{model}/software Get Software for Model
ModelsV1API V1GetModels Get /v1/models Get Supported Models
NetConnectAPI V3CreateNetworkConnection Post /v3/network/connections Create a new Network Connection
NetConnectAPI V3DeleteNetworkConnection Delete /v3/network/connections/{id} Delete an existing Network Connection
NetConnectAPI V3GetNetworkConnection Get /v3/network/connections/{id} Fetch an existing Network Connection
NetConnectAPI V3ListNetworkConnections Get /v3/network/connections List available network connections
NetConnectAPI V3ListNetworkInterfaces Get /v3/network/interfaces List available physical network interfaces
NetConnectAPI V3ListNetworkProviders Get /v3/network/providers List available network providers
NetConnectAPI V3PartialUpdateNetworkConnection Patch /v3/network/connections/{id} Update Network Connection (patch)
NetConnectAPI V3UpdateNetworkConnection Put /v3/network/connections/{id} Update Network Connection
NetConnectV1API V1CreateNetworkConnection Post /v1/network/connections Create a new Network Connection
NetConnectV1API V1DeleteNetworkConnection Delete /v1/network/connections/{id} Delete an existing Network Connection
NetConnectV1API V1GetNetworkConnection Get /v1/network/connections/{id} Return the configuration and per project statuses for a single network provider.
NetConnectV1API V1ListNetworkConnections Get /v1/network/connections List available network connections
NetConnectV1API V1ListNetworkInterfaces Get /v1/network/interfaces List available physical network interfaces
NetConnectV1API V1ListNetworkProviders Get /v1/network/providers List available network providers
NetConnectV1API V1PartialUpdateNetworkConnection Patch /v1/network/connections/{id} Update Network Connection (partial)
NetConnectV1API V1UpdateNetworkConnection Put /v1/network/connections/{id} Update Network Connection
ProjectsAPI V3CreateProject Post /v3/projects Create a project
ProjectsAPI V3CreateProjectKey Post /v3/projects/{projectId}/keys Add a project key
ProjectsAPI V3DeleteProject Delete /v3/projects/{projectId} Delete a project
ProjectsAPI V3DeleteProjectKey Delete /v3/projects/{projectId}/keys/{keyId} Delete a project key
ProjectsAPI V3FetchProjectFirmwareAssets Post /v3/projects/{projectId}/firmware-assets Fetch firmware assets for a project
ProjectsAPI V3GetProject Get /v3/projects/{projectId} Get a project
ProjectsAPI V3GetProjectImageUpload Get /v3/projects/{projectId}/image-upload/{type}/{imageId}/{name} Get image upload status
ProjectsAPI V3GetProjectNetworkLog Get /v3/projects/{projectId}/network/log Get project network log
ProjectsAPI V3GetProjectNetworkStatus Get /v3/projects/{projectId}/network/status Get project network status
ProjectsAPI V3GetProjectVpnConfig Get /v3/projects/{projectId}/vpnconfig/{format} Get project VPN configuration
ProjectsAPI V3ListProjectInstances Get /v3/projects/{projectId}/instances List project instances
ProjectsAPI V3ListProjectKeys Get /v3/projects/{projectId}/keys List project keys
ProjectsAPI V3ListProjects Get /v3/projects List projects
ProjectsAPI V3PatchProject Patch /v3/projects/{projectId} Update a project
ProjectsAPI V3PreauthVpnConfig Post /v3/projects/{projectId}/preauth-vpn-config/{filename} Pre-authorize a VPN configuration download
ProjectsAPI V3PutProjectImageUpload Put /v3/projects/{projectId}/image-upload/{type}/{imageId}/{name} Upload image chunk
ProjectsV1API V1AddProjectKey Post /v1/projects/{projectId}/keys Add Project Authorized Key
ProjectsV1API V1CreateProject Post /v1/projects Create a Project
ProjectsV1API V1DeleteProject Delete /v1/projects/{projectId} Delete a Project
ProjectsV1API V1GetProject Get /v1/projects/{projectId} Get a Project
ProjectsV1API V1GetProjectInstances Get /v1/projects/{projectId}/instances Get Instances in Project
ProjectsV1API V1GetProjectKeys Get /v1/projects/{projectId}/keys Get Project Authorized Keys
ProjectsV1API V1GetProjectNetworkLog Get /v1/projects/{projectId}/network/log Retrieve the network connection log for a project
ProjectsV1API V1GetProjectNetworkStatus Get /v1/projects/{projectId}/network/status Retrieve the network connection status for a project
ProjectsV1API V1GetProjectVpnConfig Get /v1/projects/{projectId}/vpnconfig/{format} Get Project VPN Configuration
ProjectsV1API V1GetProjects Get /v1/projects Get Projects
ProjectsV1API V1RemoveProjectKey Delete /v1/projects/{projectId}/keys/{keyId} Delete Project Authorized Key
ProjectsV1API V1UpdateProject Patch /v1/projects/{projectId} Update a Project
ProjectsV1API V1UpdateProjectSettings Patch /v1/projects/{projectId}/settings Change Project Settings
RAMDumpAPI V3ClearRamDump Delete /v3/instances/{instanceId}/ramdump Delete a RAM dump
RAMDumpAPI V3RamDumpPreauthorize Get /v3/instances/{instanceId}/ramdump-authorize Get a RAM dump download token
RAMDumpAPI V3StartRamDump Post /v3/instances/{instanceId}/ramdump/start Start a RAM dump
RAMDumpV1API V1ClearRamDump Delete /v1/instances/{instanceId}/ramdump Clear RAM Dump
RAMDumpV1API V1RAMDumpPreauthorize Get /v1/instances/{instanceId}/ramdump-authorize Pre-authorize a RAM Dump download
RAMDumpV1API V1StartRamDump Post /v1/instances/{instanceId}/ramdump/start Start a RAM Dump on an instance
RolesAPI V3AddTeamRoleToDeployment Put /v3/roles/deployments/{deploymentId}/teams/{teamId}/roles/{roleId} Add team role to deployment
RolesAPI V3AddTeamRoleToProject Put /v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Add team role to project
RolesAPI V3AddUserRoleToDeployment Put /v3/roles/deployments/{deploymentId}/users/{userId}/roles/{roleId} Add user role to deployment
RolesAPI V3AddUserRoleToProject Put /v3/roles/projects/{projectId}/users/{userId}/roles/{roleId} Add user role to project
RolesAPI V3ListDeploymentRoles Get /v3/roles/deployments List deployment role assignments
RolesAPI V3ListRoles Get /v3/roles List all role assignments for the caller's domain
RolesAPI V3RemoveTeamRoleFromDeployment Delete /v3/roles/deployments/{deploymentId}/teams/{teamId}/roles/{roleId} Remove team role from deployment
RolesAPI V3RemoveTeamRoleFromProject Delete /v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Remove team role from project
RolesAPI V3RemoveUserRoleFromDeployment Delete /v3/roles/deployments/{deploymentId}/users/{userId}/roles/{roleId} Remove user role from deployment
RolesAPI V3RemoveUserRoleFromProject Delete /v3/roles/projects/{projectId}/users/{userId}/roles/{roleId} Remove user role from project
RolesV1API V1AddTeamRoleToProject Put /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Add team role to project
RolesV1API V1AddUserRoleToProject Put /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Add user role to project
RolesV1API V1RemoveTeamRoleFromProject Delete /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Remove team role from project
RolesV1API V1RemoveUserRoleFromProject Delete /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Remove user role from project
RolesV1API V1Roles Get /v1/roles Get all roles
SnapshotSharingAPI V3AcceptSharedSnapshot Post /v3/snapshots/accept Accept a shared snapshot
SnapshotSharingAPI V3DeleteSnapshotPermissions Delete /v3/snapshots/{snapshotId}/permissions Delete member(s)
SnapshotSharingAPI V3GetSharedSnapshots Get /v3/snapshots/shared Fetch shared snapshots
SnapshotSharingAPI V3SetSnapshotPermissions Post /v3/snapshots/{snapshotId}/permissions Set member list
SnapshotSharingAPI V3ShareSnapshot Post /v3/snapshots/{snapshotId}/share Create or update snapshot sharing
SnapshotSharingV1API V1AcceptSharedSnapshot Post /v1/snapshots/accept Accept a snapshot shared with you
SnapshotSharingV1API V1DeleteSnapshotPermissions Delete /v1/snapshots/{snapshotId}/permissions Delete member(s)
SnapshotSharingV1API V1GetSharedSnapshots Get /v1/snapshots/shared Fetch shared snapshots
SnapshotSharingV1API V1SetSnapshotPermissions Post /v1/snapshots/{snapshotId}/permissions Set member list
SnapshotSharingV1API V1ShareSnapshot Post /v1/snapshots/{snapshotId}/share Share snapshot
SnapshotsAPI V3CreateInstanceSnapshot Post /v3/instances/{instanceId}/snapshots Create instance snapshot
SnapshotsAPI V3DeleteInstanceSnapshot Delete /v3/instances/{instanceId}/snapshots/{snapshotId} Delete an instance snapshot
SnapshotsAPI V3DeleteSnapshot Delete /v3/snapshots/{snapshotId} Delete a snapshot
SnapshotsAPI V3GetInstanceSnapshot Get /v3/instances/{instanceId}/snapshots/{snapshotId} Get instance snapshot
SnapshotsAPI V3GetSnapshot Get /v3/snapshots/{snapshotId} Get snapshot
SnapshotsAPI V3ListInstanceSnapshots Get /v3/instances/{instanceId}/snapshots List instance snapshots
SnapshotsAPI V3PatchInstanceSnapshot Patch /v3/instances/{instanceId}/snapshots/{snapshotId} Update an instance snapshot
SnapshotsAPI V3RestoreInstanceSnapshot Post /v3/instances/{instanceId}/snapshots/{snapshotId}/restore Restore instance snapshot
SnapshotsAPI V3UpdateSnapshot Patch /v3/snapshots/{snapshotId} Update snapshot name
SnapshotsV1API V1CreateSnapshot Post /v1/instances/{instanceId}/snapshots Create Instance Snapshot
SnapshotsV1API V1DeleteInstanceSnapshot Delete /v1/instances/{instanceId}/snapshots/{snapshotId} Delete an Instance Snapshot
SnapshotsV1API V1DeleteSnapshot Delete /v1/snapshots/{snapshotId} Delete a Snapshot
SnapshotsV1API V1GetInstanceSnapshot Get /v1/instances/{instanceId}/snapshots/{snapshotId} Get Instance Snapshot
SnapshotsV1API V1GetInstanceSnapshots Get /v1/instances/{instanceId}/snapshots Get Instance Snapshots
SnapshotsV1API V1GetSnapshot Get /v1/snapshots/{snapshotId} Get Snapshot
SnapshotsV1API V1RenameInstanceSnapshot Patch /v1/instances/{instanceId}/snapshots/{snapshotId} Rename an Instance Snapshot
SnapshotsV1API V1RestoreInstanceSnapshot Post /v1/instances/{instanceId}/snapshots/{snapshotId}/restore Restore an Instance Snapshot
SnapshotsV1API V1SnapshotRename Patch /v1/snapshots/{snapshotId} Rename a Snapshot
StatusAPI V3Ready Get /v3/ready Check that the API is ready
StatusV1API V1Ready Get /v1/ready API Status
StorageAPI V3AttachClusterStorage Post /v3/cluster/storage/{id}/attach Attach storage device
StorageAPI V3EjectClusterStorage Post /v3/cluster/storage/{id}/eject Eject storage device
StorageAPI V3ListClusterStorage Get /v3/cluster/storage List cluster storage devices
StorageAPI V3ListStorage Get /v3/storage List server-attached storage devices
StorageAPI V3ListStorageFiles Get /v3/storage/{id}/files/{path} List storage files
StorageV1API V1AttachStorageCluster Post /v1/cluster/storage/{id}/attach Mount and attach a storage device
StorageV1API V1EjectStorageCluster Post /v1/cluster/storage/{id}/eject Eject/Unmount removable media
StorageV1API V1ListStorage Get /v1/storage Get storage devices
StorageV1API V1ListStorageCluster Get /v1/cluster/storage Get storage devices
StorageV1API V1ListStorageFiles Get /v1/storage/{id}/files/{path} List Storage Files
TOTPAPI V3DisableTotp Post /v3/totp/disable Disable TOTP for this user
TOTPAPI V3EnableTotp Post /v3/totp/enable Enable TOTP for this user
TOTPAPI V3GenerateTotp Post /v3/totp/generate Generate a TOTP secret
TeamsAPI V3AddUserToTeam Put /v3/teams/{teamId}/users/{userId} Add a user to a team
TeamsAPI V3CreateTeam Post /v3/teams Create a team
TeamsAPI V3DeleteTeam Delete /v3/teams/{teamId} Delete a team
TeamsAPI V3ListTeams Get /v3/teams List teams
TeamsAPI V3RemoveUserFromTeam Delete /v3/teams/{teamId}/users/{userId} Remove a user from a team
TeamsAPI V3UpdateTeam Patch /v3/teams/{teamId} Update a team
TeamsV1API V1AddUserToTeam Put /v1/teams/{teamId}/users/{userId} Add user to team
TeamsV1API V1RemoveUserFromTeam Delete /v1/teams/{teamId}/users/{userId} Remove user from team
TeamsV1API V1TeamChange Patch /v1/teams/{teamId} Update team
TeamsV1API V1TeamCreate Post /v1/teams Create team
TeamsV1API V1TeamDelete Delete /v1/teams/{teamId} Delete team
TeamsV1API V1Teams Get /v1/teams Get teams
UsersAPI V3AgreeToTerms Post /v3/users/agree Agree to terms
UsersAPI V3ChangePassword Post /v3/users/change-password Change password
UsersAPI V3CreateUser Post /v3/users Create a user
UsersAPI V3DeleteUser Delete /v3/users/{userId} Delete a user
UsersAPI V3GetResetLinkInfo Post /v3/users/reset-link-info Get reset link info
UsersAPI V3PatchUser Patch /v3/users/{userId} Update a user
UsersAPI V3ResetPassword Post /v3/users/reset-password Reset password
UsersAPI V3SendResetLink Post /v3/users/send-reset-link Send a password reset link
UsersAPI V3UpdateOwnProfile Patch /v3/users/me Update your profile
UsersV1API V1ChangePasswordUsers Post /v1/users/change-password Change User Password
UsersV1API V1CreateUser Post /v1/users Create User
UsersV1API V1DeleteUser Delete /v1/users/{userId} Delete User
UsersV1API V1GetResetLinkInfo Get /v1/users/reset-link-info Send Password Reset Link Info
UsersV1API V1ResetUserPassword Post /v1/users/reset-password Reset User Password
UsersV1API V1SendUserResetLink Post /v1/users/send-reset-link Send Password Reset Link
UsersV1API V1UpdateUser Patch /v1/users/{userId} Update User
UsersV1API V1UserAgreeTerms Post /v1/users/agree Consent to the current terms and conditions
UsersV1API V1UsersLogin Post /v1/users/login Log In
WebPlayerAPI V3CreateWebPlayerSession Post /v3/webplayer Create a webplayer session
WebPlayerAPI V3DeleteWebPlayerSession Delete /v3/webplayer/{sessionId} Delete a webplayer session
WebPlayerAPI V3GetWebPlayerAllowedDomains Get /v3/webplayer/allowedDomains Get allowed webplayer domains
WebPlayerAPI V3GetWebPlayerSession Get /v3/webplayer/{sessionId} Get a webplayer session
WebPlayerAPI V3ListWebPlayerSessions Get /v3/webplayer List webplayer sessions
WebPlayerV1API V1WebPlayerAllowedDomains Get /v1/webplayer/allowedDomains Retrieve the list of allowed domains for all Webplayer sessions
WebPlayerV1API V1WebPlayerCreateSession Post /v1/webplayer Create a new Webplayer Session
WebPlayerV1API V1WebPlayerDestroySession Delete /v1/webplayer/{sessionId} Tear down a Webplayer Session
WebPlayerV1API V1WebPlayerListSessions Get /v1/webplayer List all Webplayer sessions
WebPlayerV1API V1WebPlayerSessionInfo Get /v1/webplayer/{sessionId} Retrieve Webplayer Session Information

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), corellium.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

About

Golang Language API Client for Corellium

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

2 stars

Watchers

4 watching

Forks

1 fork
Report repository

Releases

Packages

Used by

Contributors

Languages