Skip to content

DomainV1Api.md

Latest commit

 

History

History
335 lines (230 loc) · 11.9 KB

DomainV1Api.md

File metadata and controls

335 lines (230 loc) · 11.9 KB
Raw

corellium.DomainV1Api

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_domain_welcome_message POST /v1/domain/welcome Create a welcome message for a domain
v1_delete_domain_welcome_message DELETE /v1/domain/welcome Delete the welcome message for the authenticated user's domain
v1_get_domain_welcome_message GET /v1/domain/welcome Get the welcome message for the authenticated user's domain
v1_update_domain_welcome_message PATCH /v1/domain/welcome Update a welcome message for a domain

v1_create_domain_welcome_message

DomainWelcomeMessageResponseV1 v1_create_domain_welcome_message(create_domain_welcome_message_body)

Create a welcome message for a domain

Creates a new welcome message for the authenticated user's domain admin, or updates the existing one. The message is sanitized to prevent XSS.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.create_domain_welcome_message_body import CreateDomainWelcomeMessageBody
from corellium.models.domain_welcome_message_response_v1 import DomainWelcomeMessageResponseV1
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.DomainV1Api(api_client)
    create_domain_welcome_message_body = corellium.CreateDomainWelcomeMessageBody() # CreateDomainWelcomeMessageBody | application/json

    try:
        # Create a welcome message for a domain
        api_response = api_instance.v1_create_domain_welcome_message(create_domain_welcome_message_body)
        print("The response of DomainV1Api->v1_create_domain_welcome_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainV1Api->v1_create_domain_welcome_message: %s\n" % e)

Parameters

Name Type Description Notes
create_domain_welcome_message_body CreateDomainWelcomeMessageBody application/json

Return type

DomainWelcomeMessageResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Validation Error -
401 Unauthorized -
500 Internal Server Error -

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

v1_delete_domain_welcome_message

v1_delete_domain_welcome_message()

Delete the welcome message for the authenticated user's domain

Example

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"
)


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

    try:
        # Delete the welcome message for the authenticated user's domain
        api_instance.v1_delete_domain_welcome_message()
    except Exception as e:
        print("Exception when calling DomainV1Api->v1_delete_domain_welcome_message: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -
401 Unauthorized -
404 Not Found -

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

v1_get_domain_welcome_message

DomainWelcomeMessageResponseV1 v1_get_domain_welcome_message()

Get the welcome message for the authenticated user's domain

Retrieves the welcome message for the domain.

Example

import corellium
from corellium.models.domain_welcome_message_response_v1 import DomainWelcomeMessageResponseV1
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.DomainV1Api(api_client)

    try:
        # Get the welcome message for the authenticated user's domain
        api_response = api_instance.v1_get_domain_welcome_message()
        print("The response of DomainV1Api->v1_get_domain_welcome_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainV1Api->v1_get_domain_welcome_message: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DomainWelcomeMessageResponseV1

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

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

v1_update_domain_welcome_message

DomainWelcomeMessageResponseV1 v1_update_domain_welcome_message(update_domain_welcome_message_request)

Update a welcome message for a domain

Updates a new welcome message for the authenticated user's domain admin, or updates the existing one. The message is sanitized to prevent XSS.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.domain_welcome_message_response_v1 import DomainWelcomeMessageResponseV1
from corellium.models.update_domain_welcome_message_request import UpdateDomainWelcomeMessageRequest
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.DomainV1Api(api_client)
    update_domain_welcome_message_request = corellium.UpdateDomainWelcomeMessageRequest() # UpdateDomainWelcomeMessageRequest | application/json

    try:
        # Update a welcome message for a domain
        api_response = api_instance.v1_update_domain_welcome_message(update_domain_welcome_message_request)
        print("The response of DomainV1Api->v1_update_domain_welcome_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainV1Api->v1_update_domain_welcome_message: %s\n" % e)

Parameters

Name Type Description Notes
update_domain_welcome_message_request UpdateDomainWelcomeMessageRequest application/json

Return type

DomainWelcomeMessageResponseV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Validation Error -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

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