cyperf.SessionsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_session_meta	POST /api/v2/sessions/{sessionId}/meta
create_sessions	POST /api/v2/sessions
delete_session	DELETE /api/v2/sessions/{sessionId}
delete_session_meta	DELETE /api/v2/sessions/{sessionId}/meta/{metaId}
get_config_docs	GET /api/v2/sessions/{sessionId}/config/$docs
get_config_granular_stats	GET /api/v2/sessions/{sessionId}/config/granular-stats
get_config_granular_stats_filters	GET /api/v2/sessions/{sessionId}/config/granular-stats-filters
get_session_by_id	GET /api/v2/sessions/{sessionId}
get_session_config	GET /api/v2/sessions/{sessionId}/config
get_session_meta	GET /api/v2/sessions/{sessionId}/meta
get_session_meta_by_id	GET /api/v2/sessions/{sessionId}/meta/{metaId}
get_session_test	GET /api/v2/sessions/{sessionId}/test
get_sessions	GET /api/v2/sessions
patch_session	PATCH /api/v2/sessions/{sessionId}
patch_session_meta	PATCH /api/v2/sessions/{sessionId}/meta/{metaId}
patch_session_test	PATCH /api/v2/sessions/{sessionId}/test
start_config_add_applications	POST /api/v2/sessions/{sessionId}/config/config/TrafficProfiles/{trafficProfileId}/operations/add-applications
start_session_config_granular_stats_default_dashboards	POST /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards
start_session_config_save	POST /api/v2/sessions/{sessionId}/config/operations/save
start_session_load_config	POST /api/v2/sessions/{sessionId}/operations/loadConfig
start_session_prepare_test	POST /api/v2/sessions/{sessionId}/operations/prepareTest
start_session_test_end	POST /api/v2/sessions/{sessionId}/operations/testEnd
start_session_test_init	POST /api/v2/sessions/{sessionId}/operations/testInit
start_session_touch	POST /api/v2/sessions/{sessionId}/operations/touch
start_sessions_batch_delete	POST /api/v2/sessions/operations/batch-delete
update_session	PUT /api/v2/sessions/{sessionId}
update_session_config	PUT /api/v2/sessions/{sessionId}/config
update_session_meta	PUT /api/v2/sessions/{sessionId}/meta
update_session_test	PUT /api/v2/sessions/{sessionId}/test

create_session_meta

List[Pair] create_session_meta(session_id, session_metas=session_metas)

Create a new session metadata.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.pair import Pair
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    session_metas = [cyperf.Pair()] # List[Pair] |  (optional)

    try:
        api_response = api_instance.create_session_meta(session_id, session_metas=session_metas)
        print("The response of SessionsApi->create_session_meta:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->create_session_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
session_metas	List[Pair]		[optional]

Return type

List[Pair]

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Session metadata created successfully.	-
400	Bad request	-
404	A session with the specified ID was not found.	-

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

create_sessions

List[Session] create_sessions(sessions=sessions)

Create a new session by providing the URL of the configuration to be loaded.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.session import Session
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    sessions = [cyperf.Session()] # List[Session] |  (optional)

    try:
        api_response = api_instance.create_sessions(sessions=sessions)
        print("The response of SessionsApi->create_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->create_sessions: %s\n" % e)

Parameters

Name	Type	Description	Notes
sessions	List[Session]		[optional]

Return type

List[Session]

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Session created successfully.	-
400	Bad request	-
500	Unexpected error	-

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

delete_session

delete_session(session_id)

Delete a particular session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_instance.delete_session(session_id)
    except Exception as e:
        print("Exception when calling SessionsApi->delete_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The session was successfully deleted.	-
400	Bad request	-
403	The initiator of the request does not have enough privileges to perform the action.	-
404	A session with the specified ID was not found.	-
500	Unexpected error	-

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

delete_session_meta

delete_session_meta(session_id, meta_id)

Delete a particular session metadata pair.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    meta_id = 'meta_id_example' # str | The ID of the meta.

    try:
        api_instance.delete_session_meta(session_id, meta_id)
    except Exception as e:
        print("Exception when calling SessionsApi->delete_session_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
meta_id	str	The ID of the meta.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The session metadata was successfully deleted.	-
400	Bad request	-
404	A session or metadata with the specified IDs were not found.	-

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

get_config_docs

OpenAPIDefinitions get_config_docs(session_id)

Get the OpenAPI definitions for CyPerf data model.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.open_api_definitions import OpenAPIDefinitions
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_response = api_instance.get_config_docs(session_id)
        print("The response of SessionsApi->get_config_docs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_config_docs: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

OpenAPIDefinitions

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The OpenAPI definitions for CyPerf data model	-
500	Unexpected error	-

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

get_config_granular_stats

object get_config_granular_stats(session_id)

Get granular statistics based on the session configuration.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_response = api_instance.get_config_granular_stats(session_id)
        print("The response of SessionsApi->get_config_granular_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_config_granular_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

object

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested granular statistics	-
500	Unexpected error	-

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

get_config_granular_stats_filters

object get_config_granular_stats_filters(session_id)

Get the filters for the granular statistics based on the session configuration.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_response = api_instance.get_config_granular_stats_filters(session_id)
        print("The response of SessionsApi->get_config_granular_stats_filters:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_config_granular_stats_filters: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

object

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested filters for the granular statistics	-
500	Unexpected error	-

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

get_session_by_id

Session get_session_by_id(session_id, include=include)

Get a particular session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.session import Session
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    include = 'include_example' # str | Specifies if the sub-fields that are objects should be included (eg. test). (optional)

    try:
        api_response = api_instance.get_session_by_id(session_id, include=include)
        print("The response of SessionsApi->get_session_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_session_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
include	str	Specifies if the sub-fields that are objects should be included (eg. test).	[optional]

Return type

Session

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested session	-
404	A session with the specified ID was not found.	-

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

get_session_config

AppsecConfig get_session_config(session_id, include=include)

Get the current session's configuration.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.appsec_config import AppsecConfig
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    include = 'include_example' # str | Specifies if the sub-fields that are objects should be included (eg. 'Config'). (optional)

    try:
        api_response = api_instance.get_session_config(session_id, include=include)
        print("The response of SessionsApi->get_session_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_session_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
include	str	Specifies if the sub-fields that are objects should be included (eg. 'Config').	[optional]

Return type

AppsecConfig

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The current session's configuration	-
500	Unexpected error	-

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

get_session_meta

GetSessionMeta200Response get_session_meta(session_id, take=take, skip=skip)

Get the metadata of a particular session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_session_meta200_response import GetSessionMeta200Response
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_session_meta(session_id, take=take, skip=skip)
        print("The response of SessionsApi->get_session_meta:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_session_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetSessionMeta200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested session metadata	-
404	A session with the specified ID was not found.	-

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

get_session_meta_by_id

Pair get_session_meta_by_id(session_id, meta_id)

Get a particular session metadata pair.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.pair import Pair
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    meta_id = 'meta_id_example' # str | The ID of the meta.

    try:
        api_response = api_instance.get_session_meta_by_id(session_id, meta_id)
        print("The response of SessionsApi->get_session_meta_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_session_meta_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
meta_id	str	The ID of the meta.

Return type

Pair

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested session metadata pair	-
404	A session or metadata with the specified IDs were not found.	-

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

get_session_test

TestInfo get_session_test(session_id)

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.test_info import TestInfo
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_response = api_instance.get_session_test(session_id)
        print("The response of SessionsApi->get_session_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_session_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

TestInfo

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
500	Unexpected error	-

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

get_sessions

GetSessions200Response get_sessions(take=take, skip=skip, search_col=search_col, search_val=search_val, filter_mode=filter_mode, sort=sort, include=include)

List all the sessions.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_sessions200_response import GetSessions200Response
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)
    search_col = 'search_col_example' # str | A list of comma-separated columns used to search for the supplied values (optional)
    search_val = 'search_val_example' # str | The keywords used to filter the items (optional)
    filter_mode = 'filter_mode_example' # str | The operator applied to the supplied values (optional)
    sort = 'sort_example' # str | A list of comma-separated field:direction pairs used to sort the items where direction must be asc or dsc (optional)
    include = 'include_example' # str | Specifies if the sub-fields that are objects should be included. (optional)

    try:
        api_response = api_instance.get_sessions(take=take, skip=skip, search_col=search_col, search_val=search_val, filter_mode=filter_mode, sort=sort, include=include)
        print("The response of SessionsApi->get_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->get_sessions: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]
search_col	str	A list of comma-separated columns used to search for the supplied values	[optional]
search_val	str	The keywords used to filter the items	[optional]
filter_mode	str	The operator applied to the supplied values	[optional]
sort	str	A list of comma-separated field:direction pairs used to sort the items where direction must be asc or dsc	[optional]
include	str	Specifies if the sub-fields that are objects should be included.	[optional]

Return type

GetSessions200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of available sessions	-

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

patch_session

patch_session(session_id, session=session)

Update a particular session. Only non-null fields are updated.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.session import Session
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    session = cyperf.Session() # Session |  (optional)

    try:
        api_instance.patch_session(session_id, session=session)
    except Exception as e:
        print("Exception when calling SessionsApi->patch_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
session	Session		[optional]

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	The session was successfully updated.	-
404	A session with the specified ID was not found.	-
500	Unexpected error	-

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

patch_session_meta

patch_session_meta(session_id, meta_id, pair=pair)

Update a particular session metadata pair. Only non-null fields are updated.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.pair import Pair
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    meta_id = 'meta_id_example' # str | The ID of the meta.
    pair = cyperf.Pair() # Pair |  (optional)

    try:
        api_instance.patch_session_meta(session_id, meta_id, pair=pair)
    except Exception as e:
        print("Exception when calling SessionsApi->patch_session_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
meta_id	str	The ID of the meta.
pair	Pair		[optional]

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	The session metadata pair was successfully updated.	-
400	Bad request	-
404	A session or metadata with the specified IDs were not found.	-

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

patch_session_test

patch_session_test(session_id, test_info=test_info)

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.test_info import TestInfo
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    test_info = cyperf.TestInfo() # TestInfo |  (optional)

    try:
        api_instance.patch_session_test(session_id, test_info=test_info)
    except Exception as e:
        print("Exception when calling SessionsApi->patch_session_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
test_info	TestInfo		[optional]

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	The request was completed successfully.	-
500	Unexpected error	-

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

start_config_add_applications

AsyncContext start_config_add_applications(session_id, traffic_profile_id, external_resource_info=external_resource_info)

Add applications in the traffic profile of the current session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.external_resource_info import ExternalResourceInfo
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    traffic_profile_id = 'traffic_profile_id_example' # str | The ID of the traffic profile.
    external_resource_info = [cyperf.ExternalResourceInfo()] # List[ExternalResourceInfo] |  (optional)

    try:
        api_response = api_instance.start_config_add_applications(session_id, traffic_profile_id, external_resource_info=external_resource_info)
        print("The response of SessionsApi->start_config_add_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_config_add_applications: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
traffic_profile_id	str	The ID of the traffic profile.
external_resource_info	List[ExternalResourceInfo]		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_config_granular_stats_default_dashboards

AsyncContext start_session_config_granular_stats_default_dashboards(session_id)

Create granular statistics dashboards based on the session configuration.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

    try:
        api_response = api_instance.start_session_config_granular_stats_default_dashboards(session_id)
        print("The response of SessionsApi->start_session_config_granular_stats_default_dashboards:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_config_granular_stats_default_dashboards: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_config_save

AsyncContext start_session_config_save(session_id, save_config_operation=save_config_operation)

Save the configuration of the current session using the specified name.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.save_config_operation import SaveConfigOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    save_config_operation = cyperf.SaveConfigOperation() # SaveConfigOperation |  (optional)

    try:
        api_response = api_instance.start_session_config_save(session_id, save_config_operation=save_config_operation)
        print("The response of SessionsApi->start_session_config_save:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_config_save: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
save_config_operation	SaveConfigOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_load_config

AsyncContext start_session_load_config(session_id, load_config_operation=load_config_operation)

Load a new test in the current session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.load_config_operation import LoadConfigOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    load_config_operation = cyperf.LoadConfigOperation() # LoadConfigOperation |  (optional)

    try:
        api_response = api_instance.start_session_load_config(session_id, load_config_operation=load_config_operation)
        print("The response of SessionsApi->start_session_load_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_load_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
load_config_operation	LoadConfigOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_prepare_test

AsyncContext start_session_prepare_test(session_id, prepare_test_operation=prepare_test_operation)

This operation returns the config processed as agent messages and any data necessary for UI and REST stats

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.prepare_test_operation import PrepareTestOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    prepare_test_operation = [cyperf.PrepareTestOperation()] # List[PrepareTestOperation] |  (optional)

    try:
        api_response = api_instance.start_session_prepare_test(session_id, prepare_test_operation=prepare_test_operation)
        print("The response of SessionsApi->start_session_prepare_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_prepare_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
prepare_test_operation	List[PrepareTestOperation]		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_test_end

AsyncContext start_session_test_end(session_id, test_state_changed_operation=test_state_changed_operation)

This is called from traffic controller to notify that a test has ended. It should return any information needed by the traffic controller to completely clean up the test.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.test_state_changed_operation import TestStateChangedOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    test_state_changed_operation = [cyperf.TestStateChangedOperation()] # List[TestStateChangedOperation] |  (optional)

    try:
        api_response = api_instance.start_session_test_end(session_id, test_state_changed_operation=test_state_changed_operation)
        print("The response of SessionsApi->start_session_test_end:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_test_end: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
test_state_changed_operation	List[TestStateChangedOperation]		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_test_init

AsyncContext start_session_test_init(session_id, test_state_changed_operation=test_state_changed_operation)

This is called from traffic controller to notify that a new test is starting. It should return all the information needed by the traffic controller to start the test.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.test_state_changed_operation import TestStateChangedOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    test_state_changed_operation = [cyperf.TestStateChangedOperation()] # List[TestStateChangedOperation] |  (optional)

    try:
        api_response = api_instance.start_session_test_init(session_id, test_state_changed_operation=test_state_changed_operation)
        print("The response of SessionsApi->start_session_test_init:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_test_init: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
test_state_changed_operation	List[TestStateChangedOperation]		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_session_touch

AsyncContext start_session_touch(session_id, start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)

Update last visited field when session is touched.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.start_agents_batch_delete_request_inner import StartAgentsBatchDeleteRequestInner
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    start_agents_batch_delete_request_inner = cyperf.StartAgentsBatchDeleteRequestInner() # StartAgentsBatchDeleteRequestInner |  (optional)

    try:
        api_response = api_instance.start_session_touch(session_id, start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)
        print("The response of SessionsApi->start_session_touch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_session_touch: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
start_agents_batch_delete_request_inner	StartAgentsBatchDeleteRequestInner		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_sessions_batch_delete

AsyncContext start_sessions_batch_delete(start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)

Remove multiple sessions.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.start_agents_batch_delete_request_inner import StartAgentsBatchDeleteRequestInner
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    start_agents_batch_delete_request_inner = cyperf.StartAgentsBatchDeleteRequestInner() # StartAgentsBatchDeleteRequestInner |  (optional)

    try:
        api_response = api_instance.start_sessions_batch_delete(start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)
        print("The response of SessionsApi->start_sessions_batch_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->start_sessions_batch_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_agents_batch_delete_request_inner	StartAgentsBatchDeleteRequestInner		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

update_session

Session update_session(session_id, session=session)

Update a particular session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.session import Session
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    session = cyperf.Session() # Session |  (optional)

    try:
        api_response = api_instance.update_session(session_id, session=session)
        print("The response of SessionsApi->update_session:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->update_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
session	Session		[optional]

Return type

Session

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated session	-
400	Bad request	-
404	A session with the specified ID was not found.	-
500	Unexpected error	-

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

update_session_config

AppsecConfig update_session_config(session_id, appsec_config=appsec_config)

Update the current session's configuration.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.appsec_config import AppsecConfig
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    appsec_config = cyperf.AppsecConfig() # AppsecConfig |  (optional)

    try:
        api_response = api_instance.update_session_config(session_id, appsec_config=appsec_config)
        print("The response of SessionsApi->update_session_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->update_session_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
appsec_config	AppsecConfig		[optional]

Return type

AppsecConfig

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated configuration	-
500	Unexpected error	-

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

update_session_meta

List[Pair] update_session_meta(session_id, pair=pair)

Update the session metadata.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.pair import Pair
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    pair = [cyperf.Pair()] # List[Pair] |  (optional)

    try:
        api_response = api_instance.update_session_meta(session_id, pair=pair)
        print("The response of SessionsApi->update_session_meta:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->update_session_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
pair	List[Pair]		[optional]

Return type

List[Pair]

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated session metadata	-
404	A session with the specified ID was not found.	-
500	Unexpected error	-

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

update_session_test

TestInfo update_session_test(session_id, test_info=test_info)

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.test_info import TestInfo
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.SessionsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    test_info = cyperf.TestInfo() # TestInfo |  (optional)

    try:
        api_response = api_instance.update_session_test(session_id, test_info=test_info)
        print("The response of SessionsApi->update_session_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SessionsApi->update_session_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
test_info	TestInfo		[optional]

Return type

TestInfo

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
500	Unexpected error	-

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

FilesExpand file tree

SessionsApi.md

Latest commit

History

SessionsApi.md

File metadata and controls

cyperf.SessionsApi

create_session_meta

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_sessions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_session

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_session_meta

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_config_docs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_config_granular_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_config_granular_stats_filters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_session_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_session_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_session_meta

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_session_meta_by_id

Example

Parameters