corellium.ClusterAdministrationFirmwareServiceApi

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_create_assets_firmware_service	POST /v1/cluster/firmware-service/firmware-assets	Add firmware assets via the firmware service
v1_create_image	POST /v1/images	Create a new Image
v1_delete_asset_firmware_service	DELETE /v1/cluster/firmware-service/firmware-assets/{assetURL}	Delete a firmware asset by its URL
v1_delete_firmware_firmware_service	DELETE /v1/cluster/firmware-service/firmwares/{filename}	Delete a firmware by filename from the firmware service
v1_get_asset_extended_firmware_service	GET /v1/cluster/firmware-service/firmware-assets/{assetURL}/extended	Fetch extended firmware-asset details including instances and associated IPSWs
v1_get_config_firmware_service	GET /v1/cluster/firmware-service/config	Fetch firmware service configuration
v1_get_install_firmware_status	GET /v1/images/install-firmware/{taskId}	Query install firmware request status.
v1_install_firmware	POST /v1/images/install-firmware	Installs a firmware for cluster-wide use
v1_install_firmware_assets	POST /v1/images/install-firmware-assets	Installs firmware assets for cluster-wide use
v1_list_assets_firmware_service	GET /v1/cluster/firmware-service/firmware-assets	Fetch firmware assets from the firmware service
v1_list_devices_firmware_service	GET /v1/cluster/firmware-service/devices	Fetch devices from the firmware service
v1_list_firmwares_firmware_service	GET /v1/cluster/firmware-service/firmwares	Fetch firmwares from the firmware service
v1_patch_config_firmware_service	PATCH /v1/cluster/firmware-service/config	Update firmware service configuration
v1_upload_image_data	POST /v1/images/{imageId}	Upload Image Data

v1_create_assets_firmware_service

str v1_create_assets_firmware_service(body)

Add firmware assets via the firmware service

Proxies a request to the firmware service to add firmware assets.

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.ClusterAdministrationFirmwareServiceApi(api_client)
    body = {
  "https://wkms-public.apple.com/fcs-keys/0-rpBmpVnBmLtxdIwb97a_jAodE52Gv8Al_CN8DdwzQ=": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JR0hBZ0VBTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEJHMHdhd0lCQVFRZ1plQ25uTW5CZEx3RkM1K2EKUU9ITGswQ1Z1aGJHWE1kUlBiekJOMTREOWp1aFJBTkNBQVRLT3NyZUc4VG1XbExTeU1KUnBSWTA2N1NudFhmZgpkakhWenQwN1ZZVm1wZ1dGZEJGUERGTFdiQkYrYlpQeGRJVW14dzFMN3NlMEUrdE1DcTk4bkEyMQotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCg==",
  "https://wkms-public.apple.com/fcs-keys/09QNzDMRwGnqUMjbRQcsH7sHx2GJUub-NmLLpIsd8Yc=": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JR0hBZ0VBTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEJHMHdhd0lCQVFRZ0QyeTRzZE1QNXE2eHZ4NTIKMFNqaCt1S0JkcWVTRlF2T083Rm9PaHg1RHZxaFJBTkNBQVRLbEMvdXhKa3Q4d0FhS1Fzd3paeVJ4WWVTN0pOVAowRlFsS0w3S0hZb1k0U1FWekZWNTBkQkhGeGRVMHVaeGN3Rk9MaW1MTVZZaHBtREQ0enFpZGtPeAotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCg=="
} # object | Firmware assets payload

    try:
        # Add firmware assets via the firmware service
        api_response = api_instance.v1_create_assets_firmware_service(body)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_create_assets_firmware_service:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_create_assets_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object	Firmware assets payload

Return type

str

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: text/html, application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_create_image

ImageV1 v1_create_image(image_creation_options)

Create a new Image

Create a new Image. Accepts multipart/form-data (with optional file upload) or application/json (metadata only).

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.image_creation_options import ImageCreationOptions
from corellium.models.image_v1 import ImageV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    image_creation_options = {
  "name": "test",
  "type": "kernel",
  "encoding": "plain",
  "file": (binary)
} # ImageCreationOptions | Image data

    try:
        # Create a new Image
        api_response = api_instance.v1_create_image(image_creation_options)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_create_image:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_create_image: %s\n" % e)

Parameters

Name	Type	Description	Notes
image_creation_options	ImageCreationOptions	Image data

Return type

ImageV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	application/json	-
201	application/json	-
404	application/json	-
507	Insufficient Storage	-

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

v1_delete_asset_firmware_service

v1_delete_asset_firmware_service(asset_url)

Delete a firmware asset by its URL

Proxies a request to the firmware service to delete a firmware asset by URL.

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.ClusterAdministrationFirmwareServiceApi(api_client)
    asset_url = 'asset_url_example' # str | The raw firmware asset URL. Percent-encode it once when composing the request path by hand.

    try:
        # Delete a firmware asset by its URL
        api_instance.v1_delete_asset_firmware_service(asset_url)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_delete_asset_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_url	str	The raw firmware asset URL. Percent-encode it once when composing the request path by hand.

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	-
404	Not found	-
500	Internal Server Error	-

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

v1_delete_firmware_firmware_service

v1_delete_firmware_firmware_service(filename)

Delete a firmware by filename from the firmware service

Proxies a request to the firmware service to delete a firmware by filename.

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.ClusterAdministrationFirmwareServiceApi(api_client)
    filename = 'filename_example' # str | The filename of the firmware to delete

    try:
        # Delete a firmware by filename from the firmware service
        api_instance.v1_delete_firmware_firmware_service(filename)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_delete_firmware_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
filename	str	The filename of the firmware to delete

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	-
404	Not found	-
409	Conflict	-
500	Internal Server Error	-

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

v1_get_asset_extended_firmware_service

ExtendedFirmwareAssetInfoV1 v1_get_asset_extended_firmware_service(asset_url)

Fetch extended firmware-asset details including instances and associated IPSWs

Retrieves extended information about a firmware including all instances using it and associated firmware assets.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.extended_firmware_asset_info_v1 import ExtendedFirmwareAssetInfoV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    asset_url = 'asset_url_example' # str | The raw firmware asset URL. Percent-encode it once when composing the request path by hand.

    try:
        # Fetch extended firmware-asset details including instances and associated IPSWs
        api_response = api_instance.v1_get_asset_extended_firmware_service(asset_url)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_get_asset_extended_firmware_service:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_get_asset_extended_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_url	str	The raw firmware asset URL. Percent-encode it once when composing the request path by hand.

Return type

ExtendedFirmwareAssetInfoV1

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_get_config_firmware_service

v1_get_config_firmware_service()

Fetch firmware service configuration

Returns a firmware service configuration object

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.ClusterAdministrationFirmwareServiceApi(api_client)

    try:
        # Fetch firmware service configuration
        api_instance.v1_get_config_firmware_service()
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_get_config_firmware_service: %s\n" % e)

Parameters

This endpoint does not need any parameter.

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
200	application/json	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_get_install_firmware_status

InstallFirmwareResponseV1 v1_get_install_firmware_status(task_id)

Query install firmware request status.

Returns the status of an install firmware request.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.install_firmware_response_v1 import InstallFirmwareResponseV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    task_id = 'task_id_example' # str | Task ID - uuid

    try:
        # Query install firmware request status.
        api_response = api_instance.v1_get_install_firmware_status(task_id)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_get_install_firmware_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_get_install_firmware_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str	Task ID - uuid

Return type

InstallFirmwareResponseV1

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	application/json	-
400	Bad Request	-
404	Not Found	-

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

v1_install_firmware

InstallFirmwareResponseV1 v1_install_firmware(install_firmware_body_v1)

Installs a firmware for cluster-wide use

Takes an uploaded firmware image and installs it for cluster-wide use. The firmware is then removed from Images.

In order to install a firmware, you need to follow a 4-step process. First, POST /v1/images/ with { name: string, type: 'fw' } using content-type application/json to acquire an imageId.

Second, upload the firmware file via a multipart/form-data POST to /v1/images/:imageId.

Third, POST /v1/images/install-firmware with { imageId: string } using content-type application/json to acquire a taskId.

Fourth, you can poll the state of the installation via GET /v1/images/install-firmware/:taskId.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.install_firmware_body_v1 import InstallFirmwareBodyV1
from corellium.models.install_firmware_response_v1 import InstallFirmwareResponseV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    install_firmware_body_v1 = corellium.InstallFirmwareBodyV1() # InstallFirmwareBodyV1 | User data

    try:
        # Installs a firmware for cluster-wide use
        api_response = api_instance.v1_install_firmware(install_firmware_body_v1)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_install_firmware:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_install_firmware: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_firmware_body_v1	InstallFirmwareBodyV1	User data

Return type

InstallFirmwareResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	application/json	-
400	Bad Request	-
404	Not Found	-

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

v1_install_firmware_assets

InstallFirmwareAssetsResponseV1 v1_install_firmware_assets(install_firmware_assets_body_v1)

Installs firmware assets for cluster-wide use

Takes an uploaded firmware assets blob image and installs it for cluster-wide use. The image is then removed from Images.

This endpoint is synchronous: it forwards the asset JSON to the firmware service and returns the firmware service's response message directly. There is no task ID and no polling endpoint.

Installing firmware assets is a 3-step process. First, POST /v1/images/ with { name: string, type: 'fwasset' } using content-type application/json to acquire an imageId. name should be something like 'fcs-keys.json'

Second, upload the firmware assets file via a multipart/form-data POST to /v1/images/:imageId.

Third, POST /v1/images/install-firmware-assets with { imageId: string; } using content-type application/json. The response body is { message: string } describing what the firmware service did with the assets.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.install_firmware_assets_body_v1 import InstallFirmwareAssetsBodyV1
from corellium.models.install_firmware_assets_response_v1 import InstallFirmwareAssetsResponseV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    install_firmware_assets_body_v1 = corellium.InstallFirmwareAssetsBodyV1() # InstallFirmwareAssetsBodyV1 | User data

    try:
        # Installs firmware assets for cluster-wide use
        api_response = api_instance.v1_install_firmware_assets(install_firmware_assets_body_v1)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_install_firmware_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_install_firmware_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_firmware_assets_body_v1	InstallFirmwareAssetsBodyV1	User data

Return type

InstallFirmwareAssetsResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	application/json	-
400	Bad Request	-
404	Not Found	-

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

v1_list_assets_firmware_service

List[FirmwareAssetV1] v1_list_assets_firmware_service(limit=limit, offset=offset, order=order, search=search)

Fetch firmware assets from the firmware service

Proxies a request to the firmware service to retrieve a list of firmware assets.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_asset_v1 import FirmwareAssetV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    limit = 3.4 # float | Number of results to return (min: 1, max: 10000, default: 100) (optional)
    offset = 3.4 # float | Index of the first row to return (default: 0) (optional)
    order = 'order_example' # str | Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'url,-domain'). (optional)
    search = 'search_example' # str | Case-insensitive partial match across url, domain (optional)

    try:
        # Fetch firmware assets from the firmware service
        api_response = api_instance.v1_list_assets_firmware_service(limit=limit, offset=offset, order=order, search=search)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_list_assets_firmware_service:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_list_assets_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return (min: 1, max: 10000, default: 100)	[optional]
offset	float	Index of the first row to return (default: 0)	[optional]
order	str	Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'url,-domain').	[optional]
search	str	Case-insensitive partial match across url, domain	[optional]

Return type

List[FirmwareAssetV1]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	application/json	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_list_devices_firmware_service

List[Device] v1_list_devices_firmware_service(limit=limit, offset=offset, search=search, order=order, type=type, model=model, name=name, platform=platform)

Fetch devices from the firmware service

Proxies a request to the firmware service to retrieve a list of devices.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.device import Device
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.ClusterAdministrationFirmwareServiceApi(api_client)
    limit = 3.4 # float | Number of results to return (min: 1, max: 10000, default: 100) (optional)
    offset = 3.4 # float | Index of the first row to return (default: 0) (optional)
    search = 'search_example' # str | Case-insensitive partial match across name, model, platform, and hwmodel fields (optional)
    order = 'order_example' # str | Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'name,-platform'). Allowed fields: name, model, type, platform, hwmodel  Filtering options: (optional)
    type = 'type_example' # str | Filter by exact type. Example: coreimg (optional)
    model = 'model_example' # str | Filter by exact model. Example: Example: iPhone8,1 (optional)
    name = 'name_example' # str | Filter by exact name. Example: iPhone6s (optional)
    platform = 'platform_example' # str | Filter by exact platform. Example: s5l8960x (optional)

    try:
        # Fetch devices from the firmware service
        api_response = api_instance.v1_list_devices_firmware_service(limit=limit, offset=offset, search=search, order=order, type=type, model=model, name=name, platform=platform)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_list_devices_firmware_service:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_list_devices_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return (min: 1, max: 10000, default: 100)	[optional]
offset	float	Index of the first row to return (default: 0)	[optional]
search	str	Case-insensitive partial match across name, model, platform, and hwmodel fields	[optional]
order	str	Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'name,-platform'). Allowed fields: name, model, type, platform, hwmodel Filtering options:	[optional]
type	str	Filter by exact type. Example: coreimg	[optional]
model	str	Filter by exact model. Example: Example: iPhone8,1	[optional]
name	str	Filter by exact name. Example: iPhone6s	[optional]
platform	str	Filter by exact platform. Example: s5l8960x	[optional]

Return type

List[Device]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_list_firmwares_firmware_service

List[FirmwareV1] v1_list_firmwares_firmware_service(limit=limit, offset=offset, search=search, order=order, filename=filename, model=model, type=type, version=version, buildid=buildid, firmware_assets=firmware_assets, installed=installed)

Fetch firmwares from the firmware service

Proxies a request to the firmware service to retrieve a list of firmwares.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_v1 import FirmwareV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    limit = 3.4 # float | Number of results to return (min: 1, max: 10000, default: 100) (optional)
    offset = 3.4 # float | Index of the first row to return (default: 0) (optional)
    search = 'search_example' # str | Case-insensitive partial match across filename, model, type, version and buildid fields (optional)
    order = 'order_example' # str | Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'name,-platform'). Allowed fields: filename, model, type, version, buildid  Filtering options: (optional)
    filename = 'filename_example' # str | Filter by exact filename. Example: iPhone_4.7_P3_12.1.4_16D57_Restore.ipsw (optional)
    model = 'model_example' # str | Filter by exact model. Example: iPhone10,4 (optional)
    type = 'type_example' # str | Filter by exact type. Example: ipsw (optional)
    version = 'version_example' # str | Filter by exact version. Example: 12.1.4 (optional)
    buildid = 'buildid_example' # str | Filter by exact buildid. Example: 16D57 (optional)
    firmware_assets = 'firmware_assets_example' # str | Filter by exact asset URL/ID. Example: https://wkms-public.apple.com/fcs-keys/rl_td3o_0EtXT8t6HvVJoeWXnoBuzumHyUTD8-MUaF8= -OR- rl_td3o_0EtXT8t6HvVJoeWXnoBuzumHyUTD8-MUaF8= (optional)
    installed = True # bool | Filter by installed status (optional)

    try:
        # Fetch firmwares from the firmware service
        api_response = api_instance.v1_list_firmwares_firmware_service(limit=limit, offset=offset, search=search, order=order, filename=filename, model=model, type=type, version=version, buildid=buildid, firmware_assets=firmware_assets, installed=installed)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_list_firmwares_firmware_service:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_list_firmwares_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return (min: 1, max: 10000, default: 100)	[optional]
offset	float	Index of the first row to return (default: 0)	[optional]
search	str	Case-insensitive partial match across filename, model, type, version and buildid fields	[optional]
order	str	Comma-separated field names for sorting. Prefix with '-' for descending order (e.g., 'name,-platform'). Allowed fields: filename, model, type, version, buildid Filtering options:	[optional]
filename	str	Filter by exact filename. Example: iPhone_4.7_P3_12.1.4_16D57_Restore.ipsw	[optional]
model	str	Filter by exact model. Example: iPhone10,4	[optional]
type	str	Filter by exact type. Example: ipsw	[optional]
version	str	Filter by exact version. Example: 12.1.4	[optional]
buildid	str	Filter by exact buildid. Example: 16D57	[optional]
firmware_assets	str	Filter by exact asset URL/ID. Example: https://wkms-public.apple.com/fcs-keys/rl_td3o_0EtXT8t6HvVJoeWXnoBuzumHyUTD8-MUaF8= -OR- rl_td3o_0EtXT8t6HvVJoeWXnoBuzumHyUTD8-MUaF8=	[optional]
installed	bool	Filter by installed status	[optional]

Return type

List[FirmwareV1]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_patch_config_firmware_service

v1_patch_config_firmware_service(firmware_service_configuration)

Update firmware service configuration

Updates firmware service configuration

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_service_configuration import FirmwareServiceConfiguration
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.ClusterAdministrationFirmwareServiceApi(api_client)
    firmware_service_configuration = corellium.FirmwareServiceConfiguration() # FirmwareServiceConfiguration | Firmware configuration payload

    try:
        # Update firmware service configuration
        api_instance.v1_patch_config_firmware_service(firmware_service_configuration)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_patch_config_firmware_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
firmware_service_configuration	FirmwareServiceConfiguration	Firmware configuration payload

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
200	application/json	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
500	Internal Server Error	-

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

v1_upload_image_data

ImageV1 v1_upload_image_data(image_id, corellium_checksum=corellium_checksum, file=file)

Upload Image Data

If the active project has enough remaining quota, updates an Image with the contents of the request body.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.image_v1 import ImageV1
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.ClusterAdministrationFirmwareServiceApi(api_client)
    image_id = 'image_id_example' # str | Image ID - uuid
    corellium_checksum = 'corellium_checksum_example' # str | Corellium Checksum of the uploaded firmware (optional)
    file = None # bytearray | Optionally the actual file (optional)

    try:
        # Upload Image Data
        api_response = api_instance.v1_upload_image_data(image_id, corellium_checksum=corellium_checksum, file=file)
        print("The response of ClusterAdministrationFirmwareServiceApi->v1_upload_image_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClusterAdministrationFirmwareServiceApi->v1_upload_image_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
image_id	str	Image ID - uuid
corellium_checksum	str	Corellium Checksum of the uploaded firmware	[optional]
file	bytearray	Optionally the actual file	[optional]

Return type

ImageV1

Authorization

BearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	application/json	-
404	application/json	-
409	Conflict	-
507	Insufficient Storage	-

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

FilesExpand file tree

ClusterAdministrationFirmwareServiceApi.md

Latest commit

History

ClusterAdministrationFirmwareServiceApi.md

File metadata and controls

corellium.ClusterAdministrationFirmwareServiceApi

Request timeouts

v1_create_assets_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_create_image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_delete_asset_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_delete_firmware_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_get_asset_extended_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_get_config_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_get_install_firmware_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_install_firmware

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_install_firmware_assets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_list_assets_firmware_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_list_devices_firmware_service

Example