corellium.StorageV1Api

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_attach_storage_cluster	POST /v1/cluster/storage/{id}/attach	Mount and attach a storage device
v1_eject_storage_cluster	POST /v1/cluster/storage/{id}/eject	Eject/Unmount removable media
v1_list_storage	GET /v1/storage	Get storage devices
v1_list_storage_cluster	GET /v1/cluster/storage	Get storage devices
v1_list_storage_files	GET /v1/storage/{id}/files/{path}	List Storage Files

v1_attach_storage_cluster

object v1_attach_storage_cluster(id)

Mount and attach a storage device

Initiates an asynchronous mount job for a registered storage device. If already mounted, returns status 200. If not, queues a background job and returns 202.

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.StorageV1Api(api_client)
    id = 'id_example' # str | The unique identifier of the storage media

    try:
        # Mount and attach a storage device
        api_response = api_instance.v1_attach_storage_cluster(id)
        print("The response of StorageV1Api->v1_attach_storage_cluster:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageV1Api->v1_attach_storage_cluster: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The unique identifier of the storage media

Return type

object

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Device is already mounted	-
202	Mount job successfully queued	-
403	Forbidden	-
404	MediaStore record not found	-
500	System failure while queuing the job	-

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

v1_eject_storage_cluster

object v1_eject_storage_cluster(id)

Eject/Unmount removable media

Initiates an asynchronous unmount job for the physical storage device. If the device is already unmounted, returns success. If mounted, creates a background job to safely unmount.

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.StorageV1Api(api_client)
    id = 'id_example' # str | Storage device identifier (UUID)

    try:
        # Eject/Unmount removable media
        api_response = api_instance.v1_eject_storage_cluster(id)
        print("The response of StorageV1Api->v1_eject_storage_cluster:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageV1Api->v1_eject_storage_cluster: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Storage device identifier (UUID)

Return type

object

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Device is already unmounted	-
202	Unmount job successfully queued	-
403	Forbidden	-
404	MediaStore record not found	-
500	System failure during job queuing	-

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

v1_list_storage

GetStorageResponse v1_list_storage(limit=limit, offset=offset, identifier=identifier, device=device, fs_type=fs_type, mount_policy=mount_policy, status=status, sort=sort)

Get storage devices

List all attached storage devices. This endpoint is only available to all authenticated users.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.get_storage_response import GetStorageResponse
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.StorageV1Api(api_client)
    limit = 3.4 # float | Maximum number of results to return (1–1000, default: 100) (optional)
    offset = 3.4 # float | Number of results to skip (default: 0) (optional)
    identifier = 'identifier_example' # str | Filter by identifier (comma separated) (optional)
    device = 'device_example' # str | Filter by device name (partial match) (optional)
    fs_type = 'fs_type_example' # str | Filter by filesystem type (comma separated) (optional)
    mount_policy = 'mount_policy_example' # str | Filter by mount policy (RO or RW) (optional)
    status = 'status_example' # str | Filter by status (unmounted or mounted) (optional)
    sort = 'sort_example' # str | Sort order (e.g. \"device\" or \"-device\") (optional)

    try:
        # Get storage devices
        api_response = api_instance.v1_list_storage(limit=limit, offset=offset, identifier=identifier, device=device, fs_type=fs_type, mount_policy=mount_policy, status=status, sort=sort)
        print("The response of StorageV1Api->v1_list_storage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageV1Api->v1_list_storage: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Maximum number of results to return (1–1000, default: 100)	[optional]
offset	float	Number of results to skip (default: 0)	[optional]
identifier	str	Filter by identifier (comma separated)	[optional]
device	str	Filter by device name (partial match)	[optional]
fs_type	str	Filter by filesystem type (comma separated)	[optional]
mount_policy	str	Filter by mount policy (RO or RW)	[optional]
status	str	Filter by status (unmounted or mounted)	[optional]
sort	str	Sort order (e.g. "device" or "-device")	[optional]

Return type

GetStorageResponse

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved storage devices	-
401	Unauthorized	-
403	Forbidden	-
500	Internal server error	-

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

v1_list_storage_cluster

GetStorageResponse v1_list_storage_cluster(limit=limit, offset=offset, device=device, fs_type=fs_type, fs_uuid=fs_uuid, label=label, serial=serial, vendor=vendor, model=model, mount_policy=mount_policy, status=status, sort=sort)

Get storage devices

List all attached storage devices. This endpoint is only available to cluster administrators.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.get_storage_response import GetStorageResponse
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.StorageV1Api(api_client)
    limit = 3.4 # float | Maximum number of results to return (1–1000, default: 100) (optional)
    offset = 3.4 # float | Number of results to skip (default: 0) (optional)
    device = 'device_example' # str | Filter by device name (partial match) (optional)
    fs_type = 'fs_type_example' # str | Filter by filesystem type (comma separated) (optional)
    fs_uuid = 'fs_uuid_example' # str | Filter by filesystem UUID (partial match) (optional)
    label = 'label_example' # str | Filter by label (partial match) (optional)
    serial = 'serial_example' # str | Filter by serial number (partial match) (optional)
    vendor = 'vendor_example' # str | Filter by vendor (partial match) (optional)
    model = 'model_example' # str | Filter by model (partial match) (optional)
    mount_policy = 'mount_policy_example' # str | Filter by mount policy (RO or RW) (optional)
    status = 'status_example' # str | Filter by status (unmounted or mounted) (optional)
    sort = 'sort_example' # str | Sort order (e.g. \"device\" or \"-device\") (optional)

    try:
        # Get storage devices
        api_response = api_instance.v1_list_storage_cluster(limit=limit, offset=offset, device=device, fs_type=fs_type, fs_uuid=fs_uuid, label=label, serial=serial, vendor=vendor, model=model, mount_policy=mount_policy, status=status, sort=sort)
        print("The response of StorageV1Api->v1_list_storage_cluster:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageV1Api->v1_list_storage_cluster: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Maximum number of results to return (1–1000, default: 100)	[optional]
offset	float	Number of results to skip (default: 0)	[optional]
device	str	Filter by device name (partial match)	[optional]
fs_type	str	Filter by filesystem type (comma separated)	[optional]
fs_uuid	str	Filter by filesystem UUID (partial match)	[optional]
label	str	Filter by label (partial match)	[optional]
serial	str	Filter by serial number (partial match)	[optional]
vendor	str	Filter by vendor (partial match)	[optional]
model	str	Filter by model (partial match)	[optional]
mount_policy	str	Filter by mount policy (RO or RW)	[optional]
status	str	Filter by status (unmounted or mounted)	[optional]
sort	str	Sort order (e.g. "device" or "-device")	[optional]

Return type

GetStorageResponse

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved storage devices	-
401	Unauthorized	-
403	Forbidden	-
500	Internal server error	-

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

v1_list_storage_files

object v1_list_storage_files(id, path, limit=limit, offset=offset, name=name, type=type, sort=sort)

List Storage Files

List files from attached storage devices. Looks up the storage device by identifier, then lists filesystem contents at the given path within the device's mount point. This endpoint is available to all authenticated users.

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.StorageV1Api(api_client)
    id = 'id_example' # str | Storage device identifier (MediaStore identifier)
    path = 'path_example' # str | Path within the storage device to list
    limit = 3.4 # float | Maximum number of results to return (1–1000, default: 100) (optional)
    offset = 3.4 # float | Number of results to skip (default: 0) (optional)
    name = 'name_example' # str | Filter by name (case insensitive exact match, comma separated for multiple values) (optional)
    type = 'type_example' # str | Filter by type (case insensitive partial match, e.g. \"file\" or \"dir\") (optional)
    sort = 'sort_example' # str | Sort order (e.g., 'name', '-name', 'type,-size,-lastModifiedTime'). Prefix with '-' for descending. (optional)

    try:
        # List Storage Files
        api_response = api_instance.v1_list_storage_files(id, path, limit=limit, offset=offset, name=name, type=type, sort=sort)
        print("The response of StorageV1Api->v1_list_storage_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageV1Api->v1_list_storage_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Storage device identifier (MediaStore identifier)
path	str	Path within the storage device to list
limit	float	Maximum number of results to return (1–1000, default: 100)	[optional]
offset	float	Number of results to skip (default: 0)	[optional]
name	str	Filter by name (case insensitive exact match, comma separated for multiple values)	[optional]
type	str	Filter by type (case insensitive partial match, e.g. "file" or "dir")	[optional]
sort	str	Sort order (e.g., 'name', '-name', 'type,-size,-lastModifiedTime'). Prefix with '-' for descending.	[optional]

Return type

object

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found (storage device or path)	-
500	Internal Server Error	-

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

FilesExpand file tree

StorageV1Api.md

Latest commit

History

StorageV1Api.md

File metadata and controls

corellium.StorageV1Api

Request timeouts

v1_attach_storage_cluster

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_eject_storage_cluster

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_list_storage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_list_storage_cluster

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_list_storage_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details