Skip to content

Latest commit

 

History

History
1081 lines (758 loc) · 33.9 KB

ProjectsV1Api.md

File metadata and controls

1081 lines (758 loc) · 33.9 KB

corellium.ProjectsV1Api

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_add_project_key POST /v1/projects/{projectId}/keys Add Project Authorized Key
v1_create_project POST /v1/projects Create a Project
v1_delete_project DELETE /v1/projects/{projectId} Delete a Project
v1_get_project GET /v1/projects/{projectId} Get a Project
v1_get_project_instances GET /v1/projects/{projectId}/instances Get Instances in Project
v1_get_project_keys GET /v1/projects/{projectId}/keys Get Project Authorized Keys
v1_get_project_network_log GET /v1/projects/{projectId}/network/log Retrieve the network connection log for a project
v1_get_project_network_status GET /v1/projects/{projectId}/network/status Retrieve the network connection status for a project
v1_get_project_vpn_config GET /v1/projects/{projectId}/vpnconfig/{format} Get Project VPN Configuration
v1_get_projects GET /v1/projects Get Projects
v1_remove_project_key DELETE /v1/projects/{projectId}/keys/{keyId} Delete Project Authorized Key
v1_update_project PATCH /v1/projects/{projectId} Update a Project
v1_update_project_settings PATCH /v1/projects/{projectId}/settings Change Project Settings

v1_add_project_key

ProjectKeyV1 v1_add_project_key(project_id, project_key_v1)

Add Project Authorized Key

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_key_v1 import ProjectKeyV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    project_key_v1 = {
  "kind": "ssh",
  "label": "My New Key",
  "key": "ssh-ed25519 <key>"
} # ProjectKeyV1 | Key to add

    try:
        # Add Project Authorized Key
        api_response = api_instance.v1_add_project_key(project_id, project_key_v1)
        print("The response of ProjectsV1Api->v1_add_project_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_add_project_key: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
project_key_v1 ProjectKeyV1 Key to add

Return type

ProjectKeyV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Authorized Key -
403 Forbidden -

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

v1_create_project

ProjectV1 v1_create_project(project_v1)

Create a Project

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_v1 import ProjectV1
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.ProjectsV1Api(api_client)
    project_v1 = {
  "name": "New Project",
  "settings": {
    "internet-access": true
  },
  "quotas": {
    "cores": 8,
    "instances": 2,
    "ram": 16384
  }
} # ProjectV1 | Project

    try:
        # Create a Project
        api_response = api_instance.v1_create_project(project_v1)
        print("The response of ProjectsV1Api->v1_create_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_create_project: %s\n" % e)

Parameters

Name Type Description Notes
project_v1 ProjectV1 Project

Return type

ProjectV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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

v1_delete_project

v1_delete_project(project_id)

Delete a Project

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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid

    try:
        # Delete a Project
        api_instance.v1_delete_project(project_id)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_delete_project: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid

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 OK -
403 Forbidden -

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

v1_get_project

ProjectWithKeysV1 v1_get_project(project_id)

Get a Project

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_with_keys_v1 import ProjectWithKeysV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid

    try:
        # Get a Project
        api_response = api_instance.v1_get_project(project_id)
        print("The response of ProjectsV1Api->v1_get_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid

Return type

ProjectWithKeysV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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

v1_get_project_instances

List[InstanceV1] v1_get_project_instances(project_id, name=name, return_attr=return_attr)

Get Instances in Project

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.instance_v1 import InstanceV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    name = 'name_example' # str | Filter by project name (optional)
    return_attr = ['return_attr_example'] # List[str] | Attributes to include in instance return (optional)

    try:
        # Get Instances in Project
        api_response = api_instance.v1_get_project_instances(project_id, name=name, return_attr=return_attr)
        print("The response of ProjectsV1Api->v1_get_project_instances:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project_instances: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
name str Filter by project name [optional]
return_attr List[str] Attributes to include in instance return [optional]

Return type

List[InstanceV1]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -

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

v1_get_project_keys

List[ProjectKeyV1] v1_get_project_keys(project_id)

Get Project Authorized Keys

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_key_v1 import ProjectKeyV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid

    try:
        # Get Project Authorized Keys
        api_response = api_instance.v1_get_project_keys(project_id)
        print("The response of ProjectsV1Api->v1_get_project_keys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project_keys: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid

Return type

List[ProjectKeyV1]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Authorized Keys -
403 Forbidden -

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

v1_get_project_network_log

str v1_get_project_network_log(project_id)

Retrieve the network connection log for a project

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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID (must be a valid UUID)

    try:
        # Retrieve the network connection log for a project
        api_response = api_instance.v1_get_project_network_log(project_id)
        print("The response of ProjectsV1Api->v1_get_project_network_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project_network_log: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID (must be a valid UUID)

Return type

str

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
503 Service Unavailable -

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

v1_get_project_network_status

NetworkStatusResponse v1_get_project_network_status(project_id)

Retrieve the network connection status for a project

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.network_status_response import NetworkStatusResponse
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid

    try:
        # Retrieve the network connection status for a project
        api_response = api_instance.v1_get_project_network_status(project_id)
        print("The response of ProjectsV1Api->v1_get_project_network_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project_network_status: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid

Return type

NetworkStatusResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -

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

v1_get_project_vpn_config

str v1_get_project_vpn_config(project_id, format)

Get Project VPN Configuration

A Project VPN allows connection into virtual devices in the project (e.g., connecting a researcher's computer as a VPN client to a virtual device within the project). If a Project VPN has been defined, this will return the configuration.

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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    format = 'format_example' # str | VPN Config format

    try:
        # Get Project VPN Configuration
        api_response = api_instance.v1_get_project_vpn_config(project_id, format)
        print("The response of ProjectsV1Api->v1_get_project_vpn_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_project_vpn_config: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
format str VPN Config format

Return type

str

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OpenVPN Configuration -
400 Bad Request -
403 Forbidden -

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

v1_get_projects

List[ProjectWithKeysV1] v1_get_projects(name=name, ids_only=ids_only)

Get Projects

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_with_keys_v1 import ProjectWithKeysV1
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.ProjectsV1Api(api_client)
    name = 'name_example' # str | Filter by project name (optional)
    ids_only = True # bool | Only include id of project in results (optional)

    try:
        # Get Projects
        api_response = api_instance.v1_get_projects(name=name, ids_only=ids_only)
        print("The response of ProjectsV1Api->v1_get_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_get_projects: %s\n" % e)

Parameters

Name Type Description Notes
name str Filter by project name [optional]
ids_only bool Only include id of project in results [optional]

Return type

List[ProjectWithKeysV1]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Projects -
403 Forbidden -
404 No Projects Found -

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

v1_remove_project_key

v1_remove_project_key(project_id, key_id)

Delete Project Authorized Key

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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    key_id = 'key_id_example' # str | Key ID - uuid

    try:
        # Delete Project Authorized Key
        api_instance.v1_remove_project_key(project_id, key_id)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_remove_project_key: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
key_id str Key ID - uuid

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 Deleted -
403 Forbidden -
404 Not found -

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

v1_update_project

ProjectV1 v1_update_project(project_id, project_v1)

Update a Project

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_v1 import ProjectV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    project_v1 = corellium.ProjectV1() # ProjectV1 | Updated Project Settings

    try:
        # Update a Project
        api_response = api_instance.v1_update_project(project_id, project_v1)
        print("The response of ProjectsV1Api->v1_update_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_update_project: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
project_v1 ProjectV1 Updated Project Settings

Return type

ProjectV1

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -

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

v1_update_project_settings

v1_update_project_settings(project_id, project_settings_v1)

Change Project Settings

Example

  • Bearer (JWT) Authentication (BearerAuth):
import corellium
from corellium.models.project_settings_v1 import ProjectSettingsV1
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.ProjectsV1Api(api_client)
    project_id = 'project_id_example' # str | Project ID - uuid
    project_settings_v1 = corellium.ProjectSettingsV1() # ProjectSettingsV1 | New settings

    try:
        # Change Project Settings
        api_instance.v1_update_project_settings(project_id, project_settings_v1)
    except Exception as e:
        print("Exception when calling ProjectsV1Api->v1_update_project_settings: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID - uuid
project_settings_v1 ProjectSettingsV1 New settings

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Success -
400 Validation Error -
403 Forbidden -

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