HyperTraceV1Api.md

corellium.HyperTraceV1Api

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
v1_btrace_preauthorize	GET /v1/instances/{instanceId}/btrace-authorize	Pre-authorize an btrace download
v1_clear_hyper_trace	DELETE /v1/instances/{instanceId}/btrace	Clear HyperTrace logs
v1_kcrange	GET /v1/instances/{instanceId}/btrace-kcrange	Get Kernel extension ranges
v1_start_hyper_trace	POST /v1/instances/{instanceId}/btrace/enable	Start HyperTrace on an instance
v1_stop_hyper_trace	POST /v1/instances/{instanceId}/btrace/disable	Stop HyperTrace on an instance.

v1_btrace_preauthorize

TokenV1 v1_btrace_preauthorize(instance_id)

Pre-authorize an btrace download

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.token_v1 import TokenV1
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.HyperTraceV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Pre-authorize an btrace download
        api_response = api_instance.v1_btrace_preauthorize(instance_id)
        print("The response of HyperTraceV1Api->v1_btrace_preauthorize:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HyperTraceV1Api->v1_btrace_preauthorize: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_id	str	Instance ID - uuid

Return type

TokenV1

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Token	-
400	Bad Request	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_clear_hyper_trace

v1_clear_hyper_trace(instance_id)

Clear HyperTrace logs

Example

Bearer (JWT) Authentication (BearerAuth):

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.HyperTraceV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Clear HyperTrace logs
        api_instance.v1_clear_hyper_trace(instance_id)
    except Exception as e:
        print("Exception when calling HyperTraceV1Api->v1_clear_hyper_trace: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_id	str	Instance ID - uuid

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Accepted	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_kcrange

List[KcrangeV1] v1_kcrange(instance_id)

Get Kernel extension ranges

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.kcrange_v1 import KcrangeV1
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.HyperTraceV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Get Kernel extension ranges
        api_response = api_instance.v1_kcrange(instance_id)
        print("The response of HyperTraceV1Api->v1_kcrange:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HyperTraceV1Api->v1_kcrange: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_id	str	Instance ID - uuid

Return type

List[KcrangeV1]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Kcranges	-
400	Bad Request	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_start_hyper_trace

v1_start_hyper_trace(instance_id, btrace_enable_options)

Start HyperTrace on an instance

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.btrace_enable_options import BtraceEnableOptions
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.HyperTraceV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid
    btrace_enable_options = corellium.BtraceEnableOptions() # BtraceEnableOptions | 

    try:
        # Start HyperTrace on an instance
        api_instance.v1_start_hyper_trace(instance_id, btrace_enable_options)
    except Exception as e:
        print("Exception when calling HyperTraceV1Api->v1_start_hyper_trace: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_id	str	Instance ID - uuid
btrace_enable_options	BtraceEnableOptions

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_stop_hyper_trace

v1_stop_hyper_trace(instance_id)

Stop HyperTrace on an instance.

Example

Bearer (JWT) Authentication (BearerAuth):

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.HyperTraceV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Stop HyperTrace on an instance.
        api_instance.v1_stop_hyper_trace(instance_id)
    except Exception as e:
        print("Exception when calling HyperTraceV1Api->v1_stop_hyper_trace: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_id	str	Instance ID - uuid

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

HyperTraceV1Api.md

Latest commit

History

HyperTraceV1Api.md

File metadata and controls

corellium.HyperTraceV1Api

Request timeouts

v1_btrace_preauthorize

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_clear_hyper_trace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_kcrange

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_start_hyper_trace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_stop_hyper_trace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details