ModelsV1Api.md

corellium.ModelsV1Api

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_get_model_software	GET /v1/models/{model}/software	Get Software for Model
v1_get_models	GET /v1/models	Get Supported Models

v1_get_model_software

List[FirmwareV1] v1_get_model_software(model)

Get Software for Model

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.ModelsV1Api(api_client)
    model = 'model_example' # str | Model to list available software for

    try:
        # Get Software for Model
        api_response = api_instance.v1_get_model_software(model)
        print("The response of ModelsV1Api->v1_get_model_software:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModelsV1Api->v1_get_model_software: %s\n" % e)

Parameters

Name	Type	Description	Notes
model	str	Model to list available software for

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	Supported software loads for this model	-

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

v1_get_models

List[ModelV1] v1_get_models()

Get Supported Models

Example

• Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.model_v1 import ModelV1
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.ModelsV1Api(api_client)

    try:
        # Get Supported Models
        api_response = api_instance.v1_get_models()
        print("The response of ModelsV1Api->v1_get_models:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModelsV1Api->v1_get_models: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[ModelV1]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Supported device configurations	-

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