corellium.ExternalServicesApi

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
delete_external_service	DELETE /{apiVersion}/external-services/{serviceName}/{path}	Proxy a DELETE request to an external service
get_external_service	GET /{apiVersion}/external-services/{serviceName}/{path}	Proxy a GET request to an external service
patch_external_service	PATCH /{apiVersion}/external-services/{serviceName}/{path}	Proxy a PATCH request to an external service
post_external_service	POST /{apiVersion}/external-services/{serviceName}/{path}	Proxy a POST request to an external service
put_external_service	PUT /{apiVersion}/external-services/{serviceName}/{path}	Proxy a PUT request to an external service

delete_external_service

delete_external_service(api_version, service_name, path)

Proxy a DELETE request to an external service

Forwards this request to an optional external service connected to the platform (named by serviceName, for example apps), passing along the rest of the path, and returns that service's response unchanged. What each path does is defined by the external service, not by this API. Returns 503 if the service is not available on this deployment or cannot be reached.

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.ExternalServicesApi(api_client)
    api_version = 'v1' # str | API version (e.g. v1, v3).
    service_name = 'apps' # str | Target service name.
    path = 'apps/12345/download' # str | The path to call on the external service. Slashes are kept as path separators.

    try:
        # Proxy a DELETE request to an external service
        api_instance.delete_external_service(api_version, service_name, path)
    except Exception as e:
        print("Exception when calling ExternalServicesApi->delete_external_service: %s\n" % e)

Parameters

Name	Type	Description
api_version	str	API version (e.g. v1, v3).
service_name	str	Target service name.
path	str	The path to call on the external service. Slashes are kept as path separators.

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	Response proxied from the external service.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	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.	-
503	External service not found, cluster token not set, or the upstream service is unreachable.	-

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

get_external_service

get_external_service(api_version, service_name, path)

Proxy a GET request to an external service

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.ExternalServicesApi(api_client)
    api_version = 'v1' # str | API version (e.g. v1, v3).
    service_name = 'apps' # str | Target service name.
    path = 'apps/12345/download' # str | The path to call on the external service. Slashes are kept as path separators.

    try:
        # Proxy a GET request to an external service
        api_instance.get_external_service(api_version, service_name, path)
    except Exception as e:
        print("Exception when calling ExternalServicesApi->get_external_service: %s\n" % e)

Parameters

Name	Type	Description
api_version	str	API version (e.g. v1, v3).
service_name	str	Target service name.
path	str	The path to call on the external service. Slashes are kept as path separators.

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	Response proxied from the external service.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	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.	-
503	External service not found, cluster token not set, or the upstream service is unreachable.	-

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

patch_external_service

patch_external_service(api_version, service_name, path)

Proxy a PATCH request to an external service

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.ExternalServicesApi(api_client)
    api_version = 'v1' # str | API version (e.g. v1, v3).
    service_name = 'apps' # str | Target service name.
    path = 'apps/12345/download' # str | The path to call on the external service. Slashes are kept as path separators.

    try:
        # Proxy a PATCH request to an external service
        api_instance.patch_external_service(api_version, service_name, path)
    except Exception as e:
        print("Exception when calling ExternalServicesApi->patch_external_service: %s\n" % e)

Parameters

Name	Type	Description
api_version	str	API version (e.g. v1, v3).
service_name	str	Target service name.
path	str	The path to call on the external service. Slashes are kept as path separators.

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	Response proxied from the external service.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	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.	-
503	External service not found, cluster token not set, or the upstream service is unreachable.	-

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

post_external_service

post_external_service(api_version, service_name, path)

Proxy a POST request to an external service

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.ExternalServicesApi(api_client)
    api_version = 'v1' # str | API version (e.g. v1, v3).
    service_name = 'apps' # str | Target service name.
    path = 'apps/12345/download' # str | The path to call on the external service. Slashes are kept as path separators.

    try:
        # Proxy a POST request to an external service
        api_instance.post_external_service(api_version, service_name, path)
    except Exception as e:
        print("Exception when calling ExternalServicesApi->post_external_service: %s\n" % e)

Parameters

Name	Type	Description
api_version	str	API version (e.g. v1, v3).
service_name	str	Target service name.
path	str	The path to call on the external service. Slashes are kept as path separators.

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	Response proxied from the external service.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	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.	-
503	External service not found, cluster token not set, or the upstream service is unreachable.	-

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

put_external_service

put_external_service(api_version, service_name, path)

Proxy a PUT request to an external service

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.ExternalServicesApi(api_client)
    api_version = 'v1' # str | API version (e.g. v1, v3).
    service_name = 'apps' # str | Target service name.
    path = 'apps/12345/download' # str | The path to call on the external service. Slashes are kept as path separators.

    try:
        # Proxy a PUT request to an external service
        api_instance.put_external_service(api_version, service_name, path)
    except Exception as e:
        print("Exception when calling ExternalServicesApi->put_external_service: %s\n" % e)

Parameters

Name	Type	Description
api_version	str	API version (e.g. v1, v3).
service_name	str	Target service name.
path	str	The path to call on the external service. Slashes are kept as path separators.

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	Response proxied from the external service.	-
401	Not signed in: the `Authorization: Bearer <token>` header is missing, or the token is invalid or expired. Get a new token and retry.	-
403	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.	-
503	External service not found, cluster token not set, or the upstream service is unreachable.	-

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

FilesExpand file tree

ExternalServicesApi.md

Latest commit

History

ExternalServicesApi.md

File metadata and controls

corellium.ExternalServicesApi

Request timeouts

delete_external_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_external_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_external_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_external_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_external_service

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details