DefaultApi

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_create_asset

AssetSchema src_app_api_assets_create_asset(asset_create_schema)

Create Asset

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_create_schema import AssetCreateSchema
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    asset_create_schema = cyberwave.rest.AssetCreateSchema() # AssetCreateSchema | 

    try:
        # Create Asset
        api_response = api_instance.src_app_api_assets_create_asset(asset_create_schema)
        print("The response of DefaultApi->src_app_api_assets_create_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_create_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_create_schema	AssetCreateSchema

Return type

AssetSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_create_asset_with_urdf

src_app_api_assets_create_asset_with_urdf(asset_create_with_urdf_schema)

Create Asset With Urdf

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_create_with_urdf_schema import AssetCreateWithURDFSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    asset_create_with_urdf_schema = cyberwave.rest.AssetCreateWithURDFSchema() # AssetCreateWithURDFSchema | 

    try:
        # Create Asset With Urdf
        api_instance.src_app_api_assets_create_asset_with_urdf(asset_create_with_urdf_schema)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_create_asset_with_urdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_create_with_urdf_schema	AssetCreateWithURDFSchema

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_delete_asset

src_app_api_assets_delete_asset(uuid)

Delete Asset

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Asset
        api_instance.src_app_api_assets_delete_asset(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_delete_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_get_asset

AssetSchema src_app_api_assets_get_asset(uuid)

Get Asset

Example

import cyberwave.rest
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Asset
        api_response = api_instance.src_app_api_assets_get_asset(uuid)
        print("The response of DefaultApi->src_app_api_assets_get_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_get_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

AssetSchema

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_assets_get_asset_kinematics

Dict[str, object] src_app_api_assets_get_asset_kinematics(uuid)

Get Asset Kinematics

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Asset Kinematics
        api_response = api_instance.src_app_api_assets_get_asset_kinematics(uuid)
        print("The response of DefaultApi->src_app_api_assets_get_asset_kinematics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_get_asset_kinematics: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_get_popular_tags

PopularTagsResponseSchema src_app_api_assets_get_popular_tags()

Get Popular Tags Get the most popular tags from asset metadata. Results are cached for 1 hour for performance.

Example

import cyberwave.rest
from cyberwave.rest.models.popular_tags_response_schema import PopularTagsResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # Get Popular Tags
        api_response = api_instance.src_app_api_assets_get_popular_tags()
        print("The response of DefaultApi->src_app_api_assets_get_popular_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_get_popular_tags: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PopularTagsResponseSchema

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_assets_initiate_large_glb_upload

InitiateLargeUploadResponse src_app_api_assets_initiate_large_glb_upload(uuid, initiate_large_upload_schema)

Initiate Large Glb Upload Initiate a large GLB file upload for an asset using Google Cloud signed URLs. This endpoint supports GLB files larger than 32MB.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.initiate_large_upload_response import InitiateLargeUploadResponse
from cyberwave.rest.models.initiate_large_upload_schema import InitiateLargeUploadSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    initiate_large_upload_schema = cyberwave.rest.InitiateLargeUploadSchema() # InitiateLargeUploadSchema | 

    try:
        # Initiate Large Glb Upload
        api_response = api_instance.src_app_api_assets_initiate_large_glb_upload(uuid, initiate_large_upload_schema)
        print("The response of DefaultApi->src_app_api_assets_initiate_large_glb_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_initiate_large_glb_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
initiate_large_upload_schema	InitiateLargeUploadSchema

Return type

InitiateLargeUploadResponse

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_list_assets

List[AssetSchema] src_app_api_assets_list_assets()

List Assets

Example

import cyberwave.rest
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Assets
        api_response = api_instance.src_app_api_assets_list_assets()
        print("The response of DefaultApi->src_app_api_assets_list_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_list_assets: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[AssetSchema]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_assets_llm_generation

LLMResponseSchema src_app_api_assets_llm_generation(uuid, llm_generation_schema)

Llm Generation

Example

import cyberwave.rest
from cyberwave.rest.models.llm_generation_schema import LLMGenerationSchema
from cyberwave.rest.models.llm_response_schema import LLMResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    llm_generation_schema = cyberwave.rest.LLMGenerationSchema() # LLMGenerationSchema | 

    try:
        # Llm Generation
        api_response = api_instance.src_app_api_assets_llm_generation(uuid, llm_generation_schema)
        print("The response of DefaultApi->src_app_api_assets_llm_generation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_llm_generation: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
llm_generation_schema	LLMGenerationSchema

Return type

LLMResponseSchema

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_assets_set_glb_from_attachment

AssetSchema src_app_api_assets_set_glb_from_attachment(uuid, asset_glb_from_attachment_schema)

Set Glb From Attachment Set an asset’s GLB file from an existing attachment. This is useful for processing workflows where an uploaded attachment gets converted/processed into the main GLB visualization file.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_glb_from_attachment_schema import AssetGLBFromAttachmentSchema
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    asset_glb_from_attachment_schema = cyberwave.rest.AssetGLBFromAttachmentSchema() # AssetGLBFromAttachmentSchema | 

    try:
        # Set Glb From Attachment
        api_response = api_instance.src_app_api_assets_set_glb_from_attachment(uuid, asset_glb_from_attachment_schema)
        print("The response of DefaultApi->src_app_api_assets_set_glb_from_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_set_glb_from_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
asset_glb_from_attachment_schema	AssetGLBFromAttachmentSchema

Return type

AssetSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_update_asset

AssetUpdateSchema src_app_api_assets_update_asset(uuid, asset_update_schema)

Update Asset

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_update_schema import AssetUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    asset_update_schema = cyberwave.rest.AssetUpdateSchema() # AssetUpdateSchema | 

    try:
        # Update Asset
        api_response = api_instance.src_app_api_assets_update_asset(uuid, asset_update_schema)
        print("The response of DefaultApi->src_app_api_assets_update_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_update_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
asset_update_schema	AssetUpdateSchema

Return type

AssetUpdateSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_upload_glb

AssetSchema src_app_api_assets_upload_glb(uuid, file)

Upload Glb

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    file = None # bytearray | 

    try:
        # Upload Glb
        api_response = api_instance.src_app_api_assets_upload_glb(uuid, file)
        print("The response of DefaultApi->src_app_api_assets_upload_glb:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_upload_glb: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
file	bytearray

Return type

AssetSchema

Authorization

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

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_upload_thumbnail_file

AssetSchema src_app_api_assets_upload_thumbnail_file(uuid, file)

Upload Thumbnail File

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.asset_schema import AssetSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    file = None # bytearray | 

    try:
        # Upload Thumbnail File
        api_response = api_instance.src_app_api_assets_upload_thumbnail_file(uuid, file)
        print("The response of DefaultApi->src_app_api_assets_upload_thumbnail_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_upload_thumbnail_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
file	bytearray

Return type

AssetSchema

Authorization

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

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_assets_vlm_generation

VLMResponseSchema src_app_api_assets_vlm_generation(uuid, vlm_generation_schema)

Vlm Generation Generate a response using a Vision Language Model (VLM) with the given prompt and image. This endpoint uses Google’s Gemini 2.5 Pro vision model to analyze images and generate text responses based on the provided prompt. Args: request: The HTTP request uuid: The asset UUID (currently unused but kept for API consistency) payload: Contains the prompt and image_url to analyze Returns: VLMResponseSchema with the model’s text response

Example

import cyberwave.rest
from cyberwave.rest.models.vlm_generation_schema import VLMGenerationSchema
from cyberwave.rest.models.vlm_response_schema import VLMResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    vlm_generation_schema = cyberwave.rest.VLMGenerationSchema() # VLMGenerationSchema | 

    try:
        # Vlm Generation
        api_response = api_instance.src_app_api_assets_vlm_generation(uuid, vlm_generation_schema)
        print("The response of DefaultApi->src_app_api_assets_vlm_generation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_assets_vlm_generation: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
vlm_generation_schema	VLMGenerationSchema

Return type

VLMResponseSchema

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_attachments_complete_large_attachment_upload

AttachmentSchema src_app_api_attachments_complete_large_attachment_upload(uuid, complete_large_upload_schema)

Complete Large Attachment Upload Complete a large file upload for an attachment. This marks the uploaded file as the attachment’s file.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.models.complete_large_upload_schema import CompleteLargeUploadSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    complete_large_upload_schema = cyberwave.rest.CompleteLargeUploadSchema() # CompleteLargeUploadSchema | 

    try:
        # Complete Large Attachment Upload
        api_response = api_instance.src_app_api_attachments_complete_large_attachment_upload(uuid, complete_large_upload_schema)
        print("The response of DefaultApi->src_app_api_attachments_complete_large_attachment_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_complete_large_attachment_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
complete_large_upload_schema	CompleteLargeUploadSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_create_attachment

AttachmentSchema src_app_api_attachments_create_attachment(attachment_create_schema)

Create Attachment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_create_schema import AttachmentCreateSchema
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    attachment_create_schema = cyberwave.rest.AttachmentCreateSchema() # AttachmentCreateSchema | 

    try:
        # Create Attachment
        api_response = api_instance.src_app_api_attachments_create_attachment(attachment_create_schema)
        print("The response of DefaultApi->src_app_api_attachments_create_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_create_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
attachment_create_schema	AttachmentCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_delete_attachment

src_app_api_attachments_delete_attachment(uuid)

Delete Attachment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Attachment
        api_instance.src_app_api_attachments_delete_attachment(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_delete_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_get_attachment

AttachmentSchema src_app_api_attachments_get_attachment(uuid)

Get Attachment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Attachment
        api_response = api_instance.src_app_api_attachments_get_attachment(uuid)
        print("The response of DefaultApi->src_app_api_attachments_get_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_get_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_initiate_large_attachment_upload

InitiateLargeUploadResponse src_app_api_attachments_initiate_large_attachment_upload(uuid, initiate_large_upload_schema)

Initiate Large Attachment Upload Initiate a large file upload for an attachment using Google Cloud signed URLs. This endpoint supports files larger than 32MB.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.initiate_large_upload_response import InitiateLargeUploadResponse
from cyberwave.rest.models.initiate_large_upload_schema import InitiateLargeUploadSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    initiate_large_upload_schema = cyberwave.rest.InitiateLargeUploadSchema() # InitiateLargeUploadSchema | 

    try:
        # Initiate Large Attachment Upload
        api_response = api_instance.src_app_api_attachments_initiate_large_attachment_upload(uuid, initiate_large_upload_schema)
        print("The response of DefaultApi->src_app_api_attachments_initiate_large_attachment_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_initiate_large_attachment_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
initiate_large_upload_schema	InitiateLargeUploadSchema

Return type

InitiateLargeUploadResponse

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_list_attachments

List[AttachmentSchema] src_app_api_attachments_list_attachments()

List Attachments

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Attachments
        api_response = api_instance.src_app_api_attachments_list_attachments()
        print("The response of DefaultApi->src_app_api_attachments_list_attachments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_list_attachments: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[AttachmentSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_update_attachment

AttachmentSchema src_app_api_attachments_update_attachment(uuid, attachment_create_schema)

Update Attachment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_create_schema import AttachmentCreateSchema
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    attachment_create_schema = cyberwave.rest.AttachmentCreateSchema() # AttachmentCreateSchema | 

    try:
        # Update Attachment
        api_response = api_instance.src_app_api_attachments_update_attachment(uuid, attachment_create_schema)
        print("The response of DefaultApi->src_app_api_attachments_update_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_update_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
attachment_create_schema	AttachmentCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_attachments_upload_attachment

AttachmentSchema src_app_api_attachments_upload_attachment(uuid, file)

Upload Attachment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.attachment_schema import AttachmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    file = None # bytearray | 

    try:
        # Upload Attachment
        api_response = api_instance.src_app_api_attachments_upload_attachment(uuid, file)
        print("The response of DefaultApi->src_app_api_attachments_upload_attachment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_attachments_upload_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
file	bytearray

Return type

Authorization

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

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_contact_contact_form

src_app_api_contact_contact_form(contact_form_schema)

Contact Form

Example

import cyberwave.rest
from cyberwave.rest.models.contact_form_schema import ContactFormSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    contact_form_schema = cyberwave.rest.ContactFormSchema() # ContactFormSchema | 

    try:
        # Contact Form
        api_instance.src_app_api_contact_contact_form(contact_form_schema)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_contact_contact_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
contact_form_schema	ContactFormSchema

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_app_api_edges_create_edge

EdgeSchema src_app_api_edges_create_edge(edge_create_schema)

Create Edge

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.edge_create_schema import EdgeCreateSchema
from cyberwave.rest.models.edge_schema import EdgeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    edge_create_schema = cyberwave.rest.EdgeCreateSchema() # EdgeCreateSchema | 

    try:
        # Create Edge
        api_response = api_instance.src_app_api_edges_create_edge(edge_create_schema)
        print("The response of DefaultApi->src_app_api_edges_create_edge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_edges_create_edge: %s\n" % e)

Parameters

Name	Type	Description	Notes
edge_create_schema	EdgeCreateSchema

Return type

EdgeSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_edges_delete_edge

src_app_api_edges_delete_edge(uuid)

Delete Edge

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Edge
        api_instance.src_app_api_edges_delete_edge(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_edges_delete_edge: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_edges_get_edge

EdgeSchema src_app_api_edges_get_edge(uuid)

Get Edge

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.edge_schema import EdgeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Edge
        api_response = api_instance.src_app_api_edges_get_edge(uuid)
        print("The response of DefaultApi->src_app_api_edges_get_edge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_edges_get_edge: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

EdgeSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_edges_get_edges

List[EdgeSchema] src_app_api_edges_get_edges()

Get Edges

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.edge_schema import EdgeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[EdgeSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_edges_update_edge

EdgeSchema src_app_api_edges_update_edge(uuid, edge_create_schema)

Update Edge

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.edge_create_schema import EdgeCreateSchema
from cyberwave.rest.models.edge_schema import EdgeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    edge_create_schema = cyberwave.rest.EdgeCreateSchema() # EdgeCreateSchema | 

    try:
        # Update Edge
        api_response = api_instance.src_app_api_edges_update_edge(uuid, edge_create_schema)
        print("The response of DefaultApi->src_app_api_edges_update_edge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_edges_update_edge: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
edge_create_schema	EdgeCreateSchema

Return type

EdgeSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_cancel_environment_invitation

Dict[str, object] src_app_api_environments_cancel_environment_invitation(invitation_uuid)

Cancel Environment Invitation Cancel a pending invitation

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    invitation_uuid = 'invitation_uuid_example' # str | 

    try:
        # Cancel Environment Invitation
        api_response = api_instance.src_app_api_environments_cancel_environment_invitation(invitation_uuid)
        print("The response of DefaultApi->src_app_api_environments_cancel_environment_invitation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_cancel_environment_invitation: %s\n" % e)

Parameters

Name	Type	Description	Notes
invitation_uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_create_environment_for_project

EnvironmentSchema src_app_api_environments_create_environment_for_project(project_uuid, environment_create_schema)

Create Environment For Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_create_schema import EnvironmentCreateSchema
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    project_uuid = 'project_uuid_example' # str | 
    environment_create_schema = cyberwave.rest.EnvironmentCreateSchema() # EnvironmentCreateSchema | 

    try:
        # Create Environment For Project
        api_response = api_instance.src_app_api_environments_create_environment_for_project(project_uuid, environment_create_schema)
        print("The response of DefaultApi->src_app_api_environments_create_environment_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_create_environment_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uuid	str
environment_create_schema	EnvironmentCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_create_environment_link

Dict[str, object] src_app_api_environments_create_environment_link(uuid)

Create Environment Link Create a shareable link for an environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Create Environment Link
        api_response = api_instance.src_app_api_environments_create_environment_link(uuid)
        print("The response of DefaultApi->src_app_api_environments_create_environment_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_create_environment_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_create_environment_simulation

Dict[str, object] src_app_api_environments_create_environment_simulation(uuid, payload)

Create Environment Simulation

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    payload = None # Dict[str, object] | 

    try:
        # Create Environment Simulation
        api_response = api_instance.src_app_api_environments_create_environment_simulation(uuid, payload)
        print("The response of DefaultApi->src_app_api_environments_create_environment_simulation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_create_environment_simulation: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
payload	Dict[str, object]

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_create_standalone_environment

EnvironmentSchema src_app_api_environments_create_standalone_environment(environment_create_schema)

Create Standalone Environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_create_schema import EnvironmentCreateSchema
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    environment_create_schema = cyberwave.rest.EnvironmentCreateSchema() # EnvironmentCreateSchema | 

    try:
        # Create Standalone Environment
        api_response = api_instance.src_app_api_environments_create_standalone_environment(environment_create_schema)
        print("The response of DefaultApi->src_app_api_environments_create_standalone_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_create_standalone_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
environment_create_schema	EnvironmentCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_delete_dataset

Dict[str, object] src_app_api_environments_delete_dataset(uuid, dataset_uuid)

Delete Dataset Delete a dataset.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    dataset_uuid = 'dataset_uuid_example' # str | 

    try:
        # Delete Dataset
        api_response = api_instance.src_app_api_environments_delete_dataset(uuid, dataset_uuid)
        print("The response of DefaultApi->src_app_api_environments_delete_dataset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_delete_dataset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
dataset_uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_delete_environment_for_project

src_app_api_environments_delete_environment_for_project(project_uuid, uuid)

Delete Environment For Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    project_uuid = 'project_uuid_example' # str | 
    uuid = 'uuid_example' # str | 

    try:
        # Delete Environment For Project
        api_instance.src_app_api_environments_delete_environment_for_project(project_uuid, uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_delete_environment_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uuid	str
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_generate_combined_telemetry_dataset

DatasetGenerationResponseSchema src_app_api_environments_generate_combined_telemetry_dataset(uuid, combined_dataset_generation_request_schema)

Generate Combined Telemetry Dataset Generate a combined Parquet dataset containing telemetry data for multiple twins. Payload should contain:

twin_uuids: List of twin UUIDs
start_timestamp: Start timestamp of the session (microseconds)
end_timestamp: End timestamp of the session (microseconds)

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.combined_dataset_generation_request_schema import CombinedDatasetGenerationRequestSchema
from cyberwave.rest.models.dataset_generation_response_schema import DatasetGenerationResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    combined_dataset_generation_request_schema = cyberwave.rest.CombinedDatasetGenerationRequestSchema() # CombinedDatasetGenerationRequestSchema | 

    try:
        # Generate Combined Telemetry Dataset
        api_response = api_instance.src_app_api_environments_generate_combined_telemetry_dataset(uuid, combined_dataset_generation_request_schema)
        print("The response of DefaultApi->src_app_api_environments_generate_combined_telemetry_dataset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_generate_combined_telemetry_dataset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
combined_dataset_generation_request_schema	CombinedDatasetGenerationRequestSchema

Return type

DatasetGenerationResponseSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_generate_telemetry_dataset

DatasetGenerationResponseSchema src_app_api_environments_generate_telemetry_dataset(uuid, payload)

Generate Telemetry Dataset Generate a Parquet dataset containing telemetry data for a specific session. Payload should contain:

twin_uuid: UUID of the twin
start_timestamp: Start timestamp of the session (microseconds)
end_timestamp: End timestamp of the session (microseconds)

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.dataset_generation_response_schema import DatasetGenerationResponseSchema
from cyberwave.rest.models.payload import Payload
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    payload = cyberwave.rest.Payload() # Payload | 

    try:
        # Generate Telemetry Dataset
        api_response = api_instance.src_app_api_environments_generate_telemetry_dataset(uuid, payload)
        print("The response of DefaultApi->src_app_api_environments_generate_telemetry_dataset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_generate_telemetry_dataset: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
payload	Payload

Return type

DatasetGenerationResponseSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_dataset_data

Dict[str, object] src_app_api_environments_get_dataset_data(uuid, dataset_uuid, sample_rate_hz=sample_rate_hz)

Get Dataset Data Get sampled dataset data for visualization. Returns timestamps and observation states sampled at the specified rate.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    dataset_uuid = 'dataset_uuid_example' # str | 
    sample_rate_hz = 5 # int |  (optional) (default to 5)

    try:
        # Get Dataset Data
        api_response = api_instance.src_app_api_environments_get_dataset_data(uuid, dataset_uuid, sample_rate_hz=sample_rate_hz)
        print("The response of DefaultApi->src_app_api_environments_get_dataset_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_dataset_data: %s\n" % e)

Parameters

Name	Type	Notes
uuid	str
dataset_uuid	str
sample_rate_hz	int	[optional] [default to 5]

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment

EnvironmentSchema src_app_api_environments_get_environment(uuid)

Get Environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment
        api_response = api_instance.src_app_api_environments_get_environment(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_invitations

Dict[str, object] src_app_api_environments_get_environment_invitations(uuid)

Get Environment Invitations Get pending invitations for an environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Invitations
        api_response = api_instance.src_app_api_environments_get_environment_invitations(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment_invitations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_invitations: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_mujoco_scene

src_app_api_environments_get_environment_mujoco_scene(uuid)

Get Environment Mujoco Scene Get MuJoCo scene zip file for an environment. Returns cached URL if available, otherwise triggers async generation.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Mujoco Scene
        api_instance.src_app_api_environments_get_environment_mujoco_scene(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_mujoco_scene: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_mujoco_scene_xml

src_app_api_environments_get_environment_mujoco_scene_xml(uuid)

Get Environment Mujoco Scene Xml Get self-contained MuJoCo scene xml for an environment. Note: will not contain any assets (visual/collision meshes, textures, etc.)

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Mujoco Scene Xml
        api_instance.src_app_api_environments_get_environment_mujoco_scene_xml(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_mujoco_scene_xml: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_recordings

List[TwinTelemetryMetadataSchema] src_app_api_environments_get_environment_recordings(uuid)

Get Environment Recordings Get all available datasets for an environment. Returns list of dataset metadata excluding the dataset_path.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_telemetry_metadata_schema import TwinTelemetryMetadataSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Recordings
        api_response = api_instance.src_app_api_environments_get_environment_recordings(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment_recordings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_recordings: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

List[TwinTelemetryMetadataSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_sessions

Dict[str, object] src_app_api_environments_get_environment_sessions(uuid, recording_by_day=recording_by_day)

Get Environment Sessions Get sessions grouped by overlapping time periods across all twins in the environment. Returns sessions where multiple twins recorded simultaneously. If the query parameter “recording_by_day” is true, return the session available for the environment by day.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    recording_by_day = False # bool |  (optional) (default to False)

    try:
        # Get Environment Sessions
        api_response = api_instance.src_app_api_environments_get_environment_sessions(uuid, recording_by_day=recording_by_day)
        print("The response of DefaultApi->src_app_api_environments_get_environment_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_sessions: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
recording_by_day	bool		[optional] [default to False]

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

Dict[str, object] src_app_api_environments_get_environment_sharing_info_endpoint(uuid)

Get Environment Sharing Info Endpoint Get environment sharing and ACL information

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Sharing Info Endpoint
        api_response = api_instance.src_app_api_environments_get_environment_sharing_info_endpoint(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment_sharing_info_endpoint:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_sharing_info_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_simulations

Dict[str, object] src_app_api_environments_get_environment_simulations(uuid)

Get Environment Simulations

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Simulations
        api_response = api_instance.src_app_api_environments_get_environment_simulations(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment_simulations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_simulations: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_environment_twins

List[TwinSchema] src_app_api_environments_get_environment_twins(uuid)

Get Environment Twins

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Environment Twins
        api_response = api_instance.src_app_api_environments_get_environment_twins(uuid)
        print("The response of DefaultApi->src_app_api_environments_get_environment_twins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_environment_twins: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

List[TwinSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_get_twins_sessions

Dict[str, object] src_app_api_environments_get_twins_sessions(uuid, recording_by_day=recording_by_day)

Get Twins Sessions Get recording sessions (periods between start/end events) for twins in the environment. Returns sessions grouped by twin. If the query parameter “recording_by_day” is true, return the daily session available for the environment.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    recording_by_day = False # bool |  (optional) (default to False)

    try:
        # Get Twins Sessions
        api_response = api_instance.src_app_api_environments_get_twins_sessions(uuid, recording_by_day=recording_by_day)
        print("The response of DefaultApi->src_app_api_environments_get_twins_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_get_twins_sessions: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
recording_by_day	bool		[optional] [default to False]

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_invite_user_to_environment

Dict[str, object] src_app_api_environments_invite_user_to_environment(uuid)

Invite User To Environment Invite a non-existent user to an environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Invite User To Environment
        api_response = api_instance.src_app_api_environments_invite_user_to_environment(uuid)
        print("The response of DefaultApi->src_app_api_environments_invite_user_to_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_invite_user_to_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_list_all_environments

List[EnvironmentSchema] src_app_api_environments_list_all_environments()

List All Environments

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List All Environments
        api_response = api_instance.src_app_api_environments_list_all_environments()
        print("The response of DefaultApi->src_app_api_environments_list_all_environments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_list_all_environments: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[EnvironmentSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_list_environments_for_project

List[EnvironmentSchema] src_app_api_environments_list_environments_for_project(project_uuid)

List Environments For Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    project_uuid = 'project_uuid_example' # str | 

    try:
        # List Environments For Project
        api_response = api_instance.src_app_api_environments_list_environments_for_project(project_uuid)
        print("The response of DefaultApi->src_app_api_environments_list_environments_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_list_environments_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uuid	str

Return type

List[EnvironmentSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_remove_user_from_environment

Dict[str, object] src_app_api_environments_remove_user_from_environment(uuid, user_id)

Remove User From Environment Remove user access from environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    user_id = 'user_id_example' # str | 

    try:
        # Remove User From Environment
        api_response = api_instance.src_app_api_environments_remove_user_from_environment(uuid, user_id)
        print("The response of DefaultApi->src_app_api_environments_remove_user_from_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_remove_user_from_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
user_id	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_reset_environment

Dict[str, object] src_app_api_environments_reset_environment(uuid)

Reset Environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Reset Environment
        api_response = api_instance.src_app_api_environments_reset_environment(uuid)
        print("The response of DefaultApi->src_app_api_environments_reset_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_reset_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_revoke_environment_link

Dict[str, object] src_app_api_environments_revoke_environment_link(uuid)

Revoke Environment Link Revoke a shareable link for an environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Revoke Environment Link
        api_response = api_instance.src_app_api_environments_revoke_environment_link(uuid)
        print("The response of DefaultApi->src_app_api_environments_revoke_environment_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_revoke_environment_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

Dict[str, object] src_app_api_environments_share_environment_with_user(uuid)

Share Environment With User Share environment with a user by email

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Share Environment With User
        api_response = api_instance.src_app_api_environments_share_environment_with_user(uuid)
        print("The response of DefaultApi->src_app_api_environments_share_environment_with_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_share_environment_with_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_stop_environment_simulation

Dict[str, object] src_app_api_environments_stop_environment_simulation(uuid, simulation_id)

Stop Environment Simulation

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    simulation_id = 'simulation_id_example' # str | 

    try:
        # Stop Environment Simulation
        api_response = api_instance.src_app_api_environments_stop_environment_simulation(uuid, simulation_id)
        print("The response of DefaultApi->src_app_api_environments_stop_environment_simulation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_stop_environment_simulation: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
simulation_id	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_update_dataset_metadata

TwinTelemetryMetadataSchema src_app_api_environments_update_dataset_metadata(uuid, dataset_uuid, update_dataset_metadata_schema)

Update Dataset Metadata Update dataset metadata (e.g., session name).

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_telemetry_metadata_schema import TwinTelemetryMetadataSchema
from cyberwave.rest.models.update_dataset_metadata_schema import UpdateDatasetMetadataSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    dataset_uuid = 'dataset_uuid_example' # str | 
    update_dataset_metadata_schema = cyberwave.rest.UpdateDatasetMetadataSchema() # UpdateDatasetMetadataSchema | 

    try:
        # Update Dataset Metadata
        api_response = api_instance.src_app_api_environments_update_dataset_metadata(uuid, dataset_uuid, update_dataset_metadata_schema)
        print("The response of DefaultApi->src_app_api_environments_update_dataset_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_update_dataset_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
dataset_uuid	str
update_dataset_metadata_schema	UpdateDatasetMetadataSchema

Return type

TwinTelemetryMetadataSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_environments_update_environment_for_project

EnvironmentSchema src_app_api_environments_update_environment_for_project(project_uuid, uuid, environment_create_schema)

Update Environment For Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.environment_create_schema import EnvironmentCreateSchema
from cyberwave.rest.models.environment_schema import EnvironmentSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    project_uuid = 'project_uuid_example' # str | 
    uuid = 'uuid_example' # str | 
    environment_create_schema = cyberwave.rest.EnvironmentCreateSchema() # EnvironmentCreateSchema | 

    try:
        # Update Environment For Project
        api_response = api_instance.src_app_api_environments_update_environment_for_project(project_uuid, uuid, environment_create_schema)
        print("The response of DefaultApi->src_app_api_environments_update_environment_for_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_environments_update_environment_for_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_uuid	str
uuid	str
environment_create_schema	EnvironmentCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_invitation_router_accept_invitation_endpoint

Dict[str, object] src_app_api_invitation_router_accept_invitation_endpoint(token)

Accept Invitation Endpoint Accept a user invitation via token

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    token = 'token_example' # str | 

    try:
        # Accept Invitation Endpoint
        api_response = api_instance.src_app_api_invitation_router_accept_invitation_endpoint(token)
        print("The response of DefaultApi->src_app_api_invitation_router_accept_invitation_endpoint:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_invitation_router_accept_invitation_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_invitation_router_get_invitation_info

Dict[str, object] src_app_api_invitation_router_get_invitation_info(token)

Get Invitation Info Get invitation info without accepting it

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    token = 'token_example' # str | 

    try:
        # Get Invitation Info
        api_response = api_instance.src_app_api_invitation_router_get_invitation_info(token)
        print("The response of DefaultApi->src_app_api_invitation_router_get_invitation_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_invitation_router_get_invitation_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_mlmodels_create_mlmodel

MLModelSchema src_app_api_mlmodels_create_mlmodel(ml_model_create_schema)

Create Mlmodel Create a new ML model.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.ml_model_create_schema import MLModelCreateSchema
from cyberwave.rest.models.ml_model_schema import MLModelSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    ml_model_create_schema = cyberwave.rest.MLModelCreateSchema() # MLModelCreateSchema | 

    try:
        # Create Mlmodel
        api_response = api_instance.src_app_api_mlmodels_create_mlmodel(ml_model_create_schema)
        print("The response of DefaultApi->src_app_api_mlmodels_create_mlmodel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_mlmodels_create_mlmodel: %s\n" % e)

Parameters

Name	Type	Description	Notes
ml_model_create_schema	MLModelCreateSchema

Return type

MLModelSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_mlmodels_delete_mlmodel

src_app_api_mlmodels_delete_mlmodel(uuid)

Delete Mlmodel Delete an ML model.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Mlmodel
        api_instance.src_app_api_mlmodels_delete_mlmodel(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_mlmodels_delete_mlmodel: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_mlmodels_get_mlmodel

MLModelSchema src_app_api_mlmodels_get_mlmodel(uuid)

Get Mlmodel Get a specific ML model by UUID.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.ml_model_schema import MLModelSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Mlmodel
        api_response = api_instance.src_app_api_mlmodels_get_mlmodel(uuid)
        print("The response of DefaultApi->src_app_api_mlmodels_get_mlmodel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_mlmodels_get_mlmodel: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

MLModelSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_mlmodels_list_mlmodels

List[MLModelSchema] src_app_api_mlmodels_list_mlmodels()

List Mlmodels List all ML models for the authenticated user’s workspace.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.ml_model_schema import MLModelSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Mlmodels
        api_response = api_instance.src_app_api_mlmodels_list_mlmodels()
        print("The response of DefaultApi->src_app_api_mlmodels_list_mlmodels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_mlmodels_list_mlmodels: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[MLModelSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_mlmodels_update_mlmodel

MLModelSchema src_app_api_mlmodels_update_mlmodel(uuid, ml_model_update_schema)

Update Mlmodel Update an existing ML model.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.ml_model_schema import MLModelSchema
from cyberwave.rest.models.ml_model_update_schema import MLModelUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    ml_model_update_schema = cyberwave.rest.MLModelUpdateSchema() # MLModelUpdateSchema | 

    try:
        # Update Mlmodel
        api_response = api_instance.src_app_api_mlmodels_update_mlmodel(uuid, ml_model_update_schema)
        print("The response of DefaultApi->src_app_api_mlmodels_update_mlmodel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_mlmodels_update_mlmodel: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
ml_model_update_schema	MLModelUpdateSchema

Return type

MLModelSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_create_project

ProjectSchema src_app_api_projects_create_project(project_create_schema)

Create Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_create_schema import ProjectCreateSchema
from cyberwave.rest.models.project_schema import ProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    project_create_schema = cyberwave.rest.ProjectCreateSchema() # ProjectCreateSchema | 

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

Parameters

Name	Type	Description	Notes
project_create_schema	ProjectCreateSchema

Return type

ProjectSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_create_project_link

src_app_api_projects_create_project_link(uuid, link_share_create_schema)

Create Project Link Create a shareable link for a project.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.link_share_create_schema import LinkShareCreateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    link_share_create_schema = cyberwave.rest.LinkShareCreateSchema() # LinkShareCreateSchema | 

    try:
        # Create Project Link
        api_instance.src_app_api_projects_create_project_link(uuid, link_share_create_schema)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_create_project_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
link_share_create_schema	LinkShareCreateSchema

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_delete_project

src_app_api_projects_delete_project(uuid)

Delete Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Project
        api_instance.src_app_api_projects_delete_project(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_delete_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_get_my_project_permissions

PermissionsSchema src_app_api_projects_get_my_project_permissions(uuid)

Get My Project Permissions Get current user’s permissions on this project.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.permissions_schema import PermissionsSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get My Project Permissions
        api_response = api_instance.src_app_api_projects_get_my_project_permissions(uuid)
        print("The response of DefaultApi->src_app_api_projects_get_my_project_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_get_my_project_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

PermissionsSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_get_project

ProjectSchema src_app_api_projects_get_project(uuid)

Get Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_schema import ProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

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

Parameters

Name	Type	Description	Notes
uuid	str

Return type

ProjectSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_get_project_shares

SharesResponseSchema src_app_api_projects_get_project_shares(uuid)

Get Project Shares List all shares for a project.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.shares_response_schema import SharesResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Project Shares
        api_response = api_instance.src_app_api_projects_get_project_shares(uuid)
        print("The response of DefaultApi->src_app_api_projects_get_project_shares:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_get_project_shares: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

SharesResponseSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_invite_user_to_project

Dict[str, object] src_app_api_projects_invite_user_to_project(uuid)

Invite User To Project Invite a non-existent user to a project.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Invite User To Project
        api_response = api_instance.src_app_api_projects_invite_user_to_project(uuid)
        print("The response of DefaultApi->src_app_api_projects_invite_user_to_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_invite_user_to_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_list_projects

List[ProjectSchema] src_app_api_projects_list_projects()

List Projects

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_schema import ProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Projects
        api_response = api_instance.src_app_api_projects_list_projects()
        print("The response of DefaultApi->src_app_api_projects_list_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_list_projects: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[ProjectSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_revoke_project_link

src_app_api_projects_revoke_project_link(uuid, link_share_revoke_schema)

Revoke Project Link Revoke a shareable link.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.link_share_revoke_schema import LinkShareRevokeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    link_share_revoke_schema = cyberwave.rest.LinkShareRevokeSchema() # LinkShareRevokeSchema | 

    try:
        # Revoke Project Link
        api_instance.src_app_api_projects_revoke_project_link(uuid, link_share_revoke_schema)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_revoke_project_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
link_share_revoke_schema	LinkShareRevokeSchema

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

ProjectShareResponseSchema src_app_api_projects_share_project(uuid, share_schema)

Share Project Share a project with a user or team.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_share_response_schema import ProjectShareResponseSchema
from cyberwave.rest.models.share_schema import ShareSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    share_schema = cyberwave.rest.ShareSchema() # ShareSchema | 

    try:
        # Share Project
        api_response = api_instance.src_app_api_projects_share_project(uuid, share_schema)
        print("The response of DefaultApi->src_app_api_projects_share_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_share_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
share_schema	ShareSchema

Return type

ProjectShareResponseSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_unshare_project

ProjectShareResponseSchema src_app_api_projects_unshare_project(uuid, share_schema)

Unshare Project Remove sharing permissions for a user or team.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_share_response_schema import ProjectShareResponseSchema
from cyberwave.rest.models.share_schema import ShareSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    share_schema = cyberwave.rest.ShareSchema() # ShareSchema | 

    try:
        # Unshare Project
        api_response = api_instance.src_app_api_projects_unshare_project(uuid, share_schema)
        print("The response of DefaultApi->src_app_api_projects_unshare_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_unshare_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
share_schema	ShareSchema

Return type

ProjectShareResponseSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_projects_update_project

ProjectSchema src_app_api_projects_update_project(uuid, project_create_schema)

Update Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.project_create_schema import ProjectCreateSchema
from cyberwave.rest.models.project_schema import ProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    project_create_schema = cyberwave.rest.ProjectCreateSchema() # ProjectCreateSchema | 

    try:
        # Update Project
        api_response = api_instance.src_app_api_projects_update_project(uuid, project_create_schema)
        print("The response of DefaultApi->src_app_api_projects_update_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_projects_update_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
project_create_schema	ProjectCreateSchema

Return type

ProjectSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_create_twin

TwinSchema src_app_api_twins_create_twin(twin_create_schema)

Create Twin

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_create_schema import TwinCreateSchema
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    twin_create_schema = cyberwave.rest.TwinCreateSchema() # TwinCreateSchema | 

    try:
        # Create Twin
        api_response = api_instance.src_app_api_twins_create_twin(twin_create_schema)
        print("The response of DefaultApi->src_app_api_twins_create_twin:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_create_twin: %s\n" % e)

Parameters

Name	Type	Description	Notes
twin_create_schema	TwinCreateSchema

Return type

TwinSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_delete_twin

src_app_api_twins_delete_twin(uuid)

Delete Twin

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Twin
        api_instance.src_app_api_twins_delete_twin(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_delete_twin: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_get_twin

TwinSchema src_app_api_twins_get_twin(uuid)

Get Twin

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin
        api_response = api_instance.src_app_api_twins_get_twin(uuid)
        print("The response of DefaultApi->src_app_api_twins_get_twin:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_get_twin: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

TwinSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_get_twin_relationships

List[TwinRelationshipSchema] src_app_api_twins_get_twin_relationships(uuid)

Get Twin Relationships MVP: Generate mock relationships based on twin names and environment

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_relationship_schema import TwinRelationshipSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin Relationships
        api_response = api_instance.src_app_api_twins_get_twin_relationships(uuid)
        print("The response of DefaultApi->src_app_api_twins_get_twin_relationships:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_get_twin_relationships: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

List[TwinRelationshipSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_list_all_twins

List[TwinSchema] src_app_api_twins_list_all_twins()

List All Twins

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List All Twins
        api_response = api_instance.src_app_api_twins_list_all_twins()
        print("The response of DefaultApi->src_app_api_twins_list_all_twins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_list_all_twins: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[TwinSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_update_twin

TwinSchema src_app_api_twins_update_twin(uuid, twin_create_schema)

Update Twin

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_create_schema import TwinCreateSchema
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    twin_create_schema = cyberwave.rest.TwinCreateSchema() # TwinCreateSchema | 

    try:
        # Update Twin
        api_response = api_instance.src_app_api_twins_update_twin(uuid, twin_create_schema)
        print("The response of DefaultApi->src_app_api_twins_update_twin:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_update_twin: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
twin_create_schema	TwinCreateSchema

Return type

TwinSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_twins_update_twin_state

TwinSchema src_app_api_twins_update_twin_state(identifier, twin_state_update_schema)

Update Twin State

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.twin_schema import TwinSchema
from cyberwave.rest.models.twin_state_update_schema import TwinStateUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    identifier = 'identifier_example' # str | 
    twin_state_update_schema = cyberwave.rest.TwinStateUpdateSchema() # TwinStateUpdateSchema | 

    try:
        # Update Twin State
        api_response = api_instance.src_app_api_twins_update_twin_state(identifier, twin_state_update_schema)
        print("The response of DefaultApi->src_app_api_twins_update_twin_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_twins_update_twin_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
identifier	str
twin_state_update_schema	TwinStateUpdateSchema

Return type

TwinSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_create_urdf_project

URDFProjectSchema src_app_api_urdf_create_urdf_project(urdf_project_create_schema)

Create Urdf Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.urdf_project_create_schema import URDFProjectCreateSchema
from cyberwave.rest.models.urdf_project_schema import URDFProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    urdf_project_create_schema = cyberwave.rest.URDFProjectCreateSchema() # URDFProjectCreateSchema | 

    try:
        # Create Urdf Project
        api_response = api_instance.src_app_api_urdf_create_urdf_project(urdf_project_create_schema)
        print("The response of DefaultApi->src_app_api_urdf_create_urdf_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_create_urdf_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
urdf_project_create_schema	URDFProjectCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_delete_urdf_project

src_app_api_urdf_delete_urdf_project(uuid)

Delete Urdf Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Urdf Project
        api_instance.src_app_api_urdf_delete_urdf_project(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_delete_urdf_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_twin_joint_state

JointStateSchema src_app_api_urdf_get_twin_joint_state(uuid, joint_name)

Get Twin Joint State

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.joint_state_schema import JointStateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    joint_name = 'joint_name_example' # str | 

    try:
        # Get Twin Joint State
        api_response = api_instance.src_app_api_urdf_get_twin_joint_state(uuid, joint_name)
        print("The response of DefaultApi->src_app_api_urdf_get_twin_joint_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_twin_joint_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
joint_name	str

Return type

JointStateSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_twin_joint_states

JointStatesSchema src_app_api_urdf_get_twin_joint_states(uuid)

Get Twin Joint States

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.joint_states_schema import JointStatesSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin Joint States
        api_response = api_instance.src_app_api_urdf_get_twin_joint_states(uuid)
        print("The response of DefaultApi->src_app_api_urdf_get_twin_joint_states:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_twin_joint_states: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

JointStatesSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_twin_joints

List[JointSchema] src_app_api_urdf_get_twin_joints(uuid)

Get Twin Joints

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.joint_schema import JointSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin Joints
        api_response = api_instance.src_app_api_urdf_get_twin_joints(uuid)
        print("The response of DefaultApi->src_app_api_urdf_get_twin_joints:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_twin_joints: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

List[JointSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_twin_robot_description

RobotDescriptionSchema src_app_api_urdf_get_twin_robot_description(uuid)

Get Twin Robot Description

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.robot_description_schema import RobotDescriptionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin Robot Description
        api_response = api_instance.src_app_api_urdf_get_twin_robot_description(uuid)
        print("The response of DefaultApi->src_app_api_urdf_get_twin_robot_description:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_twin_robot_description: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

RobotDescriptionSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_twin_urdf_raw

str src_app_api_urdf_get_twin_urdf_raw(uuid)

Get Twin Urdf Raw

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Twin Urdf Raw
        api_response = api_instance.src_app_api_urdf_get_twin_urdf_raw(uuid)
        print("The response of DefaultApi->src_app_api_urdf_get_twin_urdf_raw:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_twin_urdf_raw: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

str

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_get_urdf_project

URDFProjectSchema src_app_api_urdf_get_urdf_project(uuid)

Get Urdf Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.urdf_project_schema import URDFProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Urdf Project
        api_response = api_instance.src_app_api_urdf_get_urdf_project(uuid)
        print("The response of DefaultApi->src_app_api_urdf_get_urdf_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_get_urdf_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_list_urdf_projects

List[URDFProjectSchema] src_app_api_urdf_list_urdf_projects()

List Urdf Projects

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.urdf_project_schema import URDFProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Urdf Projects
        api_response = api_instance.src_app_api_urdf_list_urdf_projects()
        print("The response of DefaultApi->src_app_api_urdf_list_urdf_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_list_urdf_projects: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[URDFProjectSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_update_twin_joint_state

JointStateSchema src_app_api_urdf_update_twin_joint_state(uuid, joint_name, joint_state_update_schema)

Update Twin Joint State

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.joint_state_schema import JointStateSchema
from cyberwave.rest.models.joint_state_update_schema import JointStateUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    joint_name = 'joint_name_example' # str | 
    joint_state_update_schema = cyberwave.rest.JointStateUpdateSchema() # JointStateUpdateSchema | 

    try:
        # Update Twin Joint State
        api_response = api_instance.src_app_api_urdf_update_twin_joint_state(uuid, joint_name, joint_state_update_schema)
        print("The response of DefaultApi->src_app_api_urdf_update_twin_joint_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_update_twin_joint_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
joint_name	str
joint_state_update_schema	JointStateUpdateSchema

Return type

JointStateSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_update_twin_joint_states

JointStatesSchema src_app_api_urdf_update_twin_joint_states(uuid, bulk_joint_states_update_schema)

Update Twin Joint States

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.bulk_joint_states_update_schema import BulkJointStatesUpdateSchema
from cyberwave.rest.models.joint_states_schema import JointStatesSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    bulk_joint_states_update_schema = cyberwave.rest.BulkJointStatesUpdateSchema() # BulkJointStatesUpdateSchema | 

    try:
        # Update Twin Joint States
        api_response = api_instance.src_app_api_urdf_update_twin_joint_states(uuid, bulk_joint_states_update_schema)
        print("The response of DefaultApi->src_app_api_urdf_update_twin_joint_states:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_update_twin_joint_states: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
bulk_joint_states_update_schema	BulkJointStatesUpdateSchema

Return type

JointStatesSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_update_urdf_project

URDFProjectSchema src_app_api_urdf_update_urdf_project(uuid, urdf_project_create_schema)

Update Urdf Project

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.urdf_project_create_schema import URDFProjectCreateSchema
from cyberwave.rest.models.urdf_project_schema import URDFProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    urdf_project_create_schema = cyberwave.rest.URDFProjectCreateSchema() # URDFProjectCreateSchema | 

    try:
        # Update Urdf Project
        api_response = api_instance.src_app_api_urdf_update_urdf_project(uuid, urdf_project_create_schema)
        print("The response of DefaultApi->src_app_api_urdf_update_urdf_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_update_urdf_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
urdf_project_create_schema	URDFProjectCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_urdf_upload_zip_file

URDFProjectSchema src_app_api_urdf_upload_zip_file(uuid, file)

Upload Zip File

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.urdf_project_schema import URDFProjectSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    file = None # bytearray | 

    try:
        # Upload Zip File
        api_response = api_instance.src_app_api_urdf_upload_zip_file(uuid, file)
        print("The response of DefaultApi->src_app_api_urdf_upload_zip_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_urdf_upload_zip_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
file	bytearray

Return type

Authorization

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

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_activate_workflow

WorkflowSchema src_app_api_workflows_activate_workflow(uuid)

Activate Workflow Activate a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Activate Workflow
        api_response = api_instance.src_app_api_workflows_activate_workflow(uuid)
        print("The response of DefaultApi->src_app_api_workflows_activate_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_activate_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_cancel_workflow_execution

WorkflowExecutionSchema src_app_api_workflows_cancel_workflow_execution(execution_uuid)

Cancel Workflow Execution Cancel a running workflow execution.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_execution_schema import WorkflowExecutionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    execution_uuid = 'execution_uuid_example' # str | 

    try:
        # Cancel Workflow Execution
        api_response = api_instance.src_app_api_workflows_cancel_workflow_execution(execution_uuid)
        print("The response of DefaultApi->src_app_api_workflows_cancel_workflow_execution:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_cancel_workflow_execution: %s\n" % e)

Parameters

Name	Type	Description	Notes
execution_uuid	str

Return type

WorkflowExecutionSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_create_workflow

WorkflowSchema src_app_api_workflows_create_workflow(workflow_create_schema)

Create Workflow Create a new workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_create_schema import WorkflowCreateSchema
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_create_schema = cyberwave.rest.WorkflowCreateSchema() # WorkflowCreateSchema | 

    try:
        # Create Workflow
        api_response = api_instance.src_app_api_workflows_create_workflow(workflow_create_schema)
        print("The response of DefaultApi->src_app_api_workflows_create_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_create_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_create_schema	WorkflowCreateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_create_workflow_connection

WorkflowConnectionSchema src_app_api_workflows_create_workflow_connection(workflow_uuid, workflow_connection_create_schema)

Create Workflow Connection Create a new connection between nodes.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_connection_create_schema import WorkflowConnectionCreateSchema
from cyberwave.rest.models.workflow_connection_schema import WorkflowConnectionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    workflow_connection_create_schema = cyberwave.rest.WorkflowConnectionCreateSchema() # WorkflowConnectionCreateSchema | 

    try:
        # Create Workflow Connection
        api_response = api_instance.src_app_api_workflows_create_workflow_connection(workflow_uuid, workflow_connection_create_schema)
        print("The response of DefaultApi->src_app_api_workflows_create_workflow_connection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_create_workflow_connection: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
workflow_connection_create_schema	WorkflowConnectionCreateSchema

Return type

WorkflowConnectionSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_create_workflow_node

WorkflowNodeSchema src_app_api_workflows_create_workflow_node(workflow_uuid, workflow_node_create_schema)

Create Workflow Node Create a new node in a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_node_create_schema import WorkflowNodeCreateSchema
from cyberwave.rest.models.workflow_node_schema import WorkflowNodeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    workflow_node_create_schema = cyberwave.rest.WorkflowNodeCreateSchema() # WorkflowNodeCreateSchema | 

    try:
        # Create Workflow Node
        api_response = api_instance.src_app_api_workflows_create_workflow_node(workflow_uuid, workflow_node_create_schema)
        print("The response of DefaultApi->src_app_api_workflows_create_workflow_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_create_workflow_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
workflow_node_create_schema	WorkflowNodeCreateSchema

Return type

WorkflowNodeSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_deactivate_workflow

WorkflowSchema src_app_api_workflows_deactivate_workflow(uuid)

Deactivate Workflow Deactivate a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Deactivate Workflow
        api_response = api_instance.src_app_api_workflows_deactivate_workflow(uuid)
        print("The response of DefaultApi->src_app_api_workflows_deactivate_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_deactivate_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_delete_workflow

src_app_api_workflows_delete_workflow(uuid)

Delete Workflow Delete a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Workflow
        api_instance.src_app_api_workflows_delete_workflow(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_delete_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_delete_workflow_connection

src_app_api_workflows_delete_workflow_connection(workflow_uuid, connection_uuid)

Delete Workflow Connection Delete a workflow connection.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    connection_uuid = 'connection_uuid_example' # str | 

    try:
        # Delete Workflow Connection
        api_instance.src_app_api_workflows_delete_workflow_connection(workflow_uuid, connection_uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_delete_workflow_connection: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
connection_uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_delete_workflow_node

src_app_api_workflows_delete_workflow_node(workflow_uuid, node_uuid)

Delete Workflow Node Delete a workflow node.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    node_uuid = 'node_uuid_example' # str | 

    try:
        # Delete Workflow Node
        api_instance.src_app_api_workflows_delete_workflow_node(workflow_uuid, node_uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_delete_workflow_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
node_uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_execute_workflow

WorkflowExecutionSchema src_app_api_workflows_execute_workflow(workflow_uuid, workflow_execute_schema)

Execute Workflow Manually trigger a workflow execution.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_execute_schema import WorkflowExecuteSchema
from cyberwave.rest.models.workflow_execution_schema import WorkflowExecutionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    workflow_execute_schema = cyberwave.rest.WorkflowExecuteSchema() # WorkflowExecuteSchema | 

    try:
        # Execute Workflow
        api_response = api_instance.src_app_api_workflows_execute_workflow(workflow_uuid, workflow_execute_schema)
        print("The response of DefaultApi->src_app_api_workflows_execute_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_execute_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
workflow_execute_schema	WorkflowExecuteSchema

Return type

WorkflowExecutionSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_get_node_schema

Dict[str, object] src_app_api_workflows_get_node_schema(node_type, node_subtype=node_subtype)

Get Node Schema Get the schema for a specific node type.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    node_type = 'node_type_example' # str | 
    node_subtype = 'node_subtype_example' # str |  (optional)

    try:
        # Get Node Schema
        api_response = api_instance.src_app_api_workflows_get_node_schema(node_type, node_subtype=node_subtype)
        print("The response of DefaultApi->src_app_api_workflows_get_node_schema:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_get_node_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_type	str
node_subtype	str		[optional]

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_get_node_schemas

List[Dict[str, object]] src_app_api_workflows_get_node_schemas()

Get Node Schemas Get all available node type schemas with their input/output definitions. This is used by the frontend to display available node types and their I/O.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # Get Node Schemas
        api_response = api_instance.src_app_api_workflows_get_node_schemas()
        print("The response of DefaultApi->src_app_api_workflows_get_node_schemas:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_get_node_schemas: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[Dict[str, object]]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_get_workflow

WorkflowSchema src_app_api_workflows_get_workflow(uuid)

Get Workflow Get a specific workflow with its nodes and connections.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Workflow
        api_response = api_instance.src_app_api_workflows_get_workflow(uuid)
        print("The response of DefaultApi->src_app_api_workflows_get_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_get_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_get_workflow_execution

WorkflowExecutionSchema src_app_api_workflows_get_workflow_execution(execution_uuid)

Get Workflow Execution Get details of a specific execution including node executions.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_execution_schema import WorkflowExecutionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    execution_uuid = 'execution_uuid_example' # str | 

    try:
        # Get Workflow Execution
        api_response = api_instance.src_app_api_workflows_get_workflow_execution(execution_uuid)
        print("The response of DefaultApi->src_app_api_workflows_get_workflow_execution:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_get_workflow_execution: %s\n" % e)

Parameters

Name	Type	Description	Notes
execution_uuid	str

Return type

WorkflowExecutionSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_get_workflow_node

WorkflowNodeSchema src_app_api_workflows_get_workflow_node(workflow_uuid, node_uuid)

Get Workflow Node Get a specific node.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_node_schema import WorkflowNodeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    node_uuid = 'node_uuid_example' # str | 

    try:
        # Get Workflow Node
        api_response = api_instance.src_app_api_workflows_get_workflow_node(workflow_uuid, node_uuid)
        print("The response of DefaultApi->src_app_api_workflows_get_workflow_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_get_workflow_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
node_uuid	str

Return type

WorkflowNodeSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_list_workflow_connections

List[WorkflowConnectionSchema] src_app_api_workflows_list_workflow_connections(workflow_uuid)

List Workflow Connections List all connections in a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_connection_schema import WorkflowConnectionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 

    try:
        # List Workflow Connections
        api_response = api_instance.src_app_api_workflows_list_workflow_connections(workflow_uuid)
        print("The response of DefaultApi->src_app_api_workflows_list_workflow_connections:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_list_workflow_connections: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str

Return type

List[WorkflowConnectionSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_list_workflow_executions

List[WorkflowExecutionSchema] src_app_api_workflows_list_workflow_executions(workflow_uuid)

List Workflow Executions List all executions for a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_execution_schema import WorkflowExecutionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 

    try:
        # List Workflow Executions
        api_response = api_instance.src_app_api_workflows_list_workflow_executions(workflow_uuid)
        print("The response of DefaultApi->src_app_api_workflows_list_workflow_executions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_list_workflow_executions: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str

Return type

List[WorkflowExecutionSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_list_workflow_nodes

List[WorkflowNodeSchema] src_app_api_workflows_list_workflow_nodes(workflow_uuid)

List Workflow Nodes List all nodes in a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_node_schema import WorkflowNodeSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 

    try:
        # List Workflow Nodes
        api_response = api_instance.src_app_api_workflows_list_workflow_nodes(workflow_uuid)
        print("The response of DefaultApi->src_app_api_workflows_list_workflow_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_list_workflow_nodes: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str

Return type

List[WorkflowNodeSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_list_workflows

List[WorkflowSchema] src_app_api_workflows_list_workflows()

List Workflows List all workflows for the authenticated user’s workspace.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Workflows
        api_response = api_instance.src_app_api_workflows_list_workflows()
        print("The response of DefaultApi->src_app_api_workflows_list_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_list_workflows: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[WorkflowSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_update_workflow

WorkflowSchema src_app_api_workflows_update_workflow(uuid, workflow_update_schema)

Update Workflow Update a workflow.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_schema import WorkflowSchema
from cyberwave.rest.models.workflow_update_schema import WorkflowUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    workflow_update_schema = cyberwave.rest.WorkflowUpdateSchema() # WorkflowUpdateSchema | 

    try:
        # Update Workflow
        api_response = api_instance.src_app_api_workflows_update_workflow(uuid, workflow_update_schema)
        print("The response of DefaultApi->src_app_api_workflows_update_workflow:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_update_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
workflow_update_schema	WorkflowUpdateSchema

Return type

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_update_workflow_node

WorkflowNodeSchema src_app_api_workflows_update_workflow_node(workflow_uuid, node_uuid, workflow_node_update_schema)

Update Workflow Node Update a workflow node.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workflow_node_schema import WorkflowNodeSchema
from cyberwave.rest.models.workflow_node_update_schema import WorkflowNodeUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    node_uuid = 'node_uuid_example' # str | 
    workflow_node_update_schema = cyberwave.rest.WorkflowNodeUpdateSchema() # WorkflowNodeUpdateSchema | 

    try:
        # Update Workflow Node
        api_response = api_instance.src_app_api_workflows_update_workflow_node(workflow_uuid, node_uuid, workflow_node_update_schema)
        print("The response of DefaultApi->src_app_api_workflows_update_workflow_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_update_workflow_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_uuid	str
node_uuid	str
workflow_node_update_schema	WorkflowNodeUpdateSchema

Return type

WorkflowNodeSchema

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_app_api_workflows_validate_node_inputs

Dict[str, object] src_app_api_workflows_validate_node_inputs(node_uuid)

Validate Node Inputs Validate that a node’s input mappings are complete and correct. Returns validation status and any error messages.

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    node_uuid = 'node_uuid_example' # str | 

    try:
        # Validate Node Inputs
        api_response = api_instance.src_app_api_workflows_validate_node_inputs(node_uuid)
        print("The response of DefaultApi->src_app_api_workflows_validate_node_inputs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_app_api_workflows_validate_node_inputs: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_uuid	str

Return type

Dict[str, object]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_members_leave_team

src_users_api_members_leave_team(team_uuid, uuid)

Leave Team Leave a team

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    team_uuid = 'team_uuid_example' # str | 
    uuid = 'uuid_example' # str | 

    try:
        # Leave Team
        api_instance.src_users_api_members_leave_team(team_uuid, uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_members_leave_team: %s\n" % e)

Parameters

Name	Type	Description	Notes
team_uuid	str
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_members_list_team_members

List[TeamMemberResponse] src_users_api_members_list_team_members(team_uuid)

List Team Members Get the members of a team

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.team_member_response import TeamMemberResponse
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    team_uuid = 'team_uuid_example' # str | 

    try:
        # List Team Members
        api_response = api_instance.src_users_api_members_list_team_members(team_uuid)
        print("The response of DefaultApi->src_users_api_members_list_team_members:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_members_list_team_members: %s\n" % e)

Parameters

Name	Type	Description	Notes
team_uuid	str

Return type

List[TeamMemberResponse]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_members_remove_team_member

src_users_api_members_remove_team_member(team_uuid, uuid)

Remove Team Member Delete a member from a team

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    team_uuid = 'team_uuid_example' # str | 
    uuid = 'uuid_example' # str | 

    try:
        # Remove Team Member
        api_instance.src_users_api_members_remove_team_member(team_uuid, uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_members_remove_team_member: %s\n" % e)

Parameters

Name	Type	Description	Notes
team_uuid	str
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_organizations_delete_organization

src_users_api_organizations_delete_organization(uuid)

Delete Organization Delete an organization

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Organization
        api_instance.src_users_api_organizations_delete_organization(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_organizations_delete_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_organizations_get_organization

Dict[str, OrganizationSchema] src_users_api_organizations_get_organization(uuid)

Get Organization Retrieve an organization

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.organization_schema import OrganizationSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Organization
        api_response = api_instance.src_users_api_organizations_get_organization(uuid)
        print("The response of DefaultApi->src_users_api_organizations_get_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_organizations_get_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Dict[str, OrganizationSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_organizations_get_organization_by_slug

Dict[str, OrganizationSchema] src_users_api_organizations_get_organization_by_slug(slug)

Get Organization By Slug

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.organization_schema import OrganizationSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    slug = 'slug_example' # str | 

    try:
        # Get Organization By Slug
        api_response = api_instance.src_users_api_organizations_get_organization_by_slug(slug)
        print("The response of DefaultApi->src_users_api_organizations_get_organization_by_slug:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_organizations_get_organization_by_slug: %s\n" % e)

Parameters

Name	Type	Description	Notes
slug	str

Return type

Dict[str, OrganizationSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_organizations_list_organizations

Dict[str, List[OrganizationSchema]] src_users_api_organizations_list_organizations()

List Organizations List all organizations

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.organization_schema import OrganizationSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Organizations
        api_response = api_instance.src_users_api_organizations_list_organizations()
        print("The response of DefaultApi->src_users_api_organizations_list_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_organizations_list_organizations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Dict[str, List[OrganizationSchema]]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_organizations_update_organization

Dict[str, OrganizationSchema] src_users_api_organizations_update_organization(uuid, organization_update_schema)

Update Organization Update an organization

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.organization_schema import OrganizationSchema
from cyberwave.rest.models.organization_update_schema import OrganizationUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    organization_update_schema = cyberwave.rest.OrganizationUpdateSchema() # OrganizationUpdateSchema | 

    try:
        # Update Organization
        api_response = api_instance.src_users_api_organizations_update_organization(uuid, organization_update_schema)
        print("The response of DefaultApi->src_users_api_organizations_update_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_organizations_update_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
organization_update_schema	OrganizationUpdateSchema

Return type

Dict[str, OrganizationSchema]

Authorization

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

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_plans_get_plan

PlanSchema src_users_api_plans_get_plan()

Get Plan Get the plan for the current user

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.plan_schema import PlanSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

PlanSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_create_workspace

WorkspaceSchema src_users_api_workspaces_create_workspace()

Create Workspace Create a workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_schema import WorkspaceSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # Create Workspace
        api_response = api_instance.src_users_api_workspaces_create_workspace()
        print("The response of DefaultApi->src_users_api_workspaces_create_workspace:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_create_workspace: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_delete_workspace

src_users_api_workspaces_delete_workspace(uuid)

Delete Workspace Delete a workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Delete Workspace
        api_instance.src_users_api_workspaces_delete_workspace(uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_delete_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_get_default_workspace

WorkspaceSchema src_users_api_workspaces_get_default_workspace()

Get Default Workspace Get the user’s default workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_schema import WorkspaceSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # Get Default Workspace
        api_response = api_instance.src_users_api_workspaces_get_default_workspace()
        print("The response of DefaultApi->src_users_api_workspaces_get_default_workspace:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_get_default_workspace: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_get_vendor_description

VendorDescriptionSchema src_users_api_workspaces_get_vendor_description(slug)

Get Vendor Description Get vendor description by slug (no authentication required)

Example

import cyberwave.rest
from cyberwave.rest.models.vendor_description_schema import VendorDescriptionSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    slug = 'slug_example' # str | 

    try:
        # Get Vendor Description
        api_response = api_instance.src_users_api_workspaces_get_vendor_description(slug)
        print("The response of DefaultApi->src_users_api_workspaces_get_vendor_description:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_get_vendor_description: %s\n" % e)

Parameters

Name	Type	Description	Notes
slug	str

Return type

VendorDescriptionSchema

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

src_users_api_workspaces_get_workspace

WorkspaceResponseSchema src_users_api_workspaces_get_workspace(uuid)

Get Workspace Retrieve a workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_response_schema import WorkspaceResponseSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        # Get Workspace
        api_response = api_instance.src_users_api_workspaces_get_workspace(uuid)
        print("The response of DefaultApi->src_users_api_workspaces_get_workspace:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_get_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

WorkspaceResponseSchema

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_get_workspace_by_slug

WorkspaceSchema src_users_api_workspaces_get_workspace_by_slug(slug)

Get Workspace By Slug Retrieve a workspace by slug (public endpoint)

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_schema import WorkspaceSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    slug = 'slug_example' # str | 

    try:
        # Get Workspace By Slug
        api_response = api_instance.src_users_api_workspaces_get_workspace_by_slug(slug)
        print("The response of DefaultApi->src_users_api_workspaces_get_workspace_by_slug:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_get_workspace_by_slug: %s\n" % e)

Parameters

Name	Type	Description	Notes
slug	str

Return type

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_list_workspaces

List[WorkspaceSchema] src_users_api_workspaces_list_workspaces()

List Workspaces List all workspaces

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_schema import WorkspaceSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)

    try:
        # List Workspaces
        api_response = api_instance.src_users_api_workspaces_list_workspaces()
        print("The response of DefaultApi->src_users_api_workspaces_list_workspaces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_list_workspaces: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[WorkspaceSchema]

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_set_default_workspace

src_users_api_workspaces_set_default_workspace(workspace_uuid)

Set Default Workspace Set the user’s default workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    workspace_uuid = 'workspace_uuid_example' # str | 

    try:
        # Set Default Workspace
        api_instance.src_users_api_workspaces_set_default_workspace(workspace_uuid)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_set_default_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_uuid	str

Return type

void (empty response body)

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

src_users_api_workspaces_update_workspace

WorkspaceSchema src_users_api_workspaces_update_workspace(uuid, workspace_update_schema)

Update Workspace Update a workspace

Example

Api Key Authentication (CustomTokenAuthentication):

import cyberwave.rest
from cyberwave.rest.models.workspace_schema import WorkspaceSchema
from cyberwave.rest.models.workspace_update_schema import WorkspaceUpdateSchema
from cyberwave.rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyberwave.rest.Configuration(
    host = "http://localhost"
)

# 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 API key authorization: CustomTokenAuthentication
configuration.api_key['CustomTokenAuthentication'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomTokenAuthentication'] = 'Bearer'

# Enter a context with an instance of the API client
with cyberwave.rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyberwave.rest.DefaultApi(api_client)
    uuid = 'uuid_example' # str | 
    workspace_update_schema = cyberwave.rest.WorkspaceUpdateSchema() # WorkspaceUpdateSchema | 

    try:
        # Update Workspace
        api_response = api_instance.src_users_api_workspaces_update_workspace(uuid, workspace_update_schema)
        print("The response of DefaultApi->src_users_api_workspaces_update_workspace:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->src_users_api_workspaces_update_workspace: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
workspace_update_schema	WorkspaceUpdateSchema

Return type

Authorization