Skip to content

About

Python Language API Client for Corellium

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

16 stars

Watchers

10 watching

Forks

1 fork
Report repository
BranchesTags

Repository files navigation

corellium-api-client

Request timeouts

Every API method accepts _request_timeout in seconds: a positive float for the urllib3 total timeout, or a pair of positive floats (connect, read). This controls HTTP transport waiting, not how long the server operation may run. It is not a wall-clock deadline for the operation or for all retries combined.

Transport timeouts raise urllib3.exceptions.TimeoutError subclasses such as ReadTimeoutError and ConnectTimeoutError. When retries are exhausted, urllib3 can instead raise urllib3.exceptions.MaxRetryError; inspect its reason to distinguish a timeout from other connection failures. Retry behavior depends on the HTTP method and Configuration.retries. These are client-side exceptions, not HTTP response statuses or SDK ApiException responses.

A timeout does not guarantee cancellation or rollback of an operation accepted by the server. For example, after a start request times out, the instance may still be starting or may already be running; the timeout alone does not establish its state or mean it was stopped or destroyed. The request might not have reached the server at all, leaving the instance off. Treat the outcome as unknown and fetch the instance's current state before deciding whether to retry. If it has since been destroyed, that lookup may return not found; the timeout itself does not prove destruction. Do not blindly repeat a state-changing request.

Catch urllib3.exceptions.TimeoutError and urllib3.exceptions.MaxRetryError separately from the SDK ApiException. MaxRetryError is not a subclass of TimeoutError. With _with_http_info the same rules apply. With _without_preload_content, a read timeout may also occur later when reading the returned response body.

REST API to manage your virtual devices.

This Python package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install corellium-api-client

(you may need to run pip with root permission: sudo pip install corellium-api-client)

Then import the package:

import corellium

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import corellium

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import corellium
from corellium.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.corellium.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = corellium.Configuration(
    host = "https://app.corellium.com/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = corellium.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with corellium.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = corellium.ActivityApi(api_client)
    accept = corellium.ActivityExportFormat() # ActivityExportFormat | Specifies the activity export file format.
    create_activity_export_body = corellium.CreateActivityExportBody() # CreateActivityExportBody |  (optional)

    try:
        # Start activity export
        api_response = api_instance.v3_create_activity_export(accept, create_activity_export_body=create_activity_export_body)
        print("The response of ActivityApi->v3_create_activity_export:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActivityApi->v3_create_activity_export: %s\n" % e)

Quick start

import os

from corellium import Configuration, CorelliumClient

# basePath defaults to https://app.corellium.com/api; pass host= for enterprise/on-prem.
client = CorelliumClient(Configuration(access_token=os.environ["CORELLIUM_API_TOKEN"]))

instances = client.instances.list()
print(instances)

Authentication

access_token is a Corellium API token or JWT bearer:

from corellium import Configuration, CorelliumClient

client = CorelliumClient(Configuration(access_token="<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:

from corellium import Configuration, CorelliumClient, LoginBody

anon = CorelliumClient(Configuration())
result = anon.auth.login(login_body=LoginBody(username="me@example.com", password="..."))
client = CorelliumClient(Configuration(access_token=result.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()     # latest
client.v3.instances.list()  # pinned to v3

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivityApi v3_create_activity_export POST /v3/activity/export Start activity export
ActivityApi v3_download_activity GET /v3/activity/export/{taskId}/download Download activity for a given task
ActivityApi v3_get_activity_export_status GET /v3/activity/export/{taskId} Get export task status
ActivityApi v3_get_activity_export_tasks GET /v3/activity/export Get all export tasks for user
ActivityApi v3_list_activities GET /v3/activity Get resource activities
ActivityV1Api v1_activity_export POST /v1/activity/export Start activity export
ActivityV1Api v1_activity_list GET /v1/activity Get resource activities
ActivityV1Api v1_download_activity GET /v1/activity/export/{taskId}/download Download activity
ActivityV1Api v1_get_activity_export_status GET /v1/activity/export/{taskId} Get export task status
ActivityV1Api v1_get_activity_export_tasks GET /v1/activity/export Get all export tasks for user
AgentApi v3_delete_file_agent DELETE /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Delete a file on VM
AgentApi v3_get_adb_auth_agent GET /v3/instances/{instanceId}/agent/v1/system/adbauth Get ADB auth setting
AgentApi v3_get_app_ready_agent GET /v3/instances/{instanceId}/agent/v1/app/ready Check if app subsystem is ready
AgentApi v3_get_container_health_agent GET /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/is-healthy Get container health
AgentApi v3_get_file_agent GET /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Download a file from VM
AgentApi v3_get_network_agent GET /v3/instances/{instanceId}/agent/v1/system/network Get eth0 IP address
AgentApi v3_get_prop_agent POST /v3/instances/{instanceId}/agent/v1/system/getprop Get a system property
AgentApi v3_get_remote_it_status_agent GET /v3/instances/{instanceId}/agent/v1/remoteit/status Get Remote.It status
AgentApi v3_get_temp_file_agent POST /v3/instances/{instanceId}/agent/v1/file/temp Get a temp file path on VM
AgentApi v3_install_agent POST /v3/instances/{instanceId}/agent/v1/app/install Install app at path
AgentApi v3_install_open_gapps_agent POST /v3/instances/{instanceId}/agent/v1/system/install-opengapps Install OpenGApps
AgentApi v3_install_profile_agent POST /v3/instances/{instanceId}/agent/v1/profile/install Install a profile
AgentApi v3_install_remote_it_agent POST /v3/instances/{instanceId}/agent/v1/remoteit/install Install Remote.It
AgentApi v3_kill_app_agent POST /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill Kill an app
AgentApi v3_kill_frida_agent POST /v3/instances/{instanceId}/agent/v1/frida/run-frida-kill Kill Frida
AgentApi v3_list_app_icons_agent GET /v3/instances/{instanceId}/agent/v1/app/icons List app icons
AgentApi v3_list_apps_agent GET /v3/instances/{instanceId}/agent/v1/app/apps List apps
AgentApi v3_list_apps_status_agent GET /v3/instances/{instanceId}/agent/v1/app/apps/update List apps status
AgentApi v3_list_containers_agent GET /v3/instances/{instanceId}/agent/v1/container/containers List containers
AgentApi v3_list_frida_processes_agent POST /v3/instances/{instanceId}/agent/v1/frida/run-frida-ps List Frida processes
AgentApi v3_list_profiles_agent GET /v3/instances/{instanceId}/agent/v1/profile/profiles List profiles
AgentApi v3_lock_agent POST /v3/instances/{instanceId}/agent/v1/system/lock Lock device
AgentApi v3_preauthorize_file_archive_download_agent POST /v3/instances/{instanceId}/agent-authorize/v1/file/download Pre-authorize an archive download from VM
AgentApi v3_preauthorize_file_download_agent POST /v3/instances/{instanceId}/agent-authorize/v1/file/device/{filePath} Pre-authorize a file download from VM
AgentApi v3_run_app_agent POST /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run Run an app
AgentApi v3_run_frida_agent POST /v3/instances/{instanceId}/agent/v1/frida/run-frida Run Frida
AgentApi v3_set_adb_auth_agent PUT /v3/instances/{instanceId}/agent/v1/system/adbauth Set ADB auth setting
AgentApi v3_set_device_properties_agent POST /v3/instances/{instanceId}/agent/v1/system/setDeviceProperties Set device properties
AgentApi v3_set_file_attributes_agent PATCH /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Change attributes of a file on VM
AgentApi v3_set_hostname_agent POST /v3/instances/{instanceId}/agent/v1/system/setHostname Set instance hostname
AgentApi v3_shutdown_agent POST /v3/instances/{instanceId}/agent/v1/system/shutdown Shut down instance
AgentApi v3_start_container_agent POST /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start Start a container
AgentApi v3_start_container_app_agent POST /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application/{packageName}/{activityName} Start an app in a container
AgentApi v3_start_container_app_monitored_agent POST /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application-and-monitor/{packageName}/{activityName} Start and monitor an app in a container
AgentApi v3_stop_container_agent POST /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop Stop a container
AgentApi v3_stop_container_app_agent POST /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop-application-if-monitored Stop a monitored app in a container
AgentApi v3_uninstall_app_agent POST /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall Uninstall an app
AgentApi v3_uninstall_profile_agent DELETE /v3/instances/{instanceId}/agent/v1/profile/profiles/{profileId} Uninstall a profile
AgentApi v3_uninstall_remote_it_agent POST /v3/instances/{instanceId}/agent/v1/remoteit/uninstall Uninstall Remote.It
AgentApi v3_unlock_agent POST /v3/instances/{instanceId}/agent/v1/system/unlock Unlock device
AgentApi v3_upload_file_agent PUT /v3/instances/{instanceId}/agent/v1/file/device/{filePath} Upload a file to VM
AgentV1Api v1_agent_app_ready GET /v1/instances/{instanceId}/agent/v1/app/ready Check if App subsystem is ready
AgentV1Api v1_agent_delete_file DELETE /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Delete a File on VM
AgentV1Api v1_agent_get_file GET /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Download a File from VM
AgentV1Api v1_agent_get_temp_filename POST /v1/instances/{instanceId}/agent/v1/file/temp Get the path for a new temp file
AgentV1Api v1_agent_install_app POST /v1/instances/{instanceId}/agent/v1/app/install Install App at path
AgentV1Api v1_agent_install_profile POST /v1/instances/{instanceId}/agent/v1/profile/install Install a Profile to VM
AgentV1Api v1_agent_kill_app POST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill Kill an App
AgentV1Api v1_agent_list_app_icons GET /v1/instances/{instanceId}/agent/v1/app/icons List App Icons
AgentV1Api v1_agent_list_apps GET /v1/instances/{instanceId}/agent/v1/app/apps List Apps
AgentV1Api v1_agent_list_apps_status GET /v1/instances/{instanceId}/agent/v1/app/apps/update List Apps Status
AgentV1Api v1_agent_list_profiles GET /v1/instances/{instanceId}/agent/v1/profile/profiles List Profiles
AgentV1Api v1_agent_run_app POST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run Run an App
AgentV1Api v1_agent_set_file_attributes PATCH /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Change Attrs of a File on VM
AgentV1Api v1_agent_system_get_adb_auth GET /v1/instances/{instanceId}/agent/v1/system/adbauth Get ADB Auth Setting (AOSP only)
AgentV1Api v1_agent_system_get_network GET /v1/instances/{instanceId}/agent/v1/system/network Get IP of eth0 (AOSP only)
AgentV1Api v1_agent_system_get_prop POST /v1/instances/{instanceId}/agent/v1/system/getprop Get System Property (AOSP only)
AgentV1Api v1_agent_system_install_open_g_apps POST /v1/instances/{instanceId}/agent/v1/system/install-opengapps Install OpenGApps (AOSP only)
AgentV1Api v1_agent_system_lock POST /v1/instances/{instanceId}/agent/v1/system/lock Lock Device (iOS Only)
AgentV1Api v1_agent_system_set_adb_auth PUT /v1/instances/{instanceId}/agent/v1/system/adbauth Set ADB Auth Setting (AOSP only)
AgentV1Api v1_agent_system_set_hostname POST /v1/instances/{instanceId}/agent/v1/system/setHostname Set Hostname of instance
AgentV1Api v1_agent_system_shutdown POST /v1/instances/{instanceId}/agent/v1/system/shutdown Instruct VM to halt
AgentV1Api v1_agent_system_unlock POST /v1/instances/{instanceId}/agent/v1/system/unlock Unlock Device (iOS Only)
AgentV1Api v1_agent_uninstall_app POST /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall Uninstall an App
AgentV1Api v1_agent_uninstall_profile DELETE /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId} Uninstall a Profile from VM
AgentV1Api v1_agent_upload_file PUT /v1/instances/{instanceId}/agent/v1/file/device/{filePath} Upload a file to VM
AuthenticationApi v3_auth_login POST /v3/auth/login Log in
AuthenticationApi v3_auth_logout POST /v3/auth/logout Log out
AuthenticationApi v3_delete_api_token DELETE /v3/auth/apitoken Delete API token
AuthenticationApi v3_fetch_auth_provider_metadata GET /v3/auth/providers/fetch-metadata Fetch SAML metadata
AuthenticationApi v3_generate_api_token POST /v3/auth/apitoken Generate API token
AuthenticationApi v3_get_auth_provider_authorization_url GET /v3/auth/providers/{providerId}/authorization_url Get provider authorization URL
AuthenticationApi v3_get_auth_provider_callback GET /v3/auth/providers/{providerId}/callback Authentication provider callback (GET)
AuthenticationApi v3_get_auth_provider_sp_metadata GET /v3/auth/providers/{providerId}/spmetadata Get service provider metadata
AuthenticationApi v3_list_auth_provider_types GET /v3/auth/providers/types List authentication provider types
AuthenticationApi v3_list_auth_providers GET /v3/auth/providers List authentication providers
AuthenticationApi v3_post_auth_provider_callback POST /v3/auth/providers/{providerId}/callback Authentication provider callback (POST)
AuthenticationV1Api v1_auth_login POST /v1/auth/login Log In
AuthenticationV1Api v1_delete_api_token DELETE /v1/auth/apitoken Delete API token
AuthenticationV1Api v1_generate_api_token POST /v1/auth/apitoken Generate API token
BillingApi v3_cancel_subscription POST /v3/billing/cancel Cancel a subscription
BillingApi v3_get_billing_summary GET /v3/billing/summary Get billing summary
BillingApi v3_get_device_usage GET /v3/billing/usage Get device usage
BillingApi v3_get_metered_subscription_usage GET /v3/billing/subscription/metered/usage Get metered subscription usage
BillingApi v3_get_subscription GET /v3/billing/subscription Get the current subscription
BillingApi v3_subscribe_to_trial POST /v3/billing/trials/subscribe Subscribe to a trial
BillingApi v3_uncancel_subscription POST /v3/billing/uncancel Uncancel a subscription
ClusterApi v3_delete_cluster_snapshot DELETE /v3/cluster/snapshots/{snapshotId} Delete cluster snapshot
ClusterApi v3_get_cluster_config GET /v3/cluster/config Get cluster configuration
ClusterApi v3_get_cluster_node GET /v3/cluster/nodes/{nodeId} Get cluster node
ClusterApi v3_get_cluster_node_console GET /v3/cluster/nodes/{nodeId}/console Get node console websocket URL
ClusterApi v3_get_cluster_snapshot GET /v3/cluster/snapshots/{snapshotId} Get cluster snapshot
ClusterApi v3_list_cluster_nodes GET /v3/cluster/nodes List cluster nodes
ClusterApi v3_list_cluster_snapshots GET /v3/cluster/snapshots List cluster snapshots
ClusterApi v3_patch_cluster_config PATCH /v3/cluster/config Update cluster configuration
ClusterAdministrationConfigApi v1_get_cluster_config GET /v1/cluster/config Get cluster configuration
ClusterAdministrationConfigApi v1_patch_cluster_config PATCH /v1/cluster/config Update cluster configuration
ClusterAdministrationFirmwareServiceApi v1_create_assets_firmware_service POST /v1/cluster/firmware-service/firmware-assets Add firmware assets via the firmware service
ClusterAdministrationFirmwareServiceApi v1_create_image POST /v1/images Create a new Image
ClusterAdministrationFirmwareServiceApi v1_delete_asset_firmware_service DELETE /v1/cluster/firmware-service/firmware-assets/{assetURL} Delete a firmware asset by its URL
ClusterAdministrationFirmwareServiceApi v1_delete_firmware_firmware_service DELETE /v1/cluster/firmware-service/firmwares/{filename} Delete a firmware by filename from the firmware service
ClusterAdministrationFirmwareServiceApi v1_get_asset_extended_firmware_service GET /v1/cluster/firmware-service/firmware-assets/{assetURL}/extended Fetch extended firmware-asset details including instances and associated IPSWs
ClusterAdministrationFirmwareServiceApi v1_get_config_firmware_service GET /v1/cluster/firmware-service/config Fetch firmware service configuration
ClusterAdministrationFirmwareServiceApi v1_get_install_firmware_status GET /v1/images/install-firmware/{taskId} Query install firmware request status.
ClusterAdministrationFirmwareServiceApi v1_install_firmware POST /v1/images/install-firmware Installs a firmware for cluster-wide use
ClusterAdministrationFirmwareServiceApi v1_install_firmware_assets POST /v1/images/install-firmware-assets Installs firmware assets for cluster-wide use
ClusterAdministrationFirmwareServiceApi v1_list_assets_firmware_service GET /v1/cluster/firmware-service/firmware-assets Fetch firmware assets from the firmware service
ClusterAdministrationFirmwareServiceApi v1_list_devices_firmware_service GET /v1/cluster/firmware-service/devices Fetch devices from the firmware service
ClusterAdministrationFirmwareServiceApi v1_list_firmwares_firmware_service GET /v1/cluster/firmware-service/firmwares Fetch firmwares from the firmware service
ClusterAdministrationFirmwareServiceApi v1_patch_config_firmware_service PATCH /v1/cluster/firmware-service/config Update firmware service configuration
ClusterAdministrationFirmwareServiceApi v1_upload_image_data POST /v1/images/{imageId} Upload Image Data
ClusterAdministrationNodesApi v1_get_cluster_nodes GET /v1/cluster/nodes/{nodeId} Get node details by ID
ClusterAdministrationNodesApi v1_get_console_cluster_nodes GET /v1/cluster/nodes/{nodeId}/console Access node console via SSH
ClusterAdministrationNodesApi v1_list_cluster_nodes GET /v1/cluster/nodes List servers in the cluster
ClusterSnapshotsApi v1_delete_cluster_snapshot DELETE /v1/cluster/snapshots/{snapshotId} Delete a Cluster Snapshot
ClusterSnapshotsApi v1_get_cluster_snapshot GET /v1/cluster/snapshots/{snapshotId} Get Cluster Snapshot
ClusterSnapshotsApi v1_get_cluster_snapshots GET /v1/cluster/snapshots Get Cluster Snapshots
ConfigApi v3_get_config GET /v3/config Get deployment configuration
ConfigApi v3_get_version GET /v3/version Get the platform version
ConfigV1Api v1_get_config GET /v1/config Get all configs
CoreTraceApi v3_clear_core_trace DELETE /v3/instances/{instanceId}/strace Clear CoreTrace output
CoreTraceApi v3_list_threads GET /v3/instances/{instanceId}/strace/thread-list List running processes (CoreTrace)
CoreTraceApi v3_start_core_trace POST /v3/instances/{instanceId}/strace/enable Start CoreTrace
CoreTraceApi v3_stop_core_trace POST /v3/instances/{instanceId}/strace/disable Stop CoreTrace
CoreTraceApi v3_strace_preauthorize GET /v3/instances/{instanceId}/strace-authorize Get a CoreTrace download token
CoreTraceV1Api v1_clear_core_trace DELETE /v1/instances/{instanceId}/strace Clear CoreTrace logs
CoreTraceV1Api v1_list_threads GET /v1/instances/{instanceId}/strace/thread-list Get Running Threads (CoreTrace)
CoreTraceV1Api v1_start_core_trace POST /v1/instances/{instanceId}/strace/enable Start CoreTrace on an instance
CoreTraceV1Api v1_stop_core_trace POST /v1/instances/{instanceId}/strace/disable Stop CoreTrace on an instance.
DomainApi v3_create_domain_welcome_message POST /v3/domain/welcome Create a welcome message for a domain
DomainApi v3_delete_domain_welcome_message DELETE /v3/domain/welcome Delete the welcome message for the authenticated user's domain
DomainApi v3_get_domain_image_upload GET /v3/domain/image-upload/{type}/{imageId}/{name} Get image upload status
DomainApi v3_get_domain_welcome_message GET /v3/domain/welcome Get the welcome message for the authenticated user's domain
DomainApi v3_list_domain_software GET /v3/domain/software List domain-level firmware images
DomainApi v3_patch_domain_welcome_message PATCH /v3/domain/welcome Update a welcome message for a domain
DomainApi v3_put_domain_image_upload PUT /v3/domain/image-upload/{type}/{imageId}/{name} Upload image chunk
DomainAuthProviderApi v1_create_domain_auth_provider POST /v1/domain/{domainId}/auth Create a new auth provider for a domain
DomainAuthProviderApi v1_delete_domain_auth_provider DELETE /v1/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
DomainAuthProviderApi v1_get_domain_auth_providers GET /v1/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
DomainAuthProviderApi v1_update_domain_auth_provider PUT /v1/domain/{domainId}/auth/{providerId} Update an auth provider for a domain
DomainAuthProvidersApi v3_create_domain_auth_provider POST /v3/domain/{domainId}/auth Create a new auth provider for a domain
DomainAuthProvidersApi v3_delete_domain_auth_provider DELETE /v3/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
DomainAuthProvidersApi v3_list_domain_auth_providers GET /v3/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
DomainAuthProvidersApi v3_patch_domain_auth_provider PATCH /v3/domain/{domainId}/auth/{providerId} Partially update an auth provider for a domain
DomainAuthProvidersApi v3_update_domain_auth_provider PUT /v3/domain/{domainId}/auth/{providerId} Update an auth provider for a domain
DomainV1Api v1_create_domain_welcome_message POST /v1/domain/welcome Create a welcome message for a domain
DomainV1Api v1_delete_domain_welcome_message DELETE /v1/domain/welcome Delete the welcome message for the authenticated user's domain
DomainV1Api v1_get_domain_welcome_message GET /v1/domain/welcome Get the welcome message for the authenticated user's domain
DomainV1Api v1_update_domain_welcome_message PATCH /v1/domain/welcome Update a welcome message for a domain
ExtensionsApi v3_delete_extension DELETE /v3/extensions/{extensionId} Delete an existing extension
ExtensionsApi v3_get_extension_by_id GET /v3/extensions/{extensionId} Get extension by ID
ExtensionsApi v3_list_extensions GET /v3/extensions List all extensions
ExtensionsApi v3_load_extension POST /v3/extensions Load an extension
ExtensionsApi v3_parse_extension_json POST /v3/extensions/parse/extension.json Validates extension.json
ExtensionsApi v3_update_extension PUT /v3/extensions/{extensionId} Update an existing extension
ExtensionsV1Api v1_delete_extension DELETE /v1/extensions/{extensionId} Delete an existing extension
ExtensionsV1Api v1_get_extension_by_id GET /v1/extensions/{extensionId} Get extension by id
ExtensionsV1Api v1_get_extensions GET /v1/extensions Get all extensions
ExtensionsV1Api v1_load_extension POST /v1/extensions Load an extension
ExtensionsV1Api v1_parse_extension_json POST /v1/extensions/parse/extension.json Validates extension.json
ExtensionsV1Api v1_update_extension PUT /v1/extensions/{extensionId} Update an existing extension
ExternalServicesApi delete_external_service DELETE /{apiVersion}/external-services/{serviceName}/{path} Proxy a DELETE request to an external service
ExternalServicesApi get_external_service GET /{apiVersion}/external-services/{serviceName}/{path} Proxy a GET request to an external service
ExternalServicesApi patch_external_service PATCH /{apiVersion}/external-services/{serviceName}/{path} Proxy a PATCH request to an external service
ExternalServicesApi post_external_service POST /{apiVersion}/external-services/{serviceName}/{path} Proxy a POST request to an external service
ExternalServicesApi put_external_service PUT /{apiVersion}/external-services/{serviceName}/{path} Proxy a PUT request to an external service
FirmwareServiceApi v3_create_firmware_assets POST /v3/cluster/firmware-service/firmware-assets Add firmware assets
FirmwareServiceApi v3_delete_firmware DELETE /v3/cluster/firmware-service/firmwares/{filename} Delete a firmware
FirmwareServiceApi v3_delete_firmware_asset DELETE /v3/cluster/firmware-service/firmware-assets/{assetUrl} Delete a firmware asset
FirmwareServiceApi v3_get_firmware_asset_extended GET /v3/cluster/firmware-service/firmware-assets/{assetUrl}/extended Get extended firmware asset info
FirmwareServiceApi v3_get_firmware_service_config GET /v3/cluster/firmware-service/config Get firmware service configuration
FirmwareServiceApi v3_list_firmware_assets GET /v3/cluster/firmware-service/firmware-assets List firmware assets
FirmwareServiceApi v3_list_firmware_devices GET /v3/cluster/firmware-service/devices List firmware service devices
FirmwareServiceApi v3_list_firmwares GET /v3/cluster/firmware-service/firmwares List firmwares
FirmwareServiceApi v3_patch_firmware_service_config PATCH /v3/cluster/firmware-service/config Update firmware service configuration
FlavorsApi v3_get_frame GET /v3/flavors/{flavorId} Get the device frame layout for a model
FlavorsApi v3_get_frame_image GET /v3/flavors/{flavorId}/image Get the device frame image for a model
FlavorsApi v3_get_product_image GET /v3/flavors/{flavorId}/productimage Get the product image for a model
HyperTraceApi v3_btrace_preauthorize GET /v3/instances/{instanceId}/btrace-authorize Get a HyperTrace download token
HyperTraceApi v3_clear_hyper_trace DELETE /v3/instances/{instanceId}/btrace Clear HyperTrace output
HyperTraceApi v3_get_instance_kcrange GET /v3/instances/{instanceId}/btrace-kcrange List kernel extension address ranges
HyperTraceApi v3_start_hyper_trace POST /v3/instances/{instanceId}/btrace/enable Start HyperTrace
HyperTraceApi v3_stop_hyper_trace POST /v3/instances/{instanceId}/btrace/disable Stop HyperTrace
HyperTraceV1Api v1_btrace_preauthorize GET /v1/instances/{instanceId}/btrace-authorize Pre-authorize an btrace download
HyperTraceV1Api v1_clear_hyper_trace DELETE /v1/instances/{instanceId}/btrace Clear HyperTrace logs
HyperTraceV1Api v1_kcrange GET /v1/instances/{instanceId}/btrace-kcrange Get Kernel extension ranges
HyperTraceV1Api v1_start_hyper_trace POST /v1/instances/{instanceId}/btrace/enable Start HyperTrace on an instance
HyperTraceV1Api v1_stop_hyper_trace POST /v1/instances/{instanceId}/btrace/disable Stop HyperTrace on an instance.
HypertuneApi v3_hypertune_hash GET /v3/hypertune/hash Get Hypertune state hash
HypertuneApi v3_hypertune_init GET /v3/hypertune/init Get Hypertune initialization data
HypervisorHooksApi v3_clear_hyper_trace_hooks POST /v3/instances/{instanceId}/hooks/clear Stop hypervisor hooks
HypervisorHooksApi v3_create_hook POST /v3/instances/{instanceId}/hooks Create a hypervisor hook for an instance
HypervisorHooksApi v3_delete_hook DELETE /v3/hooks/{hookId} Delete a hypervisor hook
HypervisorHooksApi v3_execute_hyper_trace_hooks POST /v3/instances/{instanceId}/hooks/execute Run hypervisor hooks
HypervisorHooksApi v3_get_hook GET /v3/hooks/{hookId} Get a hypervisor hook by ID
HypervisorHooksApi v3_list_hooks GET /v3/instances/{instanceId}/hooks List hypervisor hooks for an instance
HypervisorHooksApi v3_update_hook PUT /v3/hooks/{hookId} Update a hypervisor hook
HypervisorHooksV1Api v1_clear_hyper_trace_hooks POST /v1/instances/{instanceId}/hooks/clear Clear Hooks on an instance
HypervisorHooksV1Api v1_create_hook POST /v1/instances/{instanceId}/hooks Create hypervisor hook for Instance
HypervisorHooksV1Api v1_delete_hook DELETE /v1/hooks/{hookId} Delete an existing hypervisor hook
HypervisorHooksV1Api v1_execute_hyper_trace_hooks POST /v1/instances/{instanceId}/hooks/execute Execute Hooks on an instance
HypervisorHooksV1Api v1_get_hook_by_id GET /v1/hooks/{hookId} Get hypervisor hook by id
HypervisorHooksV1Api v1_get_hooks GET /v1/instances/{instanceId}/hooks Get all hypervisor hooks for Instance
HypervisorHooksV1Api v1_update_hook PUT /v1/hooks/{hookId} Update an existing hypervisor hook
ImagesApi v3_create_image POST /v3/images Create an image
ImagesApi v3_delete_image DELETE /v3/images/{imageId} Delete an image
ImagesApi v3_get_image GET /v3/images/{imageId} Get image metadata
ImagesApi v3_get_image_chunk GET /v3/images/{imageId}/file Check whether an image chunk was already uploaded
ImagesApi v3_get_image_firmware_info POST /v3/images/{imageId}/fwinfo Get firmware info embedded in an image
ImagesApi v3_get_install_firmware_status GET /v3/images/install-firmware/{taskId} Get install-firmware task status
ImagesApi v3_install_firmware POST /v3/images/install-firmware Install firmware cluster-wide
ImagesApi v3_install_firmware_assets POST /v3/images/install-firmware-assets Install firmware assets cluster-wide
ImagesApi v3_list_images GET /v3/images List image metadata
ImagesApi v3_upload_image_chunk PUT /v3/images/{imageId}/file Upload one chunk of an image file
ImagesApi v3_upload_image_data POST /v3/images/{imageId} Upload image file contents
ImagesV1Api v1_get_image GET /v1/images/{imageId} Get Image Metadata
ImagesV1Api v1_get_images GET /v1/images Get all Images Metadata
ImagesV2Api v1_delete_image DELETE /v2/images/{imageId} Delete Image
InstancesApi v3_attach_instance_interface POST /v3/instances/{instanceId}/interfaces Connect an I/O interface
InstancesApi v3_clear_instance_panics DELETE /v3/instances/{instanceId}/panics Clear kernel panics
InstancesApi v3_create_instance POST /v3/instances Create a device
InstancesApi v3_delete_instance DELETE /v3/instances/{instanceId} Remove Instance
InstancesApi v3_detach_instance_interface DELETE /v3/instances/{instanceId}/interfaces/{interfaceId} Disconnect an I/O interface
InstancesApi v3_disable_expose_port POST /v3/instances/{instanceId}/exposeport/disable Stop exposing the device port
InstancesApi v3_download_netdump_pcap GET /v3/instances/{instanceId}/netdump.pcap Download the Enhanced Network Monitor capture
InstancesApi v3_download_network_monitor_pcap GET /v3/instances/{instanceId}/networkMonitor.pcap Download the Network Monitor capture
InstancesApi v3_enable_expose_port POST /v3/instances/{instanceId}/exposeport/enable Expose the device port
InstancesApi v3_get_instance GET /v3/instances/{instanceId} Get a device
InstancesApi v3_get_instance_console GET /v3/instances/{instanceId}/console Get console websocket URL
InstancesApi v3_get_instance_console_log GET /v3/instances/{instanceId}/consoleLog Read the console log
InstancesApi v3_get_instance_gpios GET /v3/instances/{instanceId}/gpios Read board LEDs, buttons and switches
InstancesApi v3_get_instance_image_upload GET /v3/instances/{instance}/image-upload/{type}/{imageId}/{name} Get image upload status
InstancesApi v3_get_instance_panics GET /v3/instances/{instanceId}/panics List kernel panics
InstancesApi v3_get_instance_peripherals GET /v3/instances/{instanceId}/peripherals Read simulated sensors
InstancesApi v3_get_instance_quick_connect_command GET /v3/instances/{instanceId}/quickConnectCommand Get the SSH quick-connect command
InstancesApi v3_get_instance_screenshot GET /v3/instances/{instanceId}/screenshot.{format} Take a screenshot
InstancesApi v3_get_instance_state GET /v3/instances/{instanceId}/state Get a device's state
InstancesApi v3_inject_message POST /v3/instances/{instanceId}/message Send an SMS message to an iOS device
InstancesApi v3_kernel_preauthorize GET /v3/instances/{instanceId}/kernel-authorize Get a kernel download token
InstancesApi v3_list_instances GET /v3/instances List Instances
InstancesApi v3_media_play POST /v3/instances/{instanceId}/media/play Play a video or audio file into the device
InstancesApi v3_media_stop POST /v3/instances/{instanceId}/media/stop Stop playing media
InstancesApi v3_patch_instance PATCH /v3/instances/{instanceId} Change device settings
InstancesApi v3_patch_instance_read_only PATCH /v3/instances/{instanceId}/read-only Update Instance Read Only
InstancesApi v3_pause_instance POST /v3/instances/{instanceId}/pause Pause a device
InstancesApi v3_post_instance_input POST /v3/instances/{instanceId}/input Provide Instance Input
InstancesApi v3_put_instance_image_upload PUT /v3/instances/{instance}/image-upload/{type}/{imageId}/{name} Upload image chunk
InstancesApi v3_reboot_instance POST /v3/instances/{instanceId}/reboot Restart a device
InstancesApi v3_restore_backup POST /v3/instances/{instanceId}/restoreBackup Restore a backup onto a device
InstancesApi v3_rotate_instance POST /v3/instances/{instanceId}/rotate Rotate the device
InstancesApi v3_set_instance_gpios PUT /v3/instances/{instanceId}/gpios Press board buttons or flip switches
InstancesApi v3_set_instance_peripherals PUT /v3/instances/{instanceId}/peripherals Change simulated sensors
InstancesApi v3_start_instance POST /v3/instances/{instanceId}/start Turn a device on
InstancesApi v3_start_netdump POST /v3/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor
InstancesApi v3_start_network_monitor POST /v3/instances/{instanceId}/sslsplit/enable Start Network Monitor
InstancesApi v3_stop_instance POST /v3/instances/{instanceId}/stop Turn a device off
InstancesApi v3_stop_netdump POST /v3/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor
InstancesApi v3_stop_network_monitor POST /v3/instances/{instanceId}/sslsplit/disable Stop Network Monitor
InstancesApi v3_unpause_instance POST /v3/instances/{instanceId}/unpause Resume a paused device
InstancesApi v3_upgrade_instance POST /v3/instances/{instanceId}/upgrade Upgrade the iOS version
InstancesApi v3_validate_instance_token POST /v3/instances/{instanceId}/token/validate Check a device connection token
InstancesV1Api v1_attach_instance_interface POST /v1/instances/{instanceId}/interfaces Attach I/O Interface
InstancesV1Api v1_clear_instance_panics DELETE /v1/instances/{instanceId}/panics Clear Panics
InstancesV1Api v1_create_instance POST /v1/instances Create Instance
InstancesV1Api v1_delete_instance DELETE /v1/instances/{instanceId} Remove Instance
InstancesV1Api v1_detach_instance_interface DELETE /v1/instances/{instanceId}/interfaces/{interfaceId} Detach I/O Interface
InstancesV1Api v1_disable_expose_port POST /v1/instances/{instanceId}/exposeport/disable Disable an exposed port on an instance for device access.
InstancesV1Api v1_download_netdump_pcap_instances GET /v1/instances/{instanceId}/netdump.pcap Download a netdump pcap file
InstancesV1Api v1_download_network_monitor_pcap_instances GET /v1/instances/{instanceId}/networkMonitor.pcap Download a Network Monitor pcap file
InstancesV1Api v1_enable_expose_port POST /v1/instances/{instanceId}/exposeport/enable Enable an exposed port on an instance for device access.
InstancesV1Api v1_get_instance GET /v1/instances/{instanceId} Get Instance
InstancesV1Api v1_get_instance_console GET /v1/instances/{instanceId}/console Get console websocket URL
InstancesV1Api v1_get_instance_console_log GET /v1/instances/{instanceId}/consoleLog Get Console Log
InstancesV1Api v1_get_instance_gpios GET /v1/instances/{instanceId}/gpios Get Instance GPIOs
InstancesV1Api v1_get_instance_panics GET /v1/instances/{instanceId}/panics Get Panics
InstancesV1Api v1_get_instance_peripherals GET /v1/instances/{instanceId}/peripherals Get Instance Peripherals
InstancesV1Api v1_get_instance_screenshot GET /v1/instances/{instanceId}/screenshot.{format} Get Instance Screenshot
InstancesV1Api v1_get_instances GET /v1/instances Get Instances
InstancesV1Api v1_inject_message_instances POST /v1/instances/{instanceId}/message Inject a message into an iOS VM
InstancesV1Api v1_media_play POST /v1/instances/{instanceId}/media/play Start playing media
InstancesV1Api v1_media_stop POST /v1/instances/{instanceId}/media/stop Stop playing media
InstancesV1Api v1_patch_instance PATCH /v1/instances/{instanceId} Update Instance
InstancesV1Api v1_patch_instance_read_only PATCH /v1/instances/{instanceId}/read-only Update Instance Read Only
InstancesV1Api v1_pause_instance POST /v1/instances/{instanceId}/pause Pause an Instance
InstancesV1Api v1_post_instance_input POST /v1/instances/{instanceId}/input Provide Instance Input
InstancesV1Api v1_reboot_instance POST /v1/instances/{instanceId}/reboot Reboot an Instance
InstancesV1Api v1_restore_backup POST /v1/instances/{instanceId}/restoreBackup Restore backup
InstancesV1Api v1_rotate_instance POST /v1/instances/{instanceId}/rotate Rotate device to specified orientation
InstancesV1Api v1_set_instance_gpios PUT /v1/instances/{instanceId}/gpios Set Instance GPIOs
InstancesV1Api v1_set_instance_peripherals PUT /v1/instances/{instanceId}/peripherals Update Instance Peripherals
InstancesV1Api v1_set_instance_state PUT /v1/instances/{instanceId}/state Set state of Instance
InstancesV1Api v1_start_instance POST /v1/instances/{instanceId}/start Start an Instance
InstancesV1Api v1_start_netdump POST /v1/instances/{instanceId}/netdump/enable Start Enhanced Network Monitor on an instance.
InstancesV1Api v1_start_network_monitor POST /v1/instances/{instanceId}/sslsplit/enable Start Network Monitor on an instance.
InstancesV1Api v1_stop_instance POST /v1/instances/{instanceId}/stop Stop an Instance
InstancesV1Api v1_stop_netdump POST /v1/instances/{instanceId}/netdump/disable Stop Enhanced Network Monitor on an instance.
InstancesV1Api v1_stop_network_monitor POST /v1/instances/{instanceId}/sslsplit/disable Stop Network Monitor on an instance.
InstancesV1Api v1_unpause_instance POST /v1/instances/{instanceId}/unpause Unpause an Instance
InstancesV1Api v1_upgrade_instance POST /v1/instances/{instanceId}/upgrade Upgrade iOS version
InstancesV2Api v2_get_instance_quick_connect_command GET /v2/instances/{instanceId}/quickConnectCommand Recommended SSH Command for Quick Connect
InstancesV2Api v2_get_instance_state GET /v2/instances/{instanceId}/state Get state of Instance
InterconnectsApi v3_create_interconnect POST /v3/interconnects Create I/O Interconnect
InterconnectsApi v3_delete_interconnect DELETE /v3/interconnects/{interconnectId} Delete I/O Interconnect
InterconnectsApi v3_get_interconnect GET /v3/interconnects/{interconnectId} Get Interconnect
InterconnectsApi v3_list_interconnects GET /v3/interconnects List I/O Interconnects
InterconnectsApi v3_patch_interconnect PATCH /v3/interconnects/{interconnectId} Patch I/O Interconnect
InterconnectsApi v3_update_interconnect PUT /v3/interconnects/{interconnectId} Update I/O Interconnect
InterconnectsV1Api v1_create_interconnect POST /v1/interconnects Create I/O Interconnect
InterconnectsV1Api v1_delete_interconnect DELETE /v1/interconnects/{interconnectId} Delete I/O Interconnect
InterconnectsV1Api v1_get_interconnect GET /v1/interconnects/{interconnectId} Get Interconnect
InterconnectsV1Api v1_list_interconnects GET /v1/interconnects Get all I/O Interconnects
InterconnectsV1Api v1_patch_interconnect PATCH /v1/interconnects/{interconnectId} Partial Update Interconnect
InterconnectsV1Api v1_update_interconnect PUT /v1/interconnects/{interconnectId} Update Interconnect
InvitesApi v3_create_invites POST /v3/invites Create invites
InvitesApi v3_edit_invites POST /v3/invites/edit Edit invites
InvitesApi v3_get_invite_by_token POST /v3/invites-by-token Get an invite by token
InvitesApi v3_list_invites GET /v3/invites List invites
InvitesApi v3_revoke_invites POST /v3/invites/revoke Revoke invites
InvitesApi v3_signup_from_invite POST /v3/invites/signup Sign up from an invite
InvitesV1Api v1_create_user_invites POST /v1/invites Create Invite
InvitesV1Api v1_edit_invites POST /v1/invites/edit
InvitesV1Api v1_invites GET /v1/invites Get Invites
InvitesV1Api v1_invites_by_token GET /v1/invites-by-token
InvitesV1Api v1_revoke_user_invite POST /v1/invites/revoke Revoke Invite
InvitesV1Api v1_user_create_from_invite POST /v1/invites/signup
ModelsApi v3_get_model_software GET /v3/models/{model}/software List software for a model
ModelsApi v3_get_models GET /v3/models List device models
ModelsV1Api v1_get_model_software GET /v1/models/{model}/software Get Software for Model
ModelsV1Api v1_get_models GET /v1/models Get Supported Models
NetConnectApi v3_create_network_connection POST /v3/network/connections Create a new Network Connection
NetConnectApi v3_delete_network_connection DELETE /v3/network/connections/{id} Delete an existing Network Connection
NetConnectApi v3_get_network_connection GET /v3/network/connections/{id} Fetch an existing Network Connection
NetConnectApi v3_list_network_connections GET /v3/network/connections List available network connections
NetConnectApi v3_list_network_interfaces GET /v3/network/interfaces List available physical network interfaces
NetConnectApi v3_list_network_providers GET /v3/network/providers List available network providers
NetConnectApi v3_partial_update_network_connection PATCH /v3/network/connections/{id} Update Network Connection (patch)
NetConnectApi v3_update_network_connection PUT /v3/network/connections/{id} Update Network Connection
NetConnectV1Api v1_create_network_connection POST /v1/network/connections Create a new Network Connection
NetConnectV1Api v1_delete_network_connection DELETE /v1/network/connections/{id} Delete an existing Network Connection
NetConnectV1Api v1_get_network_connection GET /v1/network/connections/{id} Return the configuration and per project statuses for a single network provider.
NetConnectV1Api v1_list_network_connections GET /v1/network/connections List available network connections
NetConnectV1Api v1_list_network_interfaces GET /v1/network/interfaces List available physical network interfaces
NetConnectV1Api v1_list_network_providers GET /v1/network/providers List available network providers
NetConnectV1Api v1_partial_update_network_connection PATCH /v1/network/connections/{id} Update Network Connection (partial)
NetConnectV1Api v1_update_network_connection PUT /v1/network/connections/{id} Update Network Connection
ProjectsApi v3_create_project POST /v3/projects Create a project
ProjectsApi v3_create_project_key POST /v3/projects/{projectId}/keys Add a project key
ProjectsApi v3_delete_project DELETE /v3/projects/{projectId} Delete a project
ProjectsApi v3_delete_project_key DELETE /v3/projects/{projectId}/keys/{keyId} Delete a project key
ProjectsApi v3_fetch_project_firmware_assets POST /v3/projects/{projectId}/firmware-assets Fetch firmware assets for a project
ProjectsApi v3_get_project GET /v3/projects/{projectId} Get a project
ProjectsApi v3_get_project_image_upload GET /v3/projects/{projectId}/image-upload/{type}/{imageId}/{name} Get image upload status
ProjectsApi v3_get_project_network_log GET /v3/projects/{projectId}/network/log Get project network log
ProjectsApi v3_get_project_network_status GET /v3/projects/{projectId}/network/status Get project network status
ProjectsApi v3_get_project_vpn_config GET /v3/projects/{projectId}/vpnconfig/{format} Get project VPN configuration
ProjectsApi v3_list_project_instances GET /v3/projects/{projectId}/instances List project instances
ProjectsApi v3_list_project_keys GET /v3/projects/{projectId}/keys List project keys
ProjectsApi v3_list_projects GET /v3/projects List projects
ProjectsApi v3_patch_project PATCH /v3/projects/{projectId} Update a project
ProjectsApi v3_preauth_vpn_config POST /v3/projects/{projectId}/preauth-vpn-config/{filename} Pre-authorize a VPN configuration download
ProjectsApi v3_put_project_image_upload PUT /v3/projects/{projectId}/image-upload/{type}/{imageId}/{name} Upload image chunk
ProjectsV1Api v1_add_project_key POST /v1/projects/{projectId}/keys Add Project Authorized Key
ProjectsV1Api v1_create_project POST /v1/projects Create a Project
ProjectsV1Api v1_delete_project DELETE /v1/projects/{projectId} Delete a Project
ProjectsV1Api v1_get_project GET /v1/projects/{projectId} Get a Project
ProjectsV1Api v1_get_project_instances GET /v1/projects/{projectId}/instances Get Instances in Project
ProjectsV1Api v1_get_project_keys GET /v1/projects/{projectId}/keys Get Project Authorized Keys
ProjectsV1Api v1_get_project_network_log GET /v1/projects/{projectId}/network/log Retrieve the network connection log for a project
ProjectsV1Api v1_get_project_network_status GET /v1/projects/{projectId}/network/status Retrieve the network connection status for a project
ProjectsV1Api v1_get_project_vpn_config GET /v1/projects/{projectId}/vpnconfig/{format} Get Project VPN Configuration
ProjectsV1Api v1_get_projects GET /v1/projects Get Projects
ProjectsV1Api v1_remove_project_key DELETE /v1/projects/{projectId}/keys/{keyId} Delete Project Authorized Key
ProjectsV1Api v1_update_project PATCH /v1/projects/{projectId} Update a Project
ProjectsV1Api v1_update_project_settings PATCH /v1/projects/{projectId}/settings Change Project Settings
RAMDumpApi v3_clear_ram_dump DELETE /v3/instances/{instanceId}/ramdump Delete a RAM dump
RAMDumpApi v3_ram_dump_preauthorize GET /v3/instances/{instanceId}/ramdump-authorize Get a RAM dump download token
RAMDumpApi v3_start_ram_dump POST /v3/instances/{instanceId}/ramdump/start Start a RAM dump
RAMDumpV1Api v1_clear_ram_dump DELETE /v1/instances/{instanceId}/ramdump Clear RAM Dump
RAMDumpV1Api v1_ram_dump_preauthorize GET /v1/instances/{instanceId}/ramdump-authorize Pre-authorize a RAM Dump download
RAMDumpV1Api v1_start_ram_dump POST /v1/instances/{instanceId}/ramdump/start Start a RAM Dump on an instance
RolesApi v3_add_team_role_to_deployment PUT /v3/roles/deployments/{deploymentId}/teams/{teamId}/roles/{roleId} Add team role to deployment
RolesApi v3_add_team_role_to_project PUT /v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Add team role to project
RolesApi v3_add_user_role_to_deployment PUT /v3/roles/deployments/{deploymentId}/users/{userId}/roles/{roleId} Add user role to deployment
RolesApi v3_add_user_role_to_project PUT /v3/roles/projects/{projectId}/users/{userId}/roles/{roleId} Add user role to project
RolesApi v3_list_deployment_roles GET /v3/roles/deployments List deployment role assignments
RolesApi v3_list_roles GET /v3/roles List all role assignments for the caller's domain
RolesApi v3_remove_team_role_from_deployment DELETE /v3/roles/deployments/{deploymentId}/teams/{teamId}/roles/{roleId} Remove team role from deployment
RolesApi v3_remove_team_role_from_project DELETE /v3/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Remove team role from project
RolesApi v3_remove_user_role_from_deployment DELETE /v3/roles/deployments/{deploymentId}/users/{userId}/roles/{roleId} Remove user role from deployment
RolesApi v3_remove_user_role_from_project DELETE /v3/roles/projects/{projectId}/users/{userId}/roles/{roleId} Remove user role from project
RolesV1Api v1_add_team_role_to_project PUT /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Add team role to project
RolesV1Api v1_add_user_role_to_project PUT /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Add user role to project
RolesV1Api v1_remove_team_role_from_project DELETE /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} Remove team role from project
RolesV1Api v1_remove_user_role_from_project DELETE /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} Remove user role from project
RolesV1Api v1_roles GET /v1/roles Get all roles
SnapshotSharingApi v3_accept_shared_snapshot POST /v3/snapshots/accept Accept a shared snapshot
SnapshotSharingApi v3_delete_snapshot_permissions DELETE /v3/snapshots/{snapshotId}/permissions Delete member(s)
SnapshotSharingApi v3_get_shared_snapshots GET /v3/snapshots/shared Fetch shared snapshots
SnapshotSharingApi v3_set_snapshot_permissions POST /v3/snapshots/{snapshotId}/permissions Set member list
SnapshotSharingApi v3_share_snapshot POST /v3/snapshots/{snapshotId}/share Create or update snapshot sharing
SnapshotSharingV1Api v1_accept_shared_snapshot POST /v1/snapshots/accept Accept a snapshot shared with you
SnapshotSharingV1Api v1_delete_snapshot_permissions DELETE /v1/snapshots/{snapshotId}/permissions Delete member(s)
SnapshotSharingV1Api v1_get_shared_snapshots GET /v1/snapshots/shared Fetch shared snapshots
SnapshotSharingV1Api v1_set_snapshot_permissions POST /v1/snapshots/{snapshotId}/permissions Set member list
SnapshotSharingV1Api v1_share_snapshot POST /v1/snapshots/{snapshotId}/share Share snapshot
SnapshotsApi v3_create_instance_snapshot POST /v3/instances/{instanceId}/snapshots Create instance snapshot
SnapshotsApi v3_delete_instance_snapshot DELETE /v3/instances/{instanceId}/snapshots/{snapshotId} Delete an instance snapshot
SnapshotsApi v3_delete_snapshot DELETE /v3/snapshots/{snapshotId} Delete a snapshot
SnapshotsApi v3_get_instance_snapshot GET /v3/instances/{instanceId}/snapshots/{snapshotId} Get instance snapshot
SnapshotsApi v3_get_snapshot GET /v3/snapshots/{snapshotId} Get snapshot
SnapshotsApi v3_list_instance_snapshots GET /v3/instances/{instanceId}/snapshots List instance snapshots
SnapshotsApi v3_patch_instance_snapshot PATCH /v3/instances/{instanceId}/snapshots/{snapshotId} Update an instance snapshot
SnapshotsApi v3_restore_instance_snapshot POST /v3/instances/{instanceId}/snapshots/{snapshotId}/restore Restore instance snapshot
SnapshotsApi v3_update_snapshot PATCH /v3/snapshots/{snapshotId} Update snapshot name
SnapshotsV1Api v1_create_snapshot POST /v1/instances/{instanceId}/snapshots Create Instance Snapshot
SnapshotsV1Api v1_delete_instance_snapshot DELETE /v1/instances/{instanceId}/snapshots/{snapshotId} Delete an Instance Snapshot
SnapshotsV1Api v1_delete_snapshot DELETE /v1/snapshots/{snapshotId} Delete a Snapshot
SnapshotsV1Api v1_get_instance_snapshot GET /v1/instances/{instanceId}/snapshots/{snapshotId} Get Instance Snapshot
SnapshotsV1Api v1_get_instance_snapshots GET /v1/instances/{instanceId}/snapshots Get Instance Snapshots
SnapshotsV1Api v1_get_snapshot GET /v1/snapshots/{snapshotId} Get Snapshot
SnapshotsV1Api v1_rename_instance_snapshot PATCH /v1/instances/{instanceId}/snapshots/{snapshotId} Rename an Instance Snapshot
SnapshotsV1Api v1_restore_instance_snapshot POST /v1/instances/{instanceId}/snapshots/{snapshotId}/restore Restore an Instance Snapshot
SnapshotsV1Api v1_snapshot_rename PATCH /v1/snapshots/{snapshotId} Rename a Snapshot
StatusApi v3_ready GET /v3/ready Check that the API is ready
StatusV1Api v1_ready GET /v1/ready API Status
StorageApi v3_attach_cluster_storage POST /v3/cluster/storage/{id}/attach Attach storage device
StorageApi v3_eject_cluster_storage POST /v3/cluster/storage/{id}/eject Eject storage device
StorageApi v3_list_cluster_storage GET /v3/cluster/storage List cluster storage devices
StorageApi v3_list_storage GET /v3/storage List server-attached storage devices
StorageApi v3_list_storage_files GET /v3/storage/{id}/files/{path} List storage files
StorageV1Api v1_attach_storage_cluster POST /v1/cluster/storage/{id}/attach Mount and attach a storage device
StorageV1Api v1_eject_storage_cluster POST /v1/cluster/storage/{id}/eject Eject/Unmount removable media
StorageV1Api v1_list_storage GET /v1/storage Get storage devices
StorageV1Api v1_list_storage_cluster GET /v1/cluster/storage Get storage devices
StorageV1Api v1_list_storage_files GET /v1/storage/{id}/files/{path} List Storage Files
TOTPApi v3_disable_totp POST /v3/totp/disable Disable TOTP for this user
TOTPApi v3_enable_totp POST /v3/totp/enable Enable TOTP for this user
TOTPApi v3_generate_totp POST /v3/totp/generate Generate a TOTP secret
TeamsApi v3_add_user_to_team PUT /v3/teams/{teamId}/users/{userId} Add a user to a team
TeamsApi v3_create_team POST /v3/teams Create a team
TeamsApi v3_delete_team DELETE /v3/teams/{teamId} Delete a team
TeamsApi v3_list_teams GET /v3/teams List teams
TeamsApi v3_remove_user_from_team DELETE /v3/teams/{teamId}/users/{userId} Remove a user from a team
TeamsApi v3_update_team PATCH /v3/teams/{teamId} Update a team
TeamsV1Api v1_add_user_to_team PUT /v1/teams/{teamId}/users/{userId} Add user to team
TeamsV1Api v1_remove_user_from_team DELETE /v1/teams/{teamId}/users/{userId} Remove user from team
TeamsV1Api v1_team_change PATCH /v1/teams/{teamId} Update team
TeamsV1Api v1_team_create POST /v1/teams Create team
TeamsV1Api v1_team_delete DELETE /v1/teams/{teamId} Delete team
TeamsV1Api v1_teams GET /v1/teams Get teams
UsersApi v3_agree_to_terms POST /v3/users/agree Agree to terms
UsersApi v3_change_password POST /v3/users/change-password Change password
UsersApi v3_create_user POST /v3/users Create a user
UsersApi v3_delete_user DELETE /v3/users/{userId} Delete a user
UsersApi v3_get_reset_link_info POST /v3/users/reset-link-info Get reset link info
UsersApi v3_patch_user PATCH /v3/users/{userId} Update a user
UsersApi v3_reset_password POST /v3/users/reset-password Reset password
UsersApi v3_send_reset_link POST /v3/users/send-reset-link Send a password reset link
UsersApi v3_update_own_profile PATCH /v3/users/me Update your profile
UsersV1Api v1_change_password_users POST /v1/users/change-password Change User Password
UsersV1Api v1_create_user POST /v1/users Create User
UsersV1Api v1_delete_user DELETE /v1/users/{userId} Delete User
UsersV1Api v1_get_reset_link_info GET /v1/users/reset-link-info Send Password Reset Link Info
UsersV1Api v1_reset_user_password POST /v1/users/reset-password Reset User Password
UsersV1Api v1_send_user_reset_link POST /v1/users/send-reset-link Send Password Reset Link
UsersV1Api v1_update_user PATCH /v1/users/{userId} Update User
UsersV1Api v1_user_agree_terms POST /v1/users/agree Consent to the current terms and conditions
UsersV1Api v1_users_login POST /v1/users/login Log In
WebPlayerApi v3_create_web_player_session POST /v3/webplayer Create a webplayer session
WebPlayerApi v3_delete_web_player_session DELETE /v3/webplayer/{sessionId} Delete a webplayer session
WebPlayerApi v3_get_web_player_allowed_domains GET /v3/webplayer/allowedDomains Get allowed webplayer domains
WebPlayerApi v3_get_web_player_session GET /v3/webplayer/{sessionId} Get a webplayer session
WebPlayerApi v3_list_web_player_sessions GET /v3/webplayer List webplayer sessions
WebPlayerV1Api v1_web_player_allowed_domains GET /v1/webplayer/allowedDomains Retrieve the list of allowed domains for all Webplayer sessions
WebPlayerV1Api v1_web_player_create_session POST /v1/webplayer Create a new Webplayer Session
WebPlayerV1Api v1_web_player_destroy_session DELETE /v1/webplayer/{sessionId} Tear down a Webplayer Session
WebPlayerV1Api v1_web_player_list_sessions GET /v1/webplayer List all Webplayer sessions
WebPlayerV1Api v1_web_player_session_info GET /v1/webplayer/{sessionId} Retrieve Webplayer Session Information
AssessmentsApi v3_create_assessment POST /v3/services/matrix/{instanceId}/assessments Create an assessment.
AssessmentsApi v3_create_report_modification POST /v3/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Create report modifications.
AssessmentsApi v3_delete_assessment DELETE /v3/services/matrix/{instanceId}/assessments/{assessmentId} Delete an assessment.
AssessmentsApi v3_delete_report_modification DELETE /v3/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Delete report modifications.
AssessmentsApi v3_download_report GET /v3/services/matrix/{instanceId}/assessments/{assessmentId}/download Download an assessment report.
AssessmentsApi v3_get_assessment_by_id GET /v3/services/matrix/{instanceId}/assessments/{assessmentId} Get an assessment by ID.
AssessmentsApi v3_get_assessments_by_instance_id GET /v3/services/matrix/{instanceId}/instances/{targetInstanceId}/assessments List assessments for an instance.
AssessmentsApi v3_patch_assessment PATCH /v3/services/matrix/{instanceId}/assessments/{assessmentId} Update an assessment status.
AssessmentsApi v3_run_tests POST /v3/services/matrix/{instanceId}/assessments/{assessmentId}/test Run assessment tests.
AssessmentsApi v3_start_monitoring POST /v3/services/matrix/{instanceId}/assessments/{assessmentId}/start Start assessment monitoring.
AssessmentsApi v3_stop_monitoring POST /v3/services/matrix/{instanceId}/assessments/{assessmentId}/stop Stop assessment monitoring.
AssessmentsV1Api v1_create_assessment POST /v1/services/matrix/{instanceId}/assessments Create an assessment.
AssessmentsV1Api v1_create_report_modification POST /v1/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Create report modifications.
AssessmentsV1Api v1_delete_assessment DELETE /v1/services/matrix/{instanceId}/assessments/{assessmentId} Delete an assessment.
AssessmentsV1Api v1_delete_report_modification DELETE /v1/services/matrix/{instanceId}/assessments/{assessmentId}/report-modification Delete report modifications.
AssessmentsV1Api v1_download_report GET /v1/services/matrix/{instanceId}/assessments/{assessmentId}/download Download an assessment report.
AssessmentsV1Api v1_get_assessment_by_id GET /v1/services/matrix/{instanceId}/assessments/{assessmentId} Get an assessment by ID.
AssessmentsV1Api v1_get_assessments_by_instance_id GET /v1/services/matrix/{instanceId}/instances/{targetInstanceId}/assessments List assessments for an instance.
AssessmentsV1Api v1_patch_assessment PATCH /v1/services/matrix/{instanceId}/assessments/{assessmentId} Update an assessment status.
AssessmentsV1Api v1_run_tests POST /v1/services/matrix/{instanceId}/assessments/{assessmentId}/test Run assessment tests.
AssessmentsV1Api v1_start_monitoring POST /v1/services/matrix/{instanceId}/assessments/{assessmentId}/start Start assessment monitoring.
AssessmentsV1Api v1_stop_monitoring POST /v1/services/matrix/{instanceId}/assessments/{assessmentId}/stop Stop assessment monitoring.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication (JWT)

Author

support@corellium.com

About

Python Language API Client for Corellium

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

16 stars

Watchers

10 watching

Forks

1 fork
Report repository

Releases

Packages

Used by

Contributors

Languages