Skip to content

RAMDumpV1Api.md

Latest commit

 

History

History
270 lines (188 loc) · 8.66 KB

RAMDumpV1Api.md

File metadata and controls

270 lines (188 loc) · 8.66 KB
Raw

corellium.RAMDumpV1Api

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_clear_ram_dump DELETE /v1/instances/{instanceId}/ramdump Clear RAM Dump
v1_ram_dump_preauthorize GET /v1/instances/{instanceId}/ramdump-authorize Pre-authorize a RAM Dump download
v1_start_ram_dump POST /v1/instances/{instanceId}/ramdump/start Start a RAM Dump on an instance

v1_clear_ram_dump

v1_clear_ram_dump(instance_id)

Clear RAM Dump

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

    try:
        # Clear RAM Dump
        api_instance.v1_clear_ram_dump(instance_id)
    except Exception as e:
        print("Exception when calling RAMDumpV1Api->v1_clear_ram_dump: %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]

v1_ram_dump_preauthorize

TokenV1 v1_ram_dump_preauthorize(instance_id)

Pre-authorize a RAM Dump 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.RAMDumpV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Pre-authorize a RAM Dump download
        api_response = api_instance.v1_ram_dump_preauthorize(instance_id)
        print("The response of RAMDumpV1Api->v1_ram_dump_preauthorize:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RAMDumpV1Api->v1_ram_dump_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_start_ram_dump

v1_start_ram_dump(instance_id)

Start a RAM Dump 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.RAMDumpV1Api(api_client)
    instance_id = 'instance_id_example' # str | Instance ID - uuid

    try:
        # Start a RAM Dump on an instance
        api_instance.v1_start_ram_dump(instance_id)
    except Exception as e:
        print("Exception when calling RAMDumpV1Api->v1_start_ram_dump: %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
202 Accepted -
400 Bad Request -
403 Forbidden -
409 Conflict -

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