AgentApi.md

# corellium.AgentApi

## 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.


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

Method | HTTP request | Description
------------- | ------------- | -------------
[**v3_delete_file_agent**](AgentApi.md#v3_delete_file_agent) | **DELETE** /v3/instances/{instanceId}/agent/v1/file/device/{filePath} | Delete a file on VM
[**v3_get_adb_auth_agent**](AgentApi.md#v3_get_adb_auth_agent) | **GET** /v3/instances/{instanceId}/agent/v1/system/adbauth | Get ADB auth setting
[**v3_get_app_ready_agent**](AgentApi.md#v3_get_app_ready_agent) | **GET** /v3/instances/{instanceId}/agent/v1/app/ready | Check if app subsystem is ready
[**v3_get_container_health_agent**](AgentApi.md#v3_get_container_health_agent) | **GET** /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/is-healthy | Get container health
[**v3_get_file_agent**](AgentApi.md#v3_get_file_agent) | **GET** /v3/instances/{instanceId}/agent/v1/file/device/{filePath} | Download a file from VM
[**v3_get_network_agent**](AgentApi.md#v3_get_network_agent) | **GET** /v3/instances/{instanceId}/agent/v1/system/network | Get eth0 IP address
[**v3_get_prop_agent**](AgentApi.md#v3_get_prop_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/getprop | Get a system property
[**v3_get_remote_it_status_agent**](AgentApi.md#v3_get_remote_it_status_agent) | **GET** /v3/instances/{instanceId}/agent/v1/remoteit/status | Get Remote.It status
[**v3_get_temp_file_agent**](AgentApi.md#v3_get_temp_file_agent) | **POST** /v3/instances/{instanceId}/agent/v1/file/temp | Get a temp file path on VM
[**v3_install_agent**](AgentApi.md#v3_install_agent) | **POST** /v3/instances/{instanceId}/agent/v1/app/install | Install app at path
[**v3_install_open_gapps_agent**](AgentApi.md#v3_install_open_gapps_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/install-opengapps | Install OpenGApps
[**v3_install_profile_agent**](AgentApi.md#v3_install_profile_agent) | **POST** /v3/instances/{instanceId}/agent/v1/profile/install | Install a profile
[**v3_install_remote_it_agent**](AgentApi.md#v3_install_remote_it_agent) | **POST** /v3/instances/{instanceId}/agent/v1/remoteit/install | Install Remote.It
[**v3_kill_app_agent**](AgentApi.md#v3_kill_app_agent) | **POST** /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill | Kill an app
[**v3_kill_frida_agent**](AgentApi.md#v3_kill_frida_agent) | **POST** /v3/instances/{instanceId}/agent/v1/frida/run-frida-kill | Kill Frida
[**v3_list_app_icons_agent**](AgentApi.md#v3_list_app_icons_agent) | **GET** /v3/instances/{instanceId}/agent/v1/app/icons | List app icons
[**v3_list_apps_agent**](AgentApi.md#v3_list_apps_agent) | **GET** /v3/instances/{instanceId}/agent/v1/app/apps | List apps
[**v3_list_apps_status_agent**](AgentApi.md#v3_list_apps_status_agent) | **GET** /v3/instances/{instanceId}/agent/v1/app/apps/update | List apps status
[**v3_list_containers_agent**](AgentApi.md#v3_list_containers_agent) | **GET** /v3/instances/{instanceId}/agent/v1/container/containers | List containers
[**v3_list_frida_processes_agent**](AgentApi.md#v3_list_frida_processes_agent) | **POST** /v3/instances/{instanceId}/agent/v1/frida/run-frida-ps | List Frida processes
[**v3_list_profiles_agent**](AgentApi.md#v3_list_profiles_agent) | **GET** /v3/instances/{instanceId}/agent/v1/profile/profiles | List profiles
[**v3_lock_agent**](AgentApi.md#v3_lock_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/lock | Lock device
[**v3_preauthorize_file_archive_download_agent**](AgentApi.md#v3_preauthorize_file_archive_download_agent) | **POST** /v3/instances/{instanceId}/agent-authorize/v1/file/download | Pre-authorize an archive download from VM
[**v3_preauthorize_file_download_agent**](AgentApi.md#v3_preauthorize_file_download_agent) | **POST** /v3/instances/{instanceId}/agent-authorize/v1/file/device/{filePath} | Pre-authorize a file download from VM
[**v3_run_app_agent**](AgentApi.md#v3_run_app_agent) | **POST** /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run | Run an app
[**v3_run_frida_agent**](AgentApi.md#v3_run_frida_agent) | **POST** /v3/instances/{instanceId}/agent/v1/frida/run-frida | Run Frida
[**v3_set_adb_auth_agent**](AgentApi.md#v3_set_adb_auth_agent) | **PUT** /v3/instances/{instanceId}/agent/v1/system/adbauth | Set ADB auth setting
[**v3_set_device_properties_agent**](AgentApi.md#v3_set_device_properties_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/setDeviceProperties | Set device properties
[**v3_set_file_attributes_agent**](AgentApi.md#v3_set_file_attributes_agent) | **PATCH** /v3/instances/{instanceId}/agent/v1/file/device/{filePath} | Change attributes of a file on VM
[**v3_set_hostname_agent**](AgentApi.md#v3_set_hostname_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/setHostname | Set instance hostname
[**v3_shutdown_agent**](AgentApi.md#v3_shutdown_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/shutdown | Shut down instance
[**v3_start_container_agent**](AgentApi.md#v3_start_container_agent) | **POST** /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start | Start a container
[**v3_start_container_app_agent**](AgentApi.md#v3_start_container_app_agent) | **POST** /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/start-application/{packageName}/{activityName} | Start an app in a container
[**v3_start_container_app_monitored_agent**](AgentApi.md#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
[**v3_stop_container_agent**](AgentApi.md#v3_stop_container_agent) | **POST** /v3/instances/{instanceId}/agent/v1/container/containers/{containerId}/stop | Stop a container
[**v3_stop_container_app_agent**](AgentApi.md#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
[**v3_uninstall_app_agent**](AgentApi.md#v3_uninstall_app_agent) | **POST** /v3/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall | Uninstall an app
[**v3_uninstall_profile_agent**](AgentApi.md#v3_uninstall_profile_agent) | **DELETE** /v3/instances/{instanceId}/agent/v1/profile/profiles/{profileId} | Uninstall a profile
[**v3_uninstall_remote_it_agent**](AgentApi.md#v3_uninstall_remote_it_agent) | **POST** /v3/instances/{instanceId}/agent/v1/remoteit/uninstall | Uninstall Remote.It
[**v3_unlock_agent**](AgentApi.md#v3_unlock_agent) | **POST** /v3/instances/{instanceId}/agent/v1/system/unlock | Unlock device
[**v3_upload_file_agent**](AgentApi.md#v3_upload_file_agent) | **PUT** /v3/instances/{instanceId}/agent/v1/file/device/{filePath} | Upload a file to VM


# **v3_delete_file_agent**
> v3_delete_file_agent(instance_id, file_path)

Delete a file on VM

Delete a file from the VM filesystem.

Deletes are idempotent: an unknown `instanceId`, or a path the on-device agent no longer has, is a successful no-op that still returns 204, and
repeated calls return 204 as well. A 404 means the request path did not match a delete route, not
that the target was missing.
Other agent-reported failures, and an unreachable agent, are still reported as failures.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    file_path = '/var/tmp/agent.log' # str | Path to the file on the VM filesystem.

    try:
        # Delete a file on VM
        api_instance.v3_delete_file_agent(instance_id, file_path)
    except Exception as e:
        print("Exception when calling AgentApi->v3_delete_file_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **file_path** | **str**| Path to the file on the VM filesystem. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | File deleted successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_adb_auth_agent**
> AgentSystemAdbAuth v3_get_adb_auth_agent(instance_id)

Get ADB auth setting

Get the current ADB authorization setting (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_adb_auth import AgentSystemAdbAuth
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Get ADB auth setting
        api_response = api_instance.v3_get_adb_auth_agent(instance_id)
        print("The response of AgentApi->v3_get_adb_auth_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_adb_auth_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentSystemAdbAuth**](AgentSystemAdbAuth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Current ADB auth setting. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_app_ready_agent**
> AgentAppReadyResponse v3_get_app_ready_agent(instance_id)

Check if app subsystem is ready

Checks whether the device's agent is ready to manage apps. The agent is a helper service running inside the device that carries out the Agent calls (installing and running apps, reading and writing files, and so on). It starts after the device boots, so a device that just turned `on` may not be ready yet. Call this first and wait until it reports ready before using the other Agent endpoints.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_app_ready_response import AgentAppReadyResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Check if app subsystem is ready
        api_response = api_instance.v3_get_app_ready_agent(instance_id)
        print("The response of AgentApi->v3_get_app_ready_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_app_ready_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentAppReadyResponse**](AgentAppReadyResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | App agent state. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_container_health_agent**
> AgentContainerHealth v3_get_container_health_agent(instance_id, container_id)

Get container health

Check whether a nested container is healthy (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_container_health import AgentContainerHealth
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).

    try:
        # Get container health
        api_response = api_instance.v3_get_container_health_agent(instance_id, container_id)
        print("The response of AgentApi->v3_get_container_health_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_container_health_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 

### Return type

[**AgentContainerHealth**](AgentContainerHealth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Container health. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_file_agent**
> bytearray v3_get_file_agent(instance_id, file_path)

Download a file from VM

Downloads one file from the device's filesystem, given its full path on the device (for example `/tmp/log.txt`). The response body is the raw file. For large files, use `v3PreauthorizeFileDownloadAgent` so the download does not have to pass through your SDK client.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    file_path = '/var/tmp/agent.log' # str | Path to the file on the VM filesystem.

    try:
        # Download a file from VM
        api_response = api_instance.v3_get_file_agent(instance_id, file_path)
        print("The response of AgentApi->v3_get_file_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_file_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **file_path** | **str**| Path to the file on the VM filesystem. | 

### Return type

**bytearray**

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/octet-stream, application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | File contents. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_network_agent**
> AgentSystemNetworkResponse v3_get_network_agent(instance_id)

Get eth0 IP address

Get the IP address bound to eth0 (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_network_response import AgentSystemNetworkResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Get eth0 IP address
        api_response = api_instance.v3_get_network_agent(instance_id)
        print("The response of AgentApi->v3_get_network_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_network_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentSystemNetworkResponse**](AgentSystemNetworkResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | IP address of eth0. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_prop_agent**
> AgentSystemGetPropResponse v3_get_prop_agent(instance_id, agent_system_get_prop_body)

Get a system property

Get the value of a system property (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_get_prop_body import AgentSystemGetPropBody
from corellium.models.agent_system_get_prop_response import AgentSystemGetPropResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_system_get_prop_body = corellium.AgentSystemGetPropBody() # AgentSystemGetPropBody | 

    try:
        # Get a system property
        api_response = api_instance.v3_get_prop_agent(instance_id, agent_system_get_prop_body)
        print("The response of AgentApi->v3_get_prop_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_prop_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_system_get_prop_body** | [**AgentSystemGetPropBody**](AgentSystemGetPropBody.md)|  | 

### Return type

[**AgentSystemGetPropResponse**](AgentSystemGetPropResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Value of the requested property. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_remote_it_status_agent**
> AgentRemoteItStatus v3_get_remote_it_status_agent(instance_id)

Get Remote.It status

Get the installation status of the Remote.It package on the VM (RPi only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_remote_it_status import AgentRemoteItStatus
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Get Remote.It status
        api_response = api_instance.v3_get_remote_it_status_agent(instance_id)
        print("The response of AgentApi->v3_get_remote_it_status_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_remote_it_status_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentRemoteItStatus**](AgentRemoteItStatus.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Current Remote.It status. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |
**404** | The resource does not exist, or you cannot see it. |  -  |
**405** | Method not allowed. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_get_temp_file_agent**
> AgentTempFileResponse v3_get_temp_file_agent(instance_id)

Get a temp file path on VM

Returns an unused temporary file path on the device, free at the moment of the call. Use it as the target for `v3UploadFileAgent`, for example to stage an app package before `v3InstallAgent`.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_temp_file_response import AgentTempFileResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Get a temp file path on VM
        api_response = api_instance.v3_get_temp_file_agent(instance_id)
        print("The response of AgentApi->v3_get_temp_file_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_get_temp_file_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentTempFileResponse**](AgentTempFileResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Temporary file path. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_install_agent**
> v3_install_agent(instance_id, agent_install_body)

Install app at path

Installs an app from a package file that is already on the device, for example an `.ipa` (iOS) or `.apk` (Android). Returns 204 once installed.

**Installing an app from your computer:**
1. `v3GetAppReadyAgent`: wait until the agent is ready.
2. `v3GetTempFileAgent`: get a free temporary path on the device.
3. `v3UploadFileAgent`: upload the package to that path.
4. `v3InstallAgent` (this call) with that `path`.
5. `v3ListAppsAgent` to find the app's bundle ID, then `v3RunAppAgent` to start it.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_install_body import AgentInstallBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_install_body = corellium.AgentInstallBody() # AgentInstallBody | 

    try:
        # Install app at path
        api_instance.v3_install_agent(instance_id, agent_install_body)
    except Exception as e:
        print("Exception when calling AgentApi->v3_install_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_install_body** | [**AgentInstallBody**](AgentInstallBody.md)|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | App installed successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_install_open_gapps_agent**
> v3_install_open_gapps_agent(instance_id, agent_system_install_open_gapps_body)

Install OpenGApps

Download and install OpenGApps on the instance (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_install_open_gapps_body import AgentSystemInstallOpenGappsBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_system_install_open_gapps_body = corellium.AgentSystemInstallOpenGappsBody() # AgentSystemInstallOpenGappsBody | 

    try:
        # Install OpenGApps
        api_instance.v3_install_open_gapps_agent(instance_id, agent_system_install_open_gapps_body)
    except Exception as e:
        print("Exception when calling AgentApi->v3_install_open_gapps_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_system_install_open_gapps_body** | [**AgentSystemInstallOpenGappsBody**](AgentSystemInstallOpenGappsBody.md)|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | OpenGApps installation started successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_install_profile_agent**
> v3_install_profile_agent(instance_id, body)

Install a profile

Install a configuration profile on the VM.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    body = None # bytearray | 

    try:
        # Install a profile
        api_instance.v3_install_profile_agent(instance_id, body)
    except Exception as e:
        print("Exception when calling AgentApi->v3_install_profile_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **body** | **bytearray**|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/octet-stream
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Profile installed successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_install_remote_it_agent**
> AgentRemoteItStatus v3_install_remote_it_agent(instance_id)

Install Remote.It

Install the Remote.It package on the VM (RPi only). The device name and platform code are derived server-side from the instance and its flavor.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_remote_it_status import AgentRemoteItStatus
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Install Remote.It
        api_response = api_instance.v3_install_remote_it_agent(instance_id)
        print("The response of AgentApi->v3_install_remote_it_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_install_remote_it_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentRemoteItStatus**](AgentRemoteItStatus.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Remote.It status after install. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |
**404** | The resource does not exist, or you cannot see it. |  -  |
**405** | Method not allowed. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_kill_app_agent**
> v3_kill_app_agent(instance_id, bundle_id)

Kill an app

Force-quits a running app on the device, identified by its bundle ID. The app stays installed; start it again with `v3RunAppAgent`.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    bundle_id = 'com.corellium.cafe' # str | App bundle ID.

    try:
        # Kill an app
        api_instance.v3_kill_app_agent(instance_id, bundle_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_kill_app_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **bundle_id** | **str**| App bundle ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | App killed successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_kill_frida_agent**
> AgentFridaResponse v3_kill_frida_agent(instance_id)

Kill Frida

Stop the running Frida session on the VM.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_frida_response import AgentFridaResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Kill Frida
        api_response = api_instance.v3_kill_frida_agent(instance_id)
        print("The response of AgentApi->v3_kill_frida_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_kill_frida_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentFridaResponse**](AgentFridaResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Frida killed successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_app_icons_agent**
> AgentIconsResponse v3_list_app_icons_agent(instance_id, bundle_id)

List app icons

List app icons as base64-encoded data for the specified bundle IDs.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_icons_response import AgentIconsResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    bundle_id = ['[\"com.corellium.cafe\"]'] # List[str] | One or more app bundle IDs to fetch icons for.

    try:
        # List app icons
        api_response = api_instance.v3_list_app_icons_agent(instance_id, bundle_id)
        print("The response of AgentApi->v3_list_app_icons_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_app_icons_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **bundle_id** | [**List[str]**](str.md)| One or more app bundle IDs to fetch icons for. | 

### Return type

[**AgentIconsResponse**](AgentIconsResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | App icons keyed by bundle ID. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_apps_agent**
> AgentAppsList v3_list_apps_agent(instance_id, load_icons=load_icons)

List apps

Lists the apps installed on the device, with each app's bundle ID (for example `com.android.egg`) and name. The bundle ID is what the run, kill and uninstall calls need.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_apps_list import AgentAppsList
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    load_icons = 'load_icons_example' # str | Whether to include each app icon in the response. (optional)

    try:
        # List apps
        api_response = api_instance.v3_list_apps_agent(instance_id, load_icons=load_icons)
        print("The response of AgentApi->v3_list_apps_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_apps_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **load_icons** | **str**| Whether to include each app icon in the response. | [optional] 

### Return type

[**AgentAppsList**](AgentAppsList.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Installed apps info. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |
**500** | The agent returned an invalid app list. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_apps_status_agent**
> AgentAppsStatusList v3_list_apps_status_agent(instance_id)

List apps status

Returns, for every installed app, whether it is currently running. Use it to check that an app started after `v3RunAppAgent`, or stopped after `v3KillAppAgent`.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_apps_status_list import AgentAppsStatusList
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # List apps status
        api_response = api_instance.v3_list_apps_status_agent(instance_id)
        print("The response of AgentApi->v3_list_apps_status_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_apps_status_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentAppsStatusList**](AgentAppsStatusList.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Installed apps status info. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_containers_agent**
> AgentContainerList v3_list_containers_agent(instance_id)

List containers

List the nested containers on the VM (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_container_list import AgentContainerList
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # List containers
        api_response = api_instance.v3_list_containers_agent(instance_id)
        print("The response of AgentApi->v3_list_containers_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_containers_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentContainerList**](AgentContainerList.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of containers. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_frida_processes_agent**
> AgentFridaProcessList v3_list_frida_processes_agent(instance_id)

List Frida processes

Run frida-ps on the VM and return the list of processes.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_frida_process_list import AgentFridaProcessList
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # List Frida processes
        api_response = api_instance.v3_list_frida_processes_agent(instance_id)
        print("The response of AgentApi->v3_list_frida_processes_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_frida_processes_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentFridaProcessList**](AgentFridaProcessList.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Frida process list. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_profiles_agent**
> AgentProfileListResponse v3_list_profiles_agent(instance_id)

List profiles

List the configuration profiles installed on the VM.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_profile_list_response import AgentProfileListResponse
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # List profiles
        api_response = api_instance.v3_list_profiles_agent(instance_id)
        print("The response of AgentApi->v3_list_profiles_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_list_profiles_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentProfileListResponse**](AgentProfileListResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Installed profiles. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_lock_agent**
> v3_lock_agent(instance_id)

Lock device

Lock the device (iOS only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Lock device
        api_instance.v3_lock_agent(instance_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_lock_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Device locked successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_preauthorize_file_archive_download_agent**
> AgentFileDownloadToken v3_preauthorize_file_archive_download_agent(instance_id, agent_file_archive_download_body)

Pre-authorize an archive download from VM

Returns a short-lived token for downloading several files and folders from the device as one ZIP archive, built on the server. List the paths to include in the body, then download with `GET /v1/preauthed/{token}/{filename}`. The token expires with your current session.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_file_archive_download_body import AgentFileArchiveDownloadBody
from corellium.models.agent_file_download_token import AgentFileDownloadToken
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_file_archive_download_body = corellium.AgentFileArchiveDownloadBody() # AgentFileArchiveDownloadBody | 

    try:
        # Pre-authorize an archive download from VM
        api_response = api_instance.v3_preauthorize_file_archive_download_agent(instance_id, agent_file_archive_download_body)
        print("The response of AgentApi->v3_preauthorize_file_archive_download_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_preauthorize_file_archive_download_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_file_archive_download_body** | [**AgentFileArchiveDownloadBody**](AgentFileArchiveDownloadBody.md)|  | 

### Return type

[**AgentFileDownloadToken**](AgentFileDownloadToken.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preauthorized archive download token. |  -  |
**400** | The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_preauthorize_file_download_agent**
> AgentFileDownloadToken v3_preauthorize_file_download_agent(instance_id, file_path)

Pre-authorize a file download from VM

Returns a short-lived token for downloading one device file directly (for example from a browser or download manager) without an `Authorization` header and without buffering it in your SDK client. Download it with `GET /v1/preauthed/{token}/{filename}`. The token works only for this file and expires with your current session.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_file_download_token import AgentFileDownloadToken
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    file_path = '/var/tmp/agent.log' # str | Path to the file on the VM filesystem.

    try:
        # Pre-authorize a file download from VM
        api_response = api_instance.v3_preauthorize_file_download_agent(instance_id, file_path)
        print("The response of AgentApi->v3_preauthorize_file_download_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_preauthorize_file_download_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **file_path** | **str**| Path to the file on the VM filesystem. | 

### Return type

[**AgentFileDownloadToken**](AgentFileDownloadToken.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preauthorized download token. |  -  |
**400** | The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_run_app_agent**
> v3_run_app_agent(instance_id, bundle_id)

Run an app

Launches an installed app on the device, identified by its bundle ID from `v3ListAppsAgent`. Returns 204 once the launch has been requested; check `v3ListAppsStatusAgent` to confirm it is running.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    bundle_id = 'com.corellium.cafe' # str | App bundle ID.

    try:
        # Run an app
        api_instance.v3_run_app_agent(instance_id, bundle_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_run_app_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **bundle_id** | **str**| App bundle ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | App started successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_run_frida_agent**
> AgentFridaResponse v3_run_frida_agent(instance_id, agent_frida_run_body)

Run Frida

Attach Frida to a target process on the VM.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_frida_response import AgentFridaResponse
from corellium.models.agent_frida_run_body import AgentFridaRunBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_frida_run_body = corellium.AgentFridaRunBody() # AgentFridaRunBody | 

    try:
        # Run Frida
        api_response = api_instance.v3_run_frida_agent(instance_id, agent_frida_run_body)
        print("The response of AgentApi->v3_run_frida_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_run_frida_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_frida_run_body** | [**AgentFridaRunBody**](AgentFridaRunBody.md)|  | 

### Return type

[**AgentFridaResponse**](AgentFridaResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Frida attached successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_set_adb_auth_agent**
> v3_set_adb_auth_agent(instance_id, agent_system_adb_auth)

Set ADB auth setting

Enable or disable ADB authorization (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_adb_auth import AgentSystemAdbAuth
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_system_adb_auth = corellium.AgentSystemAdbAuth() # AgentSystemAdbAuth | 

    try:
        # Set ADB auth setting
        api_instance.v3_set_adb_auth_agent(instance_id, agent_system_adb_auth)
    except Exception as e:
        print("Exception when calling AgentApi->v3_set_adb_auth_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_system_adb_auth** | [**AgentSystemAdbAuth**](AgentSystemAdbAuth.md)|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | ADB auth setting updated successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_set_device_properties_agent**
> AgentSystemResult v3_set_device_properties_agent(instance_id, agent_system_set_device_properties_body=agent_system_set_device_properties_body)

Set device properties

Set device properties (model and manufacturer ID) of the instance (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_result import AgentSystemResult
from corellium.models.agent_system_set_device_properties_body import AgentSystemSetDevicePropertiesBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_system_set_device_properties_body = corellium.AgentSystemSetDevicePropertiesBody() # AgentSystemSetDevicePropertiesBody |  (optional)

    try:
        # Set device properties
        api_response = api_instance.v3_set_device_properties_agent(instance_id, agent_system_set_device_properties_body=agent_system_set_device_properties_body)
        print("The response of AgentApi->v3_set_device_properties_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_set_device_properties_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_system_set_device_properties_body** | [**AgentSystemSetDevicePropertiesBody**](AgentSystemSetDevicePropertiesBody.md)|  | [optional] 

### Return type

[**AgentSystemResult**](AgentSystemResult.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Device properties updated. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_set_file_attributes_agent**
> v3_set_file_attributes_agent(instance_id, file_path, agent_file_attributes_body=agent_file_attributes_body)

Change attributes of a file on VM

Changes a file on the device: move or rename it (`path`), change its permissions (`mode`), or change its owner. Send only what you want to change.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_file_attributes_body import AgentFileAttributesBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    file_path = '/var/tmp/agent.log' # str | Path to the file on the VM filesystem.
    agent_file_attributes_body = corellium.AgentFileAttributesBody() # AgentFileAttributesBody |  (optional)

    try:
        # Change attributes of a file on VM
        api_instance.v3_set_file_attributes_agent(instance_id, file_path, agent_file_attributes_body=agent_file_attributes_body)
    except Exception as e:
        print("Exception when calling AgentApi->v3_set_file_attributes_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **file_path** | **str**| Path to the file on the VM filesystem. | 
 **agent_file_attributes_body** | [**AgentFileAttributesBody**](AgentFileAttributesBody.md)|  | [optional] 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | File attributes updated successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_set_hostname_agent**
> AgentSystemResult v3_set_hostname_agent(instance_id, agent_system_set_hostname_body)

Set instance hostname

Set the hostname of the instance.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_system_result import AgentSystemResult
from corellium.models.agent_system_set_hostname_body import AgentSystemSetHostnameBody
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    agent_system_set_hostname_body = corellium.AgentSystemSetHostnameBody() # AgentSystemSetHostnameBody | 

    try:
        # Set instance hostname
        api_response = api_instance.v3_set_hostname_agent(instance_id, agent_system_set_hostname_body)
        print("The response of AgentApi->v3_set_hostname_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_set_hostname_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **agent_system_set_hostname_body** | [**AgentSystemSetHostnameBody**](AgentSystemSetHostnameBody.md)|  | 

### Return type

[**AgentSystemResult**](AgentSystemResult.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Hostname set successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_shutdown_agent**
> v3_shutdown_agent(instance_id)

Shut down instance

Shut down the instance.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Shut down instance
        api_instance.v3_shutdown_agent(instance_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_shutdown_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Shutdown initiated successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_start_container_agent**
> v3_start_container_agent(instance_id, container_id)

Start a container

Start a nested container on the VM (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).

    try:
        # Start a container
        api_instance.v3_start_container_agent(instance_id, container_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_start_container_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Container started. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_start_container_app_agent**
> v3_start_container_app_agent(instance_id, container_id, package_name, activity_name)

Start an app in a container

Start an Android application in a nested container (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).
    package_name = 'com.corellium.cafe' # str | Android package name of the application.
    activity_name = 'com.corellium.cafe.MainActivity' # str | Android activity name to launch.

    try:
        # Start an app in a container
        api_instance.v3_start_container_app_agent(instance_id, container_id, package_name, activity_name)
    except Exception as e:
        print("Exception when calling AgentApi->v3_start_container_app_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 
 **package_name** | **str**| Android package name of the application. | 
 **activity_name** | **str**| Android activity name to launch. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Application started. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_start_container_app_monitored_agent**
> v3_start_container_app_monitored_agent(instance_id, container_id, package_name, activity_name)

Start and monitor an app in a container

Start an Android application in a nested container and monitor it (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).
    package_name = 'com.corellium.cafe' # str | Android package name of the application.
    activity_name = 'com.corellium.cafe.MainActivity' # str | Android activity name to launch.

    try:
        # Start and monitor an app in a container
        api_instance.v3_start_container_app_monitored_agent(instance_id, container_id, package_name, activity_name)
    except Exception as e:
        print("Exception when calling AgentApi->v3_start_container_app_monitored_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 
 **package_name** | **str**| Android package name of the application. | 
 **activity_name** | **str**| Android activity name to launch. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Application started and monitored. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_stop_container_agent**
> v3_stop_container_agent(instance_id, container_id)

Stop a container

Stop a nested container on the VM (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).

    try:
        # Stop a container
        api_instance.v3_stop_container_agent(instance_id, container_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_stop_container_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Container stopped. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_stop_container_app_agent**
> v3_stop_container_app_agent(instance_id, container_id)

Stop a monitored app in a container

Stop the monitored Android application in a nested container, if one is monitored (Android only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    container_id = '1' # str | Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1).

    try:
        # Stop a monitored app in a container
        api_instance.v3_stop_container_app_agent(instance_id, container_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_stop_container_app_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **container_id** | **str**| Container identifier (the numeric suffix of the container name, e.g. \"1\" for container1). | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Application stopped. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_uninstall_app_agent**
> v3_uninstall_app_agent(instance_id, bundle_id)

Uninstall an app

Removes an app from the device, identified by its bundle ID.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    bundle_id = 'com.corellium.cafe' # str | App bundle ID.

    try:
        # Uninstall an app
        api_instance.v3_uninstall_app_agent(instance_id, bundle_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_uninstall_app_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **bundle_id** | **str**| App bundle ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | App uninstalled successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_uninstall_profile_agent**
> v3_uninstall_profile_agent(instance_id, profile_id)

Uninstall a profile

Uninstall a configuration profile from the VM.

Deletes are idempotent: an unknown `instanceId`, or a profile that is not installed, is a successful no-op that still returns 204, and
repeated calls return 204 as well. A 404 means the request path did not match a delete route, not
that the target was missing.
Other agent-reported failures, and an unreachable agent, are still reported as failures.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    profile_id = 'com.apple.wifi.managed' # str | The profile identifier.

    try:
        # Uninstall a profile
        api_instance.v3_uninstall_profile_agent(instance_id, profile_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_uninstall_profile_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **profile_id** | **str**| The profile identifier. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Profile uninstalled successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_uninstall_remote_it_agent**
> AgentRemoteItStatus v3_uninstall_remote_it_agent(instance_id)

Uninstall Remote.It

Uninstall the Remote.It package from the VM (RPi only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import corellium
from corellium.models.agent_remote_it_status import AgentRemoteItStatus
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Uninstall Remote.It
        api_response = api_instance.v3_uninstall_remote_it_agent(instance_id)
        print("The response of AgentApi->v3_uninstall_remote_it_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->v3_uninstall_remote_it_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

[**AgentRemoteItStatus**](AgentRemoteItStatus.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Remote.It status after uninstall. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |
**404** | The resource does not exist, or you cannot see it. |  -  |
**405** | Method not allowed. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_unlock_agent**
> v3_unlock_agent(instance_id)

Unlock device

Unlock the device (iOS only).

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Unlock device
        api_instance.v3_unlock_agent(instance_id)
    except Exception as e:
        print("Exception when calling AgentApi->v3_unlock_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Device unlocked successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_upload_file_agent**
> v3_upload_file_agent(instance_id, file_path, body)

Upload a file to VM

Writes a file onto the device's filesystem at the given full path, replacing any file already there. Send the raw file bytes as the body. Use `v3GetTempFileAgent` first if you just need somewhere to put a file, for example an app package to install.

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
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.AgentApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.
    file_path = '/var/tmp/agent.log' # str | Path to the file on the VM filesystem.
    body = None # bytearray | 

    try:
        # Upload a file to VM
        api_instance.v3_upload_file_agent(instance_id, file_path, body)
    except Exception as e:
        print("Exception when calling AgentApi->v3_upload_file_agent: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance_id** | **str**| Instance ID. | 
 **file_path** | **str**| Path to the file on the VM filesystem. | 
 **body** | **bytearray**|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

 - **Content-Type**: application/octet-stream
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | File uploaded successfully. |  -  |
**400** | Agent error. |  -  |
**401** | Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry. |  -  |
**403** | Signed in, but not allowed to do this: you lack the required role, have no access to the project, or your license does not include the feature. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)