corellium.FirmwareServiceApi

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_create_firmware_assets	POST /v3/cluster/firmware-service/firmware-assets	Add firmware assets
v3_delete_firmware	DELETE /v3/cluster/firmware-service/firmwares/{filename}	Delete a firmware
v3_delete_firmware_asset	DELETE /v3/cluster/firmware-service/firmware-assets/{assetUrl}	Delete a firmware asset
v3_get_firmware_asset_extended	GET /v3/cluster/firmware-service/firmware-assets/{assetUrl}/extended	Get extended firmware asset info
v3_get_firmware_service_config	GET /v3/cluster/firmware-service/config	Get firmware service configuration
v3_list_firmware_assets	GET /v3/cluster/firmware-service/firmware-assets	List firmware assets
v3_list_firmware_devices	GET /v3/cluster/firmware-service/devices	List firmware service devices
v3_list_firmwares	GET /v3/cluster/firmware-service/firmwares	List firmwares
v3_patch_firmware_service_config	PATCH /v3/cluster/firmware-service/config	Update firmware service configuration

v3_create_firmware_assets

str v3_create_firmware_assets(request_body=request_body)

Add firmware assets

Required role: Cluster administrator.

Adds firmware assets to the cluster, so firmware that needs them can boot. Returns 201 with the firmware service's response message. Requires a cluster administrator. For a single project, POST /v3/projects/{projectId}/firmware-assets fetches missing assets by URL; on air-gapped deployments, upload them and use POST /v3/images/install-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.FirmwareServiceApi(api_client)
    request_body = {'key': 'request_body_example'} # Dict[str, str] |  (optional)

    try:
        # Add firmware assets
        api_response = api_instance.v3_create_firmware_assets(request_body=request_body)
        print("The response of FirmwareServiceApi->v3_create_firmware_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_create_firmware_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	Dict[str, str]		[optional]

Return type

str

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Firmware assets added.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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.	-
404	The resource does not exist, or you cannot see it.	-

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

v3_delete_firmware

v3_delete_firmware(filename)

Delete a firmware

Required role: Cluster administrator.

Removes a firmware build from the cluster firmware catalog, so it can no longer be chosen when creating devices. Identify it by its filename from v3ListFirmwares. Requires a cluster administrator.

This endpoint proxies the request to the firmware service. A filename the service no longer has is a successful no-op: both a successful upstream delete and an upstream "not there" answer 204, and repeated calls return 204 as well. A firmware-service outage or refusal is still reported as a failure.

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.FirmwareServiceApi(api_client)
    filename = 'firmware.ipsw' # str | Firmware filename.

    try:
        # Delete a firmware
        api_instance.v3_delete_firmware(filename)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_delete_firmware: %s\n" % e)

Parameters

Name	Type	Description	Notes
filename	str	Firmware filename.

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	Firmware deleted.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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]

v3_delete_firmware_asset

v3_delete_firmware_asset(asset_url)

Delete a firmware asset

Required role: Cluster administrator.

Removes a firmware asset from the cluster. Firmware that needs it can no longer boot until it is added again. Requires a cluster administrator.

This endpoint proxies the request to the firmware service. An asset the service no longer has is a successful no-op: both a successful upstream delete and an upstream "not there" answer 204, and repeated calls return 204 as well. A firmware-service outage or refusal is still reported as a failure.

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.FirmwareServiceApi(api_client)
    asset_url = 'https://example.com/firmware-assets/asset.bin' # str | Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.

    try:
        # Delete a firmware asset
        api_instance.v3_delete_firmware_asset(asset_url)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_delete_firmware_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_url	str	Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.

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	Firmware asset deleted.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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_get_firmware_asset_extended

ExtendedFirmwareAssetInfo v3_get_firmware_asset_extended(asset_url)

Get extended firmware asset info

Required role: Cluster administrator.

Shows where a firmware asset is used: the firmware builds that need it and the devices using those builds. Check this before deleting an asset. Requires a cluster administrator.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.extended_firmware_asset_info import ExtendedFirmwareAssetInfo
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.FirmwareServiceApi(api_client)
    asset_url = 'https://example.com/firmware-assets/asset.bin' # str | Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.

    try:
        # Get extended firmware asset info
        api_response = api_instance.v3_get_firmware_asset_extended(asset_url)
        print("The response of FirmwareServiceApi->v3_get_firmware_asset_extended:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_get_firmware_asset_extended: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_url	str	Firmware asset URL, passed as the raw (un-encoded) value. Generated SDK clients percent-encode it into the request path automatically; only when composing the HTTP request path by hand (e.g. curl) does the caller percent-encode it, once, like any path segment.

Return type

ExtendedFirmwareAssetInfo

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Extended firmware asset info.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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.	-
404	The resource does not exist, or you cannot see it.	-

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

v3_get_firmware_service_config

FirmwareServiceConfig v3_get_firmware_service_config()

Get firmware service configuration

Required role: Cluster administrator.

Returns the settings of the cluster firmware service: the cluster-wide catalog of operating-system builds that devices can be created from (what GET /v3/models/{model}/software lists). Settings control things such as whether firmware is downloaded and cached. Requires a cluster administrator. Change them with v3PatchFirmwareServiceConfig.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_service_config import FirmwareServiceConfig
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.FirmwareServiceApi(api_client)

    try:
        # Get firmware service configuration
        api_response = api_instance.v3_get_firmware_service_config()
        print("The response of FirmwareServiceApi->v3_get_firmware_service_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_get_firmware_service_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

FirmwareServiceConfig

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Firmware service configuration.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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_list_firmware_assets

FirmwareAssetList v3_list_firmware_assets(limit=limit, offset=offset, search=search, order=order, filter=filter)

List firmware assets

Required role: Cluster administrator.

Lists the firmware assets stored in the cluster: side files some firmware needs in order to boot, such as Apple decryption keys. A firmware build lists the asset URLs it needs; device creation fails if one is missing. Requires a cluster administrator. Results are paginated.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_asset_filter import FirmwareAssetFilter
from corellium.models.firmware_asset_list import FirmwareAssetList
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.FirmwareServiceApi(api_client)
    limit = 100 # float | Number of results to return. (optional) (default to 100)
    offset = 0 # float | Index of the first row to return. (optional) (default to 0)
    search = 'iPhone13' # str | Case-insensitive partial match across key fields. (optional)
    order = '-createdAt' # str | Comma-separated sort fields; prefix with \"-\" for descending order. (optional)
    filter = corellium.FirmwareAssetFilter() # FirmwareAssetFilter | Exact-match filters (filter[url], filter[domain]). (optional)

    try:
        # List firmware assets
        api_response = api_instance.v3_list_firmware_assets(limit=limit, offset=offset, search=search, order=order, filter=filter)
        print("The response of FirmwareServiceApi->v3_list_firmware_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_list_firmware_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return.	[optional] [default to 100]
offset	float	Index of the first row to return.	[optional] [default to 0]
search	str	Case-insensitive partial match across key fields.	[optional]
order	str	Comma-separated sort fields; prefix with "-" for descending order.	[optional]
filter	FirmwareAssetFilter	Exact-match filters (filter[url], filter[domain]).	[optional]

Return type

FirmwareAssetList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Paginated list of firmware assets.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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.	-
404	The resource does not exist, or you cannot see it.	-

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

v3_list_firmware_devices

FirmwareDeviceList v3_list_firmware_devices(limit=limit, offset=offset, search=search, order=order, type=type, model=model, name=name, platform=platform, hw_model=hw_model)

List firmware service devices

Required role: Cluster administrator.

Lists the device models the firmware service has firmware records for. Requires a cluster administrator. Results are paginated.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_device_list import FirmwareDeviceList
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.FirmwareServiceApi(api_client)
    limit = 100 # float | Number of results to return. (optional) (default to 100)
    offset = 0 # float | Index of the first row to return. (optional) (default to 0)
    search = 'iPhone13' # str | Case-insensitive partial match across key fields. (optional)
    order = '-createdAt' # str | Comma-separated sort fields; prefix with \"-\" for descending order. (optional)
    type = 'ios' # str | Filter by exact type. (optional)
    model = 'iPhone13,2' # str | Filter by exact model. (optional)
    name = 'iPhone 12' # str | Filter by exact name. (optional)
    platform = 't8101' # str | Filter by exact platform. (optional)
    hw_model = 'd53gap' # str | Filter by exact hardware model. (optional)

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

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return.	[optional] [default to 100]
offset	float	Index of the first row to return.	[optional] [default to 0]
search	str	Case-insensitive partial match across key fields.	[optional]
order	str	Comma-separated sort fields; prefix with "-" for descending order.	[optional]
type	str	Filter by exact type.	[optional]
model	str	Filter by exact model.	[optional]
name	str	Filter by exact name.	[optional]
platform	str	Filter by exact platform.	[optional]
hw_model	str	Filter by exact hardware model.	[optional]

Return type

FirmwareDeviceList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Paginated list of devices.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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.	-
404	The resource does not exist, or you cannot see it.	-

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

v3_list_firmwares

FirmwareList v3_list_firmwares(limit=limit, offset=offset, search=search, order=order, filename=filename, model=model, type=type, version=version, build_id=build_id, firmware_assets=firmware_assets, corellium_checksum=corellium_checksum, installed=installed)

List firmwares

Required role: Cluster administrator.

Lists the firmware builds in the cluster firmware catalog, including builds installed with POST /v3/images/install-firmware. Requires a cluster administrator. Results are paginated. Users see the builds for one model with GET /v3/models/{model}/software.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_list import FirmwareList
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.FirmwareServiceApi(api_client)
    limit = 100 # float | Number of results to return. (optional) (default to 100)
    offset = 0 # float | Index of the first row to return. (optional) (default to 0)
    search = 'iPhone13' # str | Case-insensitive partial match across key fields. (optional)
    order = '-createdAt' # str | Comma-separated sort fields; prefix with \"-\" for descending order. (optional)
    filename = 'firmware.ipsw' # str | Filter by exact filename. (optional)
    model = 'iPhone13,2' # str | Filter by exact model. (optional)
    type = 'ios' # str | Filter by exact type. (optional)
    version = '17.5' # str | Filter by exact version. (optional)
    build_id = '21F79' # str | Filter by exact build ID. (optional)
    firmware_assets = 'https://example.com/firmware-assets/asset.bin' # str | Filter by exact asset URL/ID. (optional)
    corellium_checksum = 'sha256$1048576$2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824' # str | Filter by exact Corellium checksum (upload preflight). (optional)
    installed = true # bool | Filter by installed status. (optional)

    try:
        # List firmwares
        api_response = api_instance.v3_list_firmwares(limit=limit, offset=offset, search=search, order=order, filename=filename, model=model, type=type, version=version, build_id=build_id, firmware_assets=firmware_assets, corellium_checksum=corellium_checksum, installed=installed)
        print("The response of FirmwareServiceApi->v3_list_firmwares:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_list_firmwares: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	float	Number of results to return.	[optional] [default to 100]
offset	float	Index of the first row to return.	[optional] [default to 0]
search	str	Case-insensitive partial match across key fields.	[optional]
order	str	Comma-separated sort fields; prefix with "-" for descending order.	[optional]
filename	str	Filter by exact filename.	[optional]
model	str	Filter by exact model.	[optional]
type	str	Filter by exact type.	[optional]
version	str	Filter by exact version.	[optional]
build_id	str	Filter by exact build ID.	[optional]
firmware_assets	str	Filter by exact asset URL/ID.	[optional]
corellium_checksum	str	Filter by exact Corellium checksum (upload preflight).	[optional]
installed	bool	Filter by installed status.	[optional]

Return type

FirmwareList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Paginated list of firmwares.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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.	-
404	The resource does not exist, or you cannot see it.	-

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

v3_patch_firmware_service_config

FirmwareServiceSettings v3_patch_firmware_service_config(patch_firmware_service_config_body=patch_firmware_service_config_body)

Update firmware service configuration

Required role: Cluster administrator.

Changes firmware service settings. Send only the settings you want to change; they are merged into the current settings, and the full result is returned. Requires a cluster administrator.

Example

Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.firmware_service_settings import FirmwareServiceSettings
from corellium.models.patch_firmware_service_config_body import PatchFirmwareServiceConfigBody
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.FirmwareServiceApi(api_client)
    patch_firmware_service_config_body = corellium.PatchFirmwareServiceConfigBody() # PatchFirmwareServiceConfigBody |  (optional)

    try:
        # Update firmware service configuration
        api_response = api_instance.v3_patch_firmware_service_config(patch_firmware_service_config_body=patch_firmware_service_config_body)
        print("The response of FirmwareServiceApi->v3_patch_firmware_service_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FirmwareServiceApi->v3_patch_firmware_service_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
patch_firmware_service_config_body	PatchFirmwareServiceConfigBody		[optional]

Return type

FirmwareServiceSettings

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The full merged settings after the update.	-
400	The request was invalid, for example a missing or malformed field. The body says which field; fix it before retrying.	-
403	Cluster administrator permissions required. 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]

FilesExpand file tree

FirmwareServiceApi.md

Latest commit

History

FirmwareServiceApi.md

File metadata and controls

corellium.FirmwareServiceApi

Request timeouts

v3_create_firmware_assets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_delete_firmware

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_delete_firmware_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_get_firmware_asset_extended

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_get_firmware_service_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_firmware_assets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_firmware_devices

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_firmwares

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_patch_firmware_service_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details