Skip to content

RAMDumpApi.md

Latest commit

 

History

History
279 lines (194 loc) · 10.8 KB

RAMDumpApi.md

File metadata and controls

279 lines (194 loc) · 10.8 KB
Raw

corellium.RAMDumpApi

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_clear_ram_dump DELETE /v3/instances/{instanceId}/ramdump Delete a RAM dump
v3_ram_dump_preauthorize GET /v3/instances/{instanceId}/ramdump-authorize Get a RAM dump download token
v3_start_ram_dump POST /v3/instances/{instanceId}/ramdump/start Start a RAM dump

v3_clear_ram_dump

v3_clear_ram_dump(instance_id)

Delete a RAM dump

Deletes this device's RAM dump file. Returns 204 whether or not a dump existed. Requires the RAM dump license feature. An unknown instanceId is a successful no-op that returns 204.

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

    try:
        # Delete a RAM dump
        api_instance.v3_clear_ram_dump(instance_id)
    except Exception as e:
        print("Exception when calling RAMDumpApi->v3_clear_ram_dump: %s\n" % e)

Parameters

Name Type Description Notes
instance_id str Instance ID.

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 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] [Back to Model list] [Back to README]

v3_ram_dump_preauthorize

Token v3_ram_dump_preauthorize(instance_id)

Get a RAM dump download token

Returns a short-lived token that authorizes downloading this device's RAM dump without an Authorization header, so you can hand the link to a download manager or browser. Download with GET /v1/preauthed/{token}/{filename}. The token works only for this device's RAM dump and expires when your current session token expires. Requires the RAM dump license feature.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.token import Token
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.RAMDumpApi(api_client)
    instance_id = 'f7f9832a-f824-416f-a5ea-4adfe34754b5' # str | Instance ID.

    try:
        # Get a RAM dump download token
        api_response = api_instance.v3_ram_dump_preauthorize(instance_id)
        print("The response of RAMDumpApi->v3_ram_dump_preauthorize:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RAMDumpApi->v3_ram_dump_preauthorize: %s\n" % e)

Parameters

Name Type Description Notes
instance_id str Instance ID.

Return type

Token

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 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] [Back to Model list] [Back to README]

v3_start_ram_dump

v3_start_ram_dump(instance_id)

Start a RAM dump

Captures the full contents of the device's memory to a file, for offline analysis with memory forensics tools. Returns 202 as soon as the dump has started; it is written in the background, and large memory sizes take a while. Download it with v3RamDumpPreauthorize when it is done, and delete it with v3ClearRamDump. Requires the RAM dump license feature (403 otherwise).

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

    try:
        # Start a RAM dump
        api_instance.v3_start_ram_dump(instance_id)
    except Exception as e:
        print("Exception when calling RAMDumpApi->v3_start_ram_dump: %s\n" % e)

Parameters

Name Type Description Notes
instance_id str Instance ID.

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 RAM dump started. -
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. -
409 The request conflicts with the current state of the resource. -

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