ConfigApi.md

corellium.ConfigApi

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_get_config	GET /v3/config	Get deployment configuration
v3_get_version	GET /v3/version	Get the platform version

v3_get_config

ConfigResponse v3_get_config()

Get deployment configuration

Returns how this Corellium deployment is set up: its version, whether it is on-site or cloud, whether it is air-gapped, the sign-in providers offered, limits such as the per-device snapshot limit (snapshotLimit) and the maximum kernel and ramdisk upload sizes, and which optional features are turned on. Needs no sign-in, so a client can call it first to adapt to the deployment before the user signs in. Build-time feature flags may add further boolean properties beyond those listed.

Example

import corellium
from corellium.models.config_response import ConfigResponse
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"
)


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

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

Parameters

This endpoint does not need any parameter.

Return type

ConfigResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-

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

v3_get_version

DeploymentVersion v3_get_version()

Get the platform version

Returns which version of the Corellium platform you are talking to: the product version (for example 7.4.0-28212), plus the build it came from. Include it when reporting a problem to support, or check it to see whether a feature you need is available on this deployment.

Example

• Bearer (JWT) Authentication (BearerAuth):

import corellium
from corellium.models.deployment_version import DeploymentVersion
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.ConfigApi(api_client)

    try:
        # Get the platform version
        api_response = api_instance.v3_get_version()
        print("The response of ConfigApi->v3_get_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigApi->v3_get_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DeploymentVersion

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Version and build identity of the running deployment.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-

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