{"id":19713348,"url":"https://github.com/corellium/python-api-client","last_synced_at":"2025-06-21T11:06:05.409Z","repository":{"id":97921547,"uuid":"494208159","full_name":"corellium/python-api-client","owner":"corellium","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-07T00:44:30.000Z","size":536,"stargazers_count":13,"open_issues_count":2,"forks_count":0,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-07T01:35:02.893Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/corellium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-19T19:44:21.000Z","updated_at":"2025-05-07T00:44:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"0b9c6972-9969-4bf3-9c57-88c63758f1f5","html_url":"https://github.com/corellium/python-api-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/corellium/python-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corellium%2Fpython-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corellium%2Fpython-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corellium%2Fpython-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corellium%2Fpython-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/corellium","download_url":"https://codeload.github.com/corellium/python-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corellium%2Fpython-api-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261110603,"owners_count":23111063,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T22:21:12.010Z","updated_at":"2025-06-21T11:06:00.393Z","avatar_url":"https://github.com/corellium.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# corellium-api\nREST API to manage your virtual devices.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 7.3.0\n- Package version: 0.4.0\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport corellium_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport corellium_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport asyncio\nimport corellium_api\nfrom corellium_api.rest import ApiException\nfrom pprint import pprint\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (ApiToken or JWT): BearerAuth\nconfiguration = corellium_api.Configuration(\n    host = \"https://app.corellium.com/api\"\n)\nconfiguration.access_token = 'YOUR_ACCESS_TOKEN'\n\n\nasync def main():\n    # Enter a context with an instance of the API client\n    async with corellium_api.ApiClient(configuration) as api_client:\n        # Create an instance of the API class\n        api_instance = corellium_api.CorelliumApi(api_client)\n        instance_id = 'instance_id_example' # str | ID of instance\ncreate_assessment_dto = corellium_api.CreateAssessmentDto() # CreateAssessmentDto | Create a new assessment\n\n        try:\n            # Create assessment\n            api_response = await api_instance.create_assessment(instance_id, create_assessment_dto)\n            pprint(api_response)\n        except ApiException as e:\n            print(\"Exception when calling CorelliumApi-\u003ecreate_assessment: %s\\n\" % e)\n        \n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.corellium.com/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CorelliumApi* | [**create_assessment**](docs/CorelliumApi.md#create_assessment) | **POST** /v1/services/matrix/{instanceId}/assessments | Create assessment\n*CorelliumApi* | [**delete_assessment**](docs/CorelliumApi.md#delete_assessment) | **DELETE** /v1/services/matrix/{instanceId}/assessments/{assessmentId} | Delete assessment\n*CorelliumApi* | [**download_report**](docs/CorelliumApi.md#download_report) | **GET** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/download | Download report\n*CorelliumApi* | [**get_assessment_by_id**](docs/CorelliumApi.md#get_assessment_by_id) | **GET** /v1/services/matrix/{instanceId}/assessments/{assessmentId} | Get assessment by ID\n*CorelliumApi* | [**get_assessments_by_instance_id**](docs/CorelliumApi.md#get_assessments_by_instance_id) | **GET** /v1/services/matrix/{instanceId}/instances/{instanceId}/assessments | Get assessments by instanceId\n*CorelliumApi* | [**run_tests**](docs/CorelliumApi.md#run_tests) | **POST** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/test | Update assessment state and execute MATRIX tests\n*CorelliumApi* | [**start_monitoring**](docs/CorelliumApi.md#start_monitoring) | **POST** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/start | Update assessment state and begin device monitoring\n*CorelliumApi* | [**stop_monitoring**](docs/CorelliumApi.md#stop_monitoring) | **POST** /v1/services/matrix/{instanceId}/assessments/{assessmentId}/stop | Update assessment state and stop device monitoring\n*CorelliumApi* | [**v1_accept_shared_snapshot**](docs/CorelliumApi.md#v1_accept_shared_snapshot) | **POST** /v1/snapshots/accept | Accept a snapshot shared with you\n*CorelliumApi* | [**v1_activity_export**](docs/CorelliumApi.md#v1_activity_export) | **POST** /v1/activity/export | Start activity export\n*CorelliumApi* | [**v1_activity_list**](docs/CorelliumApi.md#v1_activity_list) | **GET** /v1/activity | Get resource activities\n*CorelliumApi* | [**v1_add_project_key**](docs/CorelliumApi.md#v1_add_project_key) | **POST** /v1/projects/{projectId}/keys | Add Project Authorized Key\n*CorelliumApi* | [**v1_add_team_role_to_project**](docs/CorelliumApi.md#v1_add_team_role_to_project) | **PUT** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Add team role to project\n*CorelliumApi* | [**v1_add_user_role_to_project**](docs/CorelliumApi.md#v1_add_user_role_to_project) | **PUT** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Add user role to project\n*CorelliumApi* | [**v1_add_user_to_team**](docs/CorelliumApi.md#v1_add_user_to_team) | **PUT** /v1/teams/{teamId}/users/{userId} | Add user to team\n*CorelliumApi* | [**v1_agent_app_ready**](docs/CorelliumApi.md#v1_agent_app_ready) | **GET** /v1/instances/{instanceId}/agent/v1/app/ready | Check if App subsystem is ready\n*CorelliumApi* | [**v1_agent_delete_file**](docs/CorelliumApi.md#v1_agent_delete_file) | **DELETE** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Delete a File on VM\n*CorelliumApi* | [**v1_agent_get_file**](docs/CorelliumApi.md#v1_agent_get_file) | **GET** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Download a File from VM\n*CorelliumApi* | [**v1_agent_get_temp_filename**](docs/CorelliumApi.md#v1_agent_get_temp_filename) | **POST** /v1/instances/{instanceId}/agent/v1/file/temp | Get the path for a new temp file\n*CorelliumApi* | [**v1_agent_install_app**](docs/CorelliumApi.md#v1_agent_install_app) | **POST** /v1/instances/{instanceId}/agent/v1/app/install | Install App at path\n*CorelliumApi* | [**v1_agent_install_profile**](docs/CorelliumApi.md#v1_agent_install_profile) | **POST** /v1/instances/{instanceId}/agent/v1/profile/install | Install a Profile to VM\n*CorelliumApi* | [**v1_agent_kill_app**](docs/CorelliumApi.md#v1_agent_kill_app) | **POST** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/kill | Kill an App\n*CorelliumApi* | [**v1_agent_list_app_icons**](docs/CorelliumApi.md#v1_agent_list_app_icons) | **GET** /v1/instances/{instanceId}/agent/v1/app/icons | List App Icons\n*CorelliumApi* | [**v1_agent_list_apps**](docs/CorelliumApi.md#v1_agent_list_apps) | **GET** /v1/instances/{instanceId}/agent/v1/app/apps | List Apps\n*CorelliumApi* | [**v1_agent_list_apps_status**](docs/CorelliumApi.md#v1_agent_list_apps_status) | **GET** /v1/instances/{instanceId}/agent/v1/app/apps/update | List Apps Status\n*CorelliumApi* | [**v1_agent_list_profiles**](docs/CorelliumApi.md#v1_agent_list_profiles) | **GET** /v1/instances/{instanceId}/agent/v1/profile/profiles | List Profiles\n*CorelliumApi* | [**v1_agent_run_app**](docs/CorelliumApi.md#v1_agent_run_app) | **POST** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/run | Run an App\n*CorelliumApi* | [**v1_agent_set_file_attributes**](docs/CorelliumApi.md#v1_agent_set_file_attributes) | **PATCH** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Change Attrs of a File on VM\n*CorelliumApi* | [**v1_agent_system_get_adb_auth**](docs/CorelliumApi.md#v1_agent_system_get_adb_auth) | **GET** /v1/instances/{instanceId}/agent/v1/system/adbauth | Get ADB Auth Setting (AOSP only)\n*CorelliumApi* | [**v1_agent_system_get_network**](docs/CorelliumApi.md#v1_agent_system_get_network) | **GET** /v1/instances/{instanceId}/agent/v1/system/network | Get IP of eth0 (AOSP only)\n*CorelliumApi* | [**v1_agent_system_get_prop**](docs/CorelliumApi.md#v1_agent_system_get_prop) | **POST** /v1/instances/{instanceId}/agent/v1/system/getprop | Get System Property (AOSP only)\n*CorelliumApi* | [**v1_agent_system_install_open_g_apps**](docs/CorelliumApi.md#v1_agent_system_install_open_g_apps) | **POST** /v1/instances/{instanceId}/agent/v1/system/install-opengapps | Install OpenGApps (AOSP only)\n*CorelliumApi* | [**v1_agent_system_lock**](docs/CorelliumApi.md#v1_agent_system_lock) | **POST** /v1/instances/{instanceId}/agent/v1/system/lock | Lock Device (iOS Only)\n*CorelliumApi* | [**v1_agent_system_set_adb_auth**](docs/CorelliumApi.md#v1_agent_system_set_adb_auth) | **PUT** /v1/instances/{instanceId}/agent/v1/system/adbauth | Set ADB Auth Setting (AOSP only)\n*CorelliumApi* | [**v1_agent_system_set_hostname**](docs/CorelliumApi.md#v1_agent_system_set_hostname) | **POST** /v1/instances/{instanceId}/agent/v1/system/setHostname | Set Hostname of instance\n*CorelliumApi* | [**v1_agent_system_shutdown**](docs/CorelliumApi.md#v1_agent_system_shutdown) | **POST** /v1/instances/{instanceId}/agent/v1/system/shutdown | Instruct VM to halt\n*CorelliumApi* | [**v1_agent_system_unlock**](docs/CorelliumApi.md#v1_agent_system_unlock) | **POST** /v1/instances/{instanceId}/agent/v1/system/unlock | Unlock Device (iOS Only)\n*CorelliumApi* | [**v1_agent_uninstall_app**](docs/CorelliumApi.md#v1_agent_uninstall_app) | **POST** /v1/instances/{instanceId}/agent/v1/app/apps/{bundleId}/uninstall | Uninstall an App\n*CorelliumApi* | [**v1_agent_uninstall_profile**](docs/CorelliumApi.md#v1_agent_uninstall_profile) | **DELETE** /v1/instances/{instanceId}/agent/v1/profile/profiles/{profileId} | Uninstall a Profile from VM\n*CorelliumApi* | [**v1_agent_upload_file**](docs/CorelliumApi.md#v1_agent_upload_file) | **PUT** /v1/instances/{instanceId}/agent/v1/file/device/{filePath} | Upload a file to VM\n*CorelliumApi* | [**v1_auth_login**](docs/CorelliumApi.md#v1_auth_login) | **POST** /v1/auth/login | Log In\n*CorelliumApi* | [**v1_btrace_preauthorize**](docs/CorelliumApi.md#v1_btrace_preauthorize) | **GET** /v1/instances/{instanceId}/btrace-authorize | Pre-authorize an btrace download\n*CorelliumApi* | [**v1_check_subdomain_existence**](docs/CorelliumApi.md#v1_check_subdomain_existence) | **POST** /v1/domain/check | Check the existence of a subdomain\n*CorelliumApi* | [**v1_clear_core_trace**](docs/CorelliumApi.md#v1_clear_core_trace) | **DELETE** /v1/instances/{instanceId}/strace | Clear CoreTrace logs\n*CorelliumApi* | [**v1_clear_hyper_trace**](docs/CorelliumApi.md#v1_clear_hyper_trace) | **DELETE** /v1/instances/{instanceId}/btrace | Clear HyperTrace logs\n*CorelliumApi* | [**v1_clear_hyper_trace_hooks**](docs/CorelliumApi.md#v1_clear_hyper_trace_hooks) | **POST** /v1/instances/{instanceId}/hooks/clear | Clear Hooks on an instance\n*CorelliumApi* | [**v1_clear_instance_panics**](docs/CorelliumApi.md#v1_clear_instance_panics) | **DELETE** /v1/instances/{instanceId}/panics | Clear Panics\n*CorelliumApi* | [**v1_create_domain_auth_provider**](docs/CorelliumApi.md#v1_create_domain_auth_provider) | **POST** /v1/domain/{domainId}/auth | Create a new auth provider for a domain\n*CorelliumApi* | [**v1_create_hook**](docs/CorelliumApi.md#v1_create_hook) | **POST** /v1/instances/{instanceId}/hooks | Create hypervisor hook for Instance\n*CorelliumApi* | [**v1_create_image**](docs/CorelliumApi.md#v1_create_image) | **POST** /v1/images | Create a new Image\n*CorelliumApi* | [**v1_create_instance**](docs/CorelliumApi.md#v1_create_instance) | **POST** /v1/instances | Create Instance\n*CorelliumApi* | [**v1_create_network_connection**](docs/CorelliumApi.md#v1_create_network_connection) | **POST** /v1/network/connections | Create a new Network Connection\n*CorelliumApi* | [**v1_create_project**](docs/CorelliumApi.md#v1_create_project) | **POST** /v1/projects | Create a Project\n*CorelliumApi* | [**v1_create_snapshot**](docs/CorelliumApi.md#v1_create_snapshot) | **POST** /v1/instances/{instanceId}/snapshots | Create Instance Snapshot\n*CorelliumApi* | [**v1_create_user**](docs/CorelliumApi.md#v1_create_user) | **POST** /v1/users | Create User\n*CorelliumApi* | [**v1_delete_domain_auth_provider**](docs/CorelliumApi.md#v1_delete_domain_auth_provider) | **DELETE** /v1/domain/{domainId}/auth/{providerId} | Delete an auth provider from a domain\n*CorelliumApi* | [**v1_delete_hook**](docs/CorelliumApi.md#v1_delete_hook) | **DELETE** /v1/hooks/{hookId} | Delete an existing hypervisor hook\n*CorelliumApi* | [**v1_delete_image**](docs/CorelliumApi.md#v1_delete_image) | **DELETE** /v2/images/{imageId} | Delete Image\n*CorelliumApi* | [**v1_delete_instance**](docs/CorelliumApi.md#v1_delete_instance) | **DELETE** /v1/instances/{instanceId} | Remove Instance\n*CorelliumApi* | [**v1_delete_instance_snapshot**](docs/CorelliumApi.md#v1_delete_instance_snapshot) | **DELETE** /v1/instances/{instanceId}/snapshots/{snapshotId} | Delete an Instance Snapshot\n*CorelliumApi* | [**v1_delete_network_connection**](docs/CorelliumApi.md#v1_delete_network_connection) | **DELETE** /v1/network/connections/{id} | Delete an existing Network Connection\n*CorelliumApi* | [**v1_delete_project**](docs/CorelliumApi.md#v1_delete_project) | **DELETE** /v1/projects/{projectId} | Delete a Project\n*CorelliumApi* | [**v1_delete_snapshot**](docs/CorelliumApi.md#v1_delete_snapshot) | **DELETE** /v1/snapshots/{snapshotId} | Delete a Snapshot\n*CorelliumApi* | [**v1_delete_snapshot_permissions**](docs/CorelliumApi.md#v1_delete_snapshot_permissions) | **DELETE** /v1/snapshots/{snapshotId}/permissions | Delete member(s)\n*CorelliumApi* | [**v1_delete_user**](docs/CorelliumApi.md#v1_delete_user) | **DELETE** /v1/users/{userId} | Delete User\n*CorelliumApi* | [**v1_disable_expose_port**](docs/CorelliumApi.md#v1_disable_expose_port) | **POST** /v1/instances/{instanceId}/exposeport/disable | Disable an exposed port on an instance for device access.\n*CorelliumApi* | [**v1_download_activity**](docs/CorelliumApi.md#v1_download_activity) | **GET** /v1/activity/export/{taskId}/download | Download activity\n*CorelliumApi* | [**v1_enable_expose_port**](docs/CorelliumApi.md#v1_enable_expose_port) | **POST** /v1/instances/{instanceId}/exposeport/enable | Enable an exposed port on an instance for device access.\n*CorelliumApi* | [**v1_execute_hyper_trace_hooks**](docs/CorelliumApi.md#v1_execute_hyper_trace_hooks) | **POST** /v1/instances/{instanceId}/hooks/execute | Execute Hooks on an instance\n*CorelliumApi* | [**v1_get_activity_export_status**](docs/CorelliumApi.md#v1_get_activity_export_status) | **GET** /v1/activity/export/{taskId} | Get export task status\n*CorelliumApi* | [**v1_get_activity_export_tasks**](docs/CorelliumApi.md#v1_get_activity_export_tasks) | **GET** /v1/activity/export | Get all export tasks for user\n*CorelliumApi* | [**v1_get_config**](docs/CorelliumApi.md#v1_get_config) | **GET** /v1/config | Get all configs\n*CorelliumApi* | [**v1_get_domain_auth_providers**](docs/CorelliumApi.md#v1_get_domain_auth_providers) | **GET** /v1/domain/{domainId}/auth | Return all configured auth providers for a domain (including globally configured providers)\n*CorelliumApi* | [**v1_get_hook_by_id**](docs/CorelliumApi.md#v1_get_hook_by_id) | **GET** /v1/hooks/{hookId} | Get hypervisor hook by id\n*CorelliumApi* | [**v1_get_hooks**](docs/CorelliumApi.md#v1_get_hooks) | **GET** /v1/instances/{instanceId}/hooks | Get all hypervisor hooks for Instance\n*CorelliumApi* | [**v1_get_image**](docs/CorelliumApi.md#v1_get_image) | **GET** /v1/images/{imageId} | Get Image Metadata\n*CorelliumApi* | [**v1_get_images**](docs/CorelliumApi.md#v1_get_images) | **GET** /v1/images | Get all Images Metadata\n*CorelliumApi* | [**v1_get_instance**](docs/CorelliumApi.md#v1_get_instance) | **GET** /v1/instances/{instanceId} | Get Instance\n*CorelliumApi* | [**v1_get_instance_console**](docs/CorelliumApi.md#v1_get_instance_console) | **GET** /v1/instances/{instanceId}/console | Get console websocket URL\n*CorelliumApi* | [**v1_get_instance_console_log**](docs/CorelliumApi.md#v1_get_instance_console_log) | **GET** /v1/instances/{instanceId}/consoleLog | Get Console Log\n*CorelliumApi* | [**v1_get_instance_gpios**](docs/CorelliumApi.md#v1_get_instance_gpios) | **GET** /v1/instances/{instanceId}/gpios | Get Instance GPIOs\n*CorelliumApi* | [**v1_get_instance_panics**](docs/CorelliumApi.md#v1_get_instance_panics) | **GET** /v1/instances/{instanceId}/panics | Get Panics\n*CorelliumApi* | [**v1_get_instance_peripherals**](docs/CorelliumApi.md#v1_get_instance_peripherals) | **GET** /v1/instances/{instanceId}/peripherals | Get Instance Peripherals\n*CorelliumApi* | [**v1_get_instance_screenshot**](docs/CorelliumApi.md#v1_get_instance_screenshot) | **GET** /v1/instances/{instanceId}/screenshot.{format} | Get Instance Screenshot\n*CorelliumApi* | [**v1_get_instance_snapshot**](docs/CorelliumApi.md#v1_get_instance_snapshot) | **GET** /v1/instances/{instanceId}/snapshots/{snapshotId} | Get Instance Snapshot\n*CorelliumApi* | [**v1_get_instance_snapshots**](docs/CorelliumApi.md#v1_get_instance_snapshots) | **GET** /v1/instances/{instanceId}/snapshots | Get Instance Snapshots\n*CorelliumApi* | [**v1_get_instances**](docs/CorelliumApi.md#v1_get_instances) | **GET** /v1/instances | Get Instances\n*CorelliumApi* | [**v1_get_model_software**](docs/CorelliumApi.md#v1_get_model_software) | **GET** /v1/models/{model}/software | Get Software for Model\n*CorelliumApi* | [**v1_get_models**](docs/CorelliumApi.md#v1_get_models) | **GET** /v1/models | Get Supported Models\n*CorelliumApi* | [**v1_get_network_connection**](docs/CorelliumApi.md#v1_get_network_connection) | **GET** /v1/network/connections/{id} | Return the configuration and per project statuses for a single network provider.\n*CorelliumApi* | [**v1_get_project**](docs/CorelliumApi.md#v1_get_project) | **GET** /v1/projects/{projectId} | Get a Project\n*CorelliumApi* | [**v1_get_project_instances**](docs/CorelliumApi.md#v1_get_project_instances) | **GET** /v1/projects/{projectId}/instances | Get Instances in Project\n*CorelliumApi* | [**v1_get_project_keys**](docs/CorelliumApi.md#v1_get_project_keys) | **GET** /v1/projects/{projectId}/keys | Get Project Authorized Keys\n*CorelliumApi* | [**v1_get_project_network_log**](docs/CorelliumApi.md#v1_get_project_network_log) | **GET** /v1/projects/{projectId}/network/log | Retrieve the network connection log for a project\n*CorelliumApi* | [**v1_get_project_network_status**](docs/CorelliumApi.md#v1_get_project_network_status) | **GET** /v1/projects/{projectId}/network/status | Retrieve the network connection status for a project\n*CorelliumApi* | [**v1_get_project_vpn_config**](docs/CorelliumApi.md#v1_get_project_vpn_config) | **GET** /v1/projects/{projectId}/vpnconfig/{format} | Get Project VPN Configuration\n*CorelliumApi* | [**v1_get_projects**](docs/CorelliumApi.md#v1_get_projects) | **GET** /v1/projects | Get Projects\n*CorelliumApi* | [**v1_get_reset_link_info**](docs/CorelliumApi.md#v1_get_reset_link_info) | **GET** /v1/users/reset-link-info | Send Password Reset Link Info\n*CorelliumApi* | [**v1_get_service_provider_metadata**](docs/CorelliumApi.md#v1_get_service_provider_metadata) | **GET** /v1/auth/providers/:providerId/spmetadata | Get service provider metadata xml from an auth provider\n*CorelliumApi* | [**v1_get_shared_snapshots**](docs/CorelliumApi.md#v1_get_shared_snapshots) | **GET** /v1/snapshots/shared | Fetch shared snapshots\n*CorelliumApi* | [**v1_get_snapshot**](docs/CorelliumApi.md#v1_get_snapshot) | **GET** /v1/snapshots/{snapshotId} | Get Snapshot\n*CorelliumApi* | [**v1_instances_instance_id_message_post**](docs/CorelliumApi.md#v1_instances_instance_id_message_post) | **POST** /v1/instances/{instanceId}/message | Inject a message into an iOS VM\n*CorelliumApi* | [**v1_instances_instance_id_netdump_pcap_get**](docs/CorelliumApi.md#v1_instances_instance_id_netdump_pcap_get) | **GET** /v1/instances/{instanceId}/netdump.pcap | Download a netdump pcap file\n*CorelliumApi* | [**v1_instances_instance_id_network_monitor_pcap_get**](docs/CorelliumApi.md#v1_instances_instance_id_network_monitor_pcap_get) | **GET** /v1/instances/{instanceId}/networkMonitor.pcap | Download a Network Monitor pcap file\n*CorelliumApi* | [**v1_kcrange**](docs/CorelliumApi.md#v1_kcrange) | **GET** /v1/instances/{instanceId}/btrace-kcrange | Get Kernel extension ranges\n*CorelliumApi* | [**v1_list_network_connections**](docs/CorelliumApi.md#v1_list_network_connections) | **GET** /v1/network/connections | List available network connections\n*CorelliumApi* | [**v1_list_network_interfaces**](docs/CorelliumApi.md#v1_list_network_interfaces) | **GET** /v1/network/interfaces | List available physical network interfaces\n*CorelliumApi* | [**v1_list_network_providers**](docs/CorelliumApi.md#v1_list_network_providers) | **GET** /v1/network/providers | List available network providers\n*CorelliumApi* | [**v1_list_threads**](docs/CorelliumApi.md#v1_list_threads) | **GET** /v1/instances/{instanceId}/strace/thread-list | Get Running Threads (CoreTrace)\n*CorelliumApi* | [**v1_media_play**](docs/CorelliumApi.md#v1_media_play) | **POST** /v1/instances/{instanceId}/media/play | Start playing media\n*CorelliumApi* | [**v1_media_stop**](docs/CorelliumApi.md#v1_media_stop) | **POST** /v1/instances/{instanceId}/media/stop | Stop playing media\n*CorelliumApi* | [**v1_partial_update_network_connection**](docs/CorelliumApi.md#v1_partial_update_network_connection) | **PATCH** /v1/network/connections/{id} | Update Network Connection (partial)\n*CorelliumApi* | [**v1_patch_instance**](docs/CorelliumApi.md#v1_patch_instance) | **PATCH** /v1/instances/{instanceId} | Update Instance\n*CorelliumApi* | [**v1_pause_instance**](docs/CorelliumApi.md#v1_pause_instance) | **POST** /v1/instances/{instanceId}/pause | Pause an Instance\n*CorelliumApi* | [**v1_post_instance_input**](docs/CorelliumApi.md#v1_post_instance_input) | **POST** /v1/instances/{instanceId}/input | Provide Instance Input\n*CorelliumApi* | [**v1_ready**](docs/CorelliumApi.md#v1_ready) | **GET** /v1/ready | API Status\n*CorelliumApi* | [**v1_reboot_instance**](docs/CorelliumApi.md#v1_reboot_instance) | **POST** /v1/instances/{instanceId}/reboot | Reboot an Instance\n*CorelliumApi* | [**v1_remove_project_key**](docs/CorelliumApi.md#v1_remove_project_key) | **DELETE** /v1/projects/{projectId}/keys/{keyId} | Delete Project Authorized Key\n*CorelliumApi* | [**v1_remove_team_role_from_project**](docs/CorelliumApi.md#v1_remove_team_role_from_project) | **DELETE** /v1/roles/projects/{projectId}/teams/{teamId}/roles/{roleId} | Remove team role from project\n*CorelliumApi* | [**v1_remove_user_from_team**](docs/CorelliumApi.md#v1_remove_user_from_team) | **DELETE** /v1/teams/{teamId}/users/{userId} | Remove user from team\n*CorelliumApi* | [**v1_remove_user_role_from_project**](docs/CorelliumApi.md#v1_remove_user_role_from_project) | **DELETE** /v1/roles/projects/{projectId}/users/{userId}/roles/{roleId} | Remove user role from project\n*CorelliumApi* | [**v1_rename_instance_snapshot**](docs/CorelliumApi.md#v1_rename_instance_snapshot) | **PATCH** /v1/instances/{instanceId}/snapshots/{snapshotId} | Rename an Instance Snapshot\n*CorelliumApi* | [**v1_reset_user_password**](docs/CorelliumApi.md#v1_reset_user_password) | **POST** /v1/users/reset-password | Reset User Password\n*CorelliumApi* | [**v1_restore_backup**](docs/CorelliumApi.md#v1_restore_backup) | **POST** /v1/instances/{instanceId}/restoreBackup | Restore backup\n*CorelliumApi* | [**v1_restore_instance_snapshot**](docs/CorelliumApi.md#v1_restore_instance_snapshot) | **POST** /v1/instances/{instanceId}/snapshots/{snapshotId}/restore | Restore an Instance Snapshot\n*CorelliumApi* | [**v1_roles**](docs/CorelliumApi.md#v1_roles) | **GET** /v1/roles | Get all roles\n*CorelliumApi* | [**v1_rotate_instance**](docs/CorelliumApi.md#v1_rotate_instance) | **POST** /v1/instances/{instanceId}/rotate | Rotate device to specified orientation\n*CorelliumApi* | [**v1_send_user_reset_link**](docs/CorelliumApi.md#v1_send_user_reset_link) | **POST** /v1/users/send-reset-link | Send Password Reset Link\n*CorelliumApi* | [**v1_set_instance_gpios**](docs/CorelliumApi.md#v1_set_instance_gpios) | **PUT** /v1/instances/{instanceId}/gpios | Set Instance GPIOs\n*CorelliumApi* | [**v1_set_instance_peripherals**](docs/CorelliumApi.md#v1_set_instance_peripherals) | **PUT** /v1/instances/{instanceId}/peripherals | Set Instance Peripherals\n*CorelliumApi* | [**v1_set_instance_state**](docs/CorelliumApi.md#v1_set_instance_state) | **PUT** /v1/instances/{instanceId}/state | Set state of Instance\n*CorelliumApi* | [**v1_set_snapshot_permissions**](docs/CorelliumApi.md#v1_set_snapshot_permissions) | **POST** /v1/snapshots/{snapshotId}/permissions | Set member list\n*CorelliumApi* | [**v1_share_snapshot**](docs/CorelliumApi.md#v1_share_snapshot) | **POST** /v1/snapshots/{snapshotId}/share | Share snapshot\n*CorelliumApi* | [**v1_snapshot_rename**](docs/CorelliumApi.md#v1_snapshot_rename) | **PATCH** /v1/snapshots/{snapshotId} | Rename a Snapshot\n*CorelliumApi* | [**v1_start_core_trace**](docs/CorelliumApi.md#v1_start_core_trace) | **POST** /v1/instances/{instanceId}/strace/enable | Start CoreTrace on an instance\n*CorelliumApi* | [**v1_start_hyper_trace**](docs/CorelliumApi.md#v1_start_hyper_trace) | **POST** /v1/instances/{instanceId}/btrace/enable | Start HyperTrace on an instance\n*CorelliumApi* | [**v1_start_instance**](docs/CorelliumApi.md#v1_start_instance) | **POST** /v1/instances/{instanceId}/start | Start an Instance\n*CorelliumApi* | [**v1_start_netdump**](docs/CorelliumApi.md#v1_start_netdump) | **POST** /v1/instances/{instanceId}/netdump/enable | Start Enhanced Network Monitor on an instance.\n*CorelliumApi* | [**v1_start_network_monitor**](docs/CorelliumApi.md#v1_start_network_monitor) | **POST** /v1/instances/{instanceId}/sslsplit/enable | Start Network Monitor on an instance.\n*CorelliumApi* | [**v1_stop_core_trace**](docs/CorelliumApi.md#v1_stop_core_trace) | **POST** /v1/instances/{instanceId}/strace/disable | Stop CoreTrace on an instance.\n*CorelliumApi* | [**v1_stop_hyper_trace**](docs/CorelliumApi.md#v1_stop_hyper_trace) | **POST** /v1/instances/{instanceId}/btrace/disable | Stop HyperTrace on an instance.\n*CorelliumApi* | [**v1_stop_instance**](docs/CorelliumApi.md#v1_stop_instance) | **POST** /v1/instances/{instanceId}/stop | Stop an Instance\n*CorelliumApi* | [**v1_stop_netdump**](docs/CorelliumApi.md#v1_stop_netdump) | **POST** /v1/instances/{instanceId}/netdump/disable | Stop Enhanced Network Monitor on an instance.\n*CorelliumApi* | [**v1_stop_network_monitor**](docs/CorelliumApi.md#v1_stop_network_monitor) | **POST** /v1/instances/{instanceId}/sslsplit/disable | Stop Network Monitor on an instance.\n*CorelliumApi* | [**v1_team_change**](docs/CorelliumApi.md#v1_team_change) | **PATCH** /v1/teams/{teamId} | Update team\n*CorelliumApi* | [**v1_team_create**](docs/CorelliumApi.md#v1_team_create) | **POST** /v1/teams | Create team\n*CorelliumApi* | [**v1_team_delete**](docs/CorelliumApi.md#v1_team_delete) | **DELETE** /v1/teams/{teamId} | Delete team\n*CorelliumApi* | [**v1_teams**](docs/CorelliumApi.md#v1_teams) | **GET** /v1/teams | Get teams\n*CorelliumApi* | [**v1_unpause_instance**](docs/CorelliumApi.md#v1_unpause_instance) | **POST** /v1/instances/{instanceId}/unpause | Unpause an Instance\n*CorelliumApi* | [**v1_update_domain_auth_provider**](docs/CorelliumApi.md#v1_update_domain_auth_provider) | **PUT** /v1/domain/{domainId}/auth/{providerId} | Update an auth provider for a domain\n*CorelliumApi* | [**v1_update_hook**](docs/CorelliumApi.md#v1_update_hook) | **PUT** /v1/hooks/{hookId} | Update an existing hypervisor hook\n*CorelliumApi* | [**v1_update_network_connection**](docs/CorelliumApi.md#v1_update_network_connection) | **PUT** /v1/network/connections/{id} | Update Network Connection\n*CorelliumApi* | [**v1_update_project**](docs/CorelliumApi.md#v1_update_project) | **PATCH** /v1/projects/{projectId} | Update a Project\n*CorelliumApi* | [**v1_update_project_settings**](docs/CorelliumApi.md#v1_update_project_settings) | **PATCH** /v1/projects/{projectId}/settings | Change Project Settings\n*CorelliumApi* | [**v1_update_user**](docs/CorelliumApi.md#v1_update_user) | **PATCH** /v1/users/{userId} | Update User\n*CorelliumApi* | [**v1_upgrade_instance**](docs/CorelliumApi.md#v1_upgrade_instance) | **POST** /v1/instances/{instanceId}/upgrade | Upgrade iOS version\n*CorelliumApi* | [**v1_upload_image_data**](docs/CorelliumApi.md#v1_upload_image_data) | **POST** /v1/images/{imageId} | Upload Image Data\n*CorelliumApi* | [**v1_user_agree_terms**](docs/CorelliumApi.md#v1_user_agree_terms) | **POST** /v1/users/agree | Consent to the current terms and conditions\n*CorelliumApi* | [**v1_users_change_password_post**](docs/CorelliumApi.md#v1_users_change_password_post) | **POST** /v1/users/change-password | Change User Password\n*CorelliumApi* | [**v1_users_login**](docs/CorelliumApi.md#v1_users_login) | **POST** /v1/users/login | Log In\n*CorelliumApi* | [**v1_web_player_allowed_domains**](docs/CorelliumApi.md#v1_web_player_allowed_domains) | **GET** /v1/webplayer/allowedDomains | Retrieve the list of allowed domains for all Webplayer sessions\n*CorelliumApi* | [**v1_web_player_create_session**](docs/CorelliumApi.md#v1_web_player_create_session) | **POST** /v1/webplayer | Create a new Webplayer Session\n*CorelliumApi* | [**v1_web_player_destroy_session**](docs/CorelliumApi.md#v1_web_player_destroy_session) | **DELETE** /v1/webplayer/{sessionId} | Tear down a Webplayer Session\n*CorelliumApi* | [**v1_web_player_list_sessions**](docs/CorelliumApi.md#v1_web_player_list_sessions) | **GET** /v1/webplayer | List all Webplayer sessions\n*CorelliumApi* | [**v1_web_player_session_info**](docs/CorelliumApi.md#v1_web_player_session_info) | **GET** /v1/webplayer/{sessionId} | Retrieve Webplayer Session Information\n*CorelliumApi* | [**v2_get_instance_quick_connect_command**](docs/CorelliumApi.md#v2_get_instance_quick_connect_command) | **GET** /v2/instances/{instanceId}/quickConnectCommand | Recommended SSH Command for Quick Connect\n*CorelliumApi* | [**v2_get_instance_state**](docs/CorelliumApi.md#v2_get_instance_state) | **GET** /v2/instances/{instanceId}/state | Get state of Instance\n\n\n## Documentation For Models\n\n - [Activity](docs/Activity.md)\n - [ActivityExportDto](docs/ActivityExportDto.md)\n - [ActivityExportResponse](docs/ActivityExportResponse.md)\n - [ActivityList](docs/ActivityList.md)\n - [ActivityRequest](docs/ActivityRequest.md)\n - [Address](docs/Address.md)\n - [AgentApp](docs/AgentApp.md)\n - [AgentAppReadyResponse](docs/AgentAppReadyResponse.md)\n - [AgentAppStatus](docs/AgentAppStatus.md)\n - [AgentAppsList](docs/AgentAppsList.md)\n - [AgentAppsStatusList](docs/AgentAppsStatusList.md)\n - [AgentError](docs/AgentError.md)\n - [AgentIcons](docs/AgentIcons.md)\n - [AgentInstallBody](docs/AgentInstallBody.md)\n - [AgentProfilesReturn](docs/AgentProfilesReturn.md)\n - [AgentSystemAdbAuth](docs/AgentSystemAdbAuth.md)\n - [AgentSystemGetPropBody](docs/AgentSystemGetPropBody.md)\n - [AgentSystemSetHostnameBody](docs/AgentSystemSetHostnameBody.md)\n - [AgentValueReturn](docs/AgentValueReturn.md)\n - [AgreedAck](docs/AgreedAck.md)\n - [ApiConflictError](docs/ApiConflictError.md)\n - [ApiError](docs/ApiError.md)\n - [ApiInternalConsistencyError](docs/ApiInternalConsistencyError.md)\n - [ApiNotFoundError](docs/ApiNotFoundError.md)\n - [ApiToken](docs/ApiToken.md)\n - [Assessment](docs/Assessment.md)\n - [AssessmentIdStatus](docs/AssessmentIdStatus.md)\n - [AuthProvider](docs/AuthProvider.md)\n - [Bit](docs/Bit.md)\n - [BtraceEnableOptions](docs/BtraceEnableOptions.md)\n - [Button](docs/Button.md)\n - [CheckSubdomainResponse](docs/CheckSubdomainResponse.md)\n - [ConfigResponse](docs/ConfigResponse.md)\n - [ConfigResponseMaintenance](docs/ConfigResponseMaintenance.md)\n - [CouponOptions](docs/CouponOptions.md)\n - [CreateAssessmentDto](docs/CreateAssessmentDto.md)\n - [CreateNetworkConnectionOptions](docs/CreateNetworkConnectionOptions.md)\n - [CreateTeam](docs/CreateTeam.md)\n - [CreatedBy](docs/CreatedBy.md)\n - [Credentials](docs/Credentials.md)\n - [DomainAuthProviderRequest](docs/DomainAuthProviderRequest.md)\n - [DomainAuthProviderResponse](docs/DomainAuthProviderResponse.md)\n - [DomainOptions](docs/DomainOptions.md)\n - [Extension](docs/Extension.md)\n - [Features](docs/Features.md)\n - [FileChanges](docs/FileChanges.md)\n - [Firmware](docs/Firmware.md)\n - [GetAssessmentsByInstanceId500Response](docs/GetAssessmentsByInstanceId500Response.md)\n - [GpioStateDefinition](docs/GpioStateDefinition.md)\n - [GpiosState](docs/GpiosState.md)\n - [GrantTrialRequestResponse](docs/GrantTrialRequestResponse.md)\n - [Hook](docs/Hook.md)\n - [Image](docs/Image.md)\n - [InputResponse](docs/InputResponse.md)\n - [Instance](docs/Instance.md)\n - [InstanceAgentState](docs/InstanceAgentState.md)\n - [InstanceBootOptions](docs/InstanceBootOptions.md)\n - [InstanceBootOptionsAdditionalTag](docs/InstanceBootOptionsAdditionalTag.md)\n - [InstanceConsoleEndpoint](docs/InstanceConsoleEndpoint.md)\n - [InstanceCreateOptions](docs/InstanceCreateOptions.md)\n - [InstanceInput](docs/InstanceInput.md)\n - [InstanceNetdumpState](docs/InstanceNetdumpState.md)\n - [InstanceNetmonState](docs/InstanceNetmonState.md)\n - [InstanceReturn](docs/InstanceReturn.md)\n - [InstanceServices](docs/InstanceServices.md)\n - [InstanceStartOptions](docs/InstanceStartOptions.md)\n - [InstanceState](docs/InstanceState.md)\n - [InstanceStopOptions](docs/InstanceStopOptions.md)\n - [InstanceUpgradeBody](docs/InstanceUpgradeBody.md)\n - [Invitation](docs/Invitation.md)\n - [InviteRevokeParams](docs/InviteRevokeParams.md)\n - [InviteRevokeParamsIds](docs/InviteRevokeParamsIds.md)\n - [Kcrange](docs/Kcrange.md)\n - [KernelTask](docs/KernelTask.md)\n - [KernelThread](docs/KernelThread.md)\n - [Logging](docs/Logging.md)\n - [Maintenance](docs/Maintenance.md)\n - [MediaPlayBody](docs/MediaPlayBody.md)\n - [MeteredSubscriptionUsage](docs/MeteredSubscriptionUsage.md)\n - [Model](docs/Model.md)\n - [ModelSoftware](docs/ModelSoftware.md)\n - [NetdumpFilter](docs/NetdumpFilter.md)\n - [NetworkConnection](docs/NetworkConnection.md)\n - [NetworkConnectionOffsetPaginationResult](docs/NetworkConnectionOffsetPaginationResult.md)\n - [NetworkConnectionProvider](docs/NetworkConnectionProvider.md)\n - [NetworkConnectionProviderOffsetPaginationResult](docs/NetworkConnectionProviderOffsetPaginationResult.md)\n - [NetworkStatusResponse](docs/NetworkStatusResponse.md)\n - [OpenIDConfig](docs/OpenIDConfig.md)\n - [Pagination](docs/Pagination.md)\n - [PasswordChangeBody](docs/PasswordChangeBody.md)\n - [PasswordResetBody](docs/PasswordResetBody.md)\n - [PatchInstanceOptions](docs/PatchInstanceOptions.md)\n - [PeripheralsData](docs/PeripheralsData.md)\n - [Plan](docs/Plan.md)\n - [PostShareSnapshotRequestPayload](docs/PostShareSnapshotRequestPayload.md)\n - [Project](docs/Project.md)\n - [ProjectKey](docs/ProjectKey.md)\n - [ProjectNetworkState](docs/ProjectNetworkState.md)\n - [ProjectQuota](docs/ProjectQuota.md)\n - [ProjectSettings](docs/ProjectSettings.md)\n - [ProjectUsage](docs/ProjectUsage.md)\n - [ProxyConfig](docs/ProxyConfig.md)\n - [ResetLinkBody](docs/ResetLinkBody.md)\n - [Role](docs/Role.md)\n - [RotateBody](docs/RotateBody.md)\n - [SharedSnapshotsInfo](docs/SharedSnapshotsInfo.md)\n - [Snapshot](docs/Snapshot.md)\n - [SnapshotCreationOptions](docs/SnapshotCreationOptions.md)\n - [SnapshotMember](docs/SnapshotMember.md)\n - [SnapshotOwner](docs/SnapshotOwner.md)\n - [SnapshotPermissionsRequestPayload](docs/SnapshotPermissionsRequestPayload.md)\n - [SnapshotSharing](docs/SnapshotSharing.md)\n - [SnapshotSharingPermissions](docs/SnapshotSharingPermissions.md)\n - [SnapshotStatus](docs/SnapshotStatus.md)\n - [SslsplitFilter](docs/SslsplitFilter.md)\n - [SubscriberInvite](docs/SubscriberInvite.md)\n - [Team](docs/Team.md)\n - [TeamCreate](docs/TeamCreate.md)\n - [TestAssessmentDto](docs/TestAssessmentDto.md)\n - [TextInput](docs/TextInput.md)\n - [Token](docs/Token.md)\n - [TouchCurveInput](docs/TouchCurveInput.md)\n - [TouchInput](docs/TouchInput.md)\n - [TouchInputButtonsInner](docs/TouchInputButtonsInner.md)\n - [Trial](docs/Trial.md)\n - [TrialExtension](docs/TrialExtension.md)\n - [TrialRequestMetadata](docs/TrialRequestMetadata.md)\n - [TrialRequestOptions](docs/TrialRequestOptions.md)\n - [UpdateAssessmentDto](docs/UpdateAssessmentDto.md)\n - [UpdateExtension](docs/UpdateExtension.md)\n - [UpdateNetworkConnectionOptions](docs/UpdateNetworkConnectionOptions.md)\n - [User](docs/User.md)\n - [UserError](docs/UserError.md)\n - [UserSnapshots](docs/UserSnapshots.md)\n - [V1CheckSubdomainExistenceParameters](docs/V1CheckSubdomainExistenceParameters.md)\n - [V1CreateHookParameters](docs/V1CreateHookParameters.md)\n - [V1LoadExtensionParameters](docs/V1LoadExtensionParameters.md)\n - [V1SetStateBody](docs/V1SetStateBody.md)\n - [ValidationError](docs/ValidationError.md)\n - [VolumeOptions](docs/VolumeOptions.md)\n - [VpnDefinition](docs/VpnDefinition.md)\n - [WebPlayerCreateSessionRequest](docs/WebPlayerCreateSessionRequest.md)\n - [WebPlayerSession](docs/WebPlayerSession.md)\n\n\n## Documentation For Authorization\n\n\n## BearerAuth\n\n- **Type**: Bearer authentication (ApiToken or JWT)\n\n\n## Author\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorellium%2Fpython-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorellium%2Fpython-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorellium%2Fpython-api-client/lists"}