8000 GitHub - Keysight/cyperf-api-wrapper
[go: up one dir, main page]
Skip to content

Keysight/cyperf-api-wrapper

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
cyperf
 
 
docker
docker
 
 
docs
docs
 
 
jenkins
jenkins
 
 
samples
samples
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.pypirc
.pypirc
 
 
.travis.yml
.travis.yml
 
 
API-endpoints-changelog.txt
API-endpoints-changelog.txt
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
publish.sh
publish.sh
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
test.sh
test.sh
 
 
tox.ini
tox.ini
 
 

Repository files navigation

cyperf

CyPerf REST API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.11+

Installation & Usage

pip install

You can install directly by doing:

pip install .

from the base of this repository.

Then import the package:

import cyperf

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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.AgentsApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the agent.

    try:
        api_instance.delete_agent(agent_id)
    except ApiException as e:
        print("Exception when calling AgentsApi->delete_agent: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AgentsApi delete_agent DELETE /api/v2/agents/{agentId}
AgentsApi get_agent_by_id GET /api/v2/agents/{agentId}
AgentsApi get_agents GET /api/v2/agents
AgentsApi get_agents_tags GET /api/v2/tags
AgentsApi get_compute_node_port_by_id GET /api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/ports/{portId}
AgentsApi get_compute_node_ports GET /api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/ports
AgentsApi get_controller_by_id GET /api/v2/controllers/{controllerId}
AgentsApi get_controller_compute_node_by_id GET /api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}
AgentsApi get_controller_compute_nodes GET /api/v2/controllers/{controllerId}/compute-nodes
AgentsApi get_controllers GET /api/v2/controllers
AgentsApi patch_agent PATCH /api/v2/agents/{agentId}
AgentsApi poll_agents_batch_delete GET /api/v2/agents/operations/batch-delete/{id}
AgentsApi poll_agents_export_files GET /api/v2/agents/operations/exportFiles/{id}
AgentsApi poll_agents_reboot GET /api/v2/agents/operations/reboot/{id}
AgentsApi poll_agents_release GET /api/v2/agents/operations/release/{id}
AgentsApi poll_agents_reserve GET /api/v2/agents/operations/reserve/{id}
AgentsApi poll_agents_set_dpdk_mode GET /api/v2/agents/operations/set-dpdk-mode/{id}
AgentsApi poll_agents_set_ntp GET /api/v2/agents/operations/set-ntp/{id}
AgentsApi poll_agents_update GET /api/v2/agents/operations/update/{id}
AgentsApi poll_controllers_clear_port_ownership GET /api/v2/controllers/operations/clear-port-ownership/{id}
AgentsApi poll_controllers_power_cycle_nodes GET /api/v2/controllers/operations/power-cycle-nodes/{id}
AgentsApi poll_controllers_reboot_port GET /api/v2/controllers/operations/reboot-port/{id}
AgentsApi poll_controllers_set_app GET /api/v2/controllers/operations/set-app/{id}
AgentsApi poll_controllers_set_node_aggregation GET /api/v2/controllers/operations/set-node-aggregation/{id}
AgentsApi poll_controllers_set_port_link_state GET /api/v2/controllers/operations/set-port-link-state/{id}
AgentsApi start_agents_batch_delete POST /api/v2/agents/operations/batch-delete
AgentsApi start_agents_export_files POST /api/v2/agents/operations/exportFiles
AgentsApi start_agents_reboot POST /api/v2/agents/operations/reboot
AgentsApi start_agents_release POST /api/v2/agents/operations/release
AgentsApi start_agents_reserve POST /api/v2/agents/operations/reserve
AgentsApi start_agents_set_dpdk_mode POST /api/v2/agents/operations/set-dpdk-mode
AgentsApi start_agents_set_ntp POST /api/v2/agents/operations/set-ntp
AgentsApi start_agents_update POST /api/v2/agents/operations/update
AgentsApi start_controllers_clear_port_ownership POST /api/v2/controllers/operations/clear-port-ownership
AgentsApi start_controllers_power_cycle_nodes POST /api/v2/controllers/operations/power-cycle-nodes
AgentsApi start_controllers_reboot_port POST /api/v2/controllers/operations/reboot-port
AgentsApi start_controllers_set_app POST /api/v2/controllers/operations/set-app
AgentsApi start_controllers_set_node_aggregation POST /api/v2/controllers/operations/set-node-aggregation
AgentsApi start_controllers_set_port_link_state POST /api/v2/controllers/operations/set-port-link-state
ApplicationResourcesApi delete_resources_capture DELETE /api/v2/resources/captures/{captureId}
ApplicationResourcesApi delete_resources_certificate DELETE /api/v2/resources/certificates/{certificateId}
ApplicationResourcesApi delete_resources_flow_library DELETE /api/v2/resources/flow-library/{flowLibraryId}
ApplicationResourcesApi delete_resources_global_playlist DELETE /api/v2/resources/global-playlists/{globalPlaylistId}
ApplicationResourcesApi delete_resources_http_library DELETE /api/v2/resources/http-library/{httpLibraryId}
ApplicationResourcesApi delete_resources_media_file DELETE /api/v2/resources/media-files/{mediaFileId}
ApplicationResourcesApi delete_resources_media_library DELETE /api/v2/resources/media-library/{mediaLibraryId}
ApplicationResourcesApi delete_resources_other_library DELETE /api/v2/resources/other-library/{otherLibraryId}
ApplicationResourcesApi delete_resources_payload DELETE /api/v2/resources/payloads/{payloadId}
ApplicationResourcesApi delete_resources_pcap DELETE /api/v2/resources/pcaps/{pcapId}
ApplicationResourcesApi delete_resources_playlist DELETE /api/v2/resources/playlists/{playlistId}
ApplicationResourcesApi delete_resources_sip_library DELETE /api/v2/resources/sip-library/{sipLibraryId}
ApplicationResourcesApi delete_resources_stats_profile DELETE /api/v2/resources/stats-profile/{statsProfileId}
ApplicationResourcesApi delete_resources_tls_certificate DELETE /api/v2/resources/tls-certificates/{tlsCertificateId}
ApplicationResourcesApi delete_resources_tls_dh DELETE /api/v2/resources/tls-dhs/{tlsDhId}
ApplicationResourcesApi delete_resources_tls_key DELETE /api/v2/resources/tls-keys/{tlsKeyId}
ApplicationResourcesApi delete_resources_user_defined_app DELETE /api/v2/resources/user-defined-apps/{userDefinedAppId}
ApplicationResourcesApi get_capture_flows GET /api/v2/resources/captures/{captureId}/flows
ApplicationResourcesApi get_flow_exchanges GET /api/v2/resources/captures/{captureId}/flows/{flowId}/exchanges
ApplicationResourcesApi get_resources_app_by_id GET /api/v2/resources/apps/{appId}
ApplicationResourcesApi get_resources_application_type_by_id GET /api/v2/resources/application-types/{applicationTypeId}
ApplicationResourcesApi get_resources_application_types GET /api/v2/resources/application-types
ApplicationResourcesApi get_resources_apps GET /api/v2/resources/apps
ApplicationResourcesApi get_resources_attack_by_id GET /api/v2/resources/attacks/{attackId}
ApplicationResourcesApi get_resources_attack_categories GET /api/v2/resources/attack-categories
ApplicationResourcesApi get_resources_attacks GET /api/v2/resources/attacks
ApplicationResourcesApi get_resources_auth_profile_by_id GET /api/v2/resources/auth-profiles/{authProfileId}
ApplicationResourcesApi get_resources_auth_profiles GET /api/v2/resources/auth-profiles
ApplicationResourcesApi get_resources_capture_by_id GET /api/v2/resources/captures/{captureId}
ApplicationResourcesApi get_resources_captures GET /api/v2/resources/captures
ApplicationResourcesApi get_resources_captures_upload_file_result GET /api/v2/resources/captures/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_certificate_by_id GET /api/v2/resources/certificates/{certificateId}
ApplicationResourcesApi get_resources_certificate_content_file GET /api/v2/resources/certificates/{certificateId}/contentFile
ApplicationResourcesApi get_resources_certificates GET /api/v2/resources/certificates
ApplicationResourcesApi get_resources_certificates_upload_file_result GET /api/v2/resources/certificates/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_flow_library GET /api/v2/resources/flow-library
ApplicationResourcesApi get_resources_flow_library_by_id GET /api/v2/resources/flow-library/{flowLibraryId}
ApplicationResourcesApi get_resources_flow_library_content_file GET /api/v2/resources/flow-library/{flowLibraryId}/contentFile
ApplicationResourcesApi get_resources_flow_library_upload_file_result GET /api/v2/resources/flow-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_global_playlist_by_id GET /api/v2/resources/global-playlists/{globalPlaylistId}
ApplicationResourcesApi get_resources_global_playlist_content_file GET /api/v2/resources/global-playlists/{globalPlaylistId}/contentFile
ApplicationResourcesApi get_resources_global_playlists GET /api/v2/resources/global-playlists
ApplicationResourcesApi get_resources_global_playlists_upload_file_result GET /api/v2/resources/global-playlists/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_http_library GET /api/v2/resources/http-library
ApplicationResourcesApi get_resources_http_library_by_id GET /api/v2/resources/http-library/{httpLibraryId}
ApplicationResourcesApi get_resources_http_library_content_file GET /api/v2/resources/http-library/{httpLibraryId}/contentFile
ApplicationResourcesApi get_resources_http_library_upload_file_result GET /api/v2/resources/http-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_http_profile_by_id GET /api/v2/resources/http-profiles/{httpProfileId}
ApplicationResourcesApi get_resources_http_profiles GET /api/v2/resources/http-profiles
ApplicationResourcesApi get_resources_media_file_by_id GET /api/v2/resources/media-files/{mediaFileId}
ApplicationResourcesApi get_resources_media_file_content_file GET /api/v2/resources/media-files/{mediaFileId}/contentFile
ApplicationResourcesApi get_resources_media_files GET /api/v2/resources/media-files
ApplicationResourcesApi get_resources_media_files_upload_file_result GET /api/v2/resources/media-files/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_media_library GET /api/v2/resources/media-library
ApplicationResourcesApi get_resources_media_library_by_id GET /api/v2/resources/media-library/{mediaLibraryId}
ApplicationResourcesApi get_resources_media_library_content_file GET /api/v2/resources/media-library/{mediaLibraryId}/contentFile
ApplicationResourcesApi get_resources_media_library_upload_file_result GET /api/v2/resources/media-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_other_library GET /api/v2/resources/other-library
ApplicationResourcesApi get_resources_other_library_by_id GET /api/v2/resources/other-library/{otherLibraryId}
ApplicationResourcesApi get_resources_other_library_content_file GET /api/v2/resources/other-library/{otherLibraryId}/contentFile
ApplicationResourcesApi get_resources_other_library_upload_file_result GET /api/v2/resources/other-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_payload_by_id GET /api/v2/resources/payloads/{payloadId}
ApplicationResourcesApi get_resources_payload_content_file GET /api/v2/resources/payloads/{payloadId}/contentFile
ApplicationResourcesApi get_resources_payloads GET /api/v2/resources/payloads
ApplicationResourcesApi get_resources_payloads_upload_file_result GET /api/v2/resources/payloads/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_pcap_by_id GET /api/v2/resources/pcaps/{pcapId}
ApplicationResourcesApi get_resources_pcap_content_file GET /api/v2/resources/pcaps/{pcapId}/contentFile
ApplicationResourcesApi get_resources_pcaps GET /api/v2/resources/pcaps
ApplicationResourcesApi get_resources_pcaps_upload_file_result GET /api/v2/resources/pcaps/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_playlist_by_id GET /api/v2/resources/playlists/{playlistId}
ApplicationResourcesApi get_resources_playlist_content_file GET /api/v2/resources/playlists/{playlistId}/contentFile
ApplicationResourcesApi get_resources_playlist_values GET /api/v2/resources/playlists/{playlistId}/values
ApplicationResourcesApi get_resources_playlists GET /api/v2/resources/playlists
ApplicationResourcesApi get_resources_playlists_upload_file_result GET /api/v2/resources/playlists/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_sip_library GET /api/v2/resources/sip-library
ApplicationResourcesApi get_resources_sip_library_by_id GET /api/v2/resources/sip-library/{sipLibraryId}
ApplicationResourcesApi get_resources_sip_library_content_file GET /api/v2/resources/sip-library/{sipLibraryId}/contentFile
ApplicationResourcesApi get_resources_sip_library_upload_file_result GET /api/v2/resources/sip-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_stats_profile GET /api/v2/resources/stats-profile
ApplicationResourcesApi get_resources_stats_profile_by_id GET /api/v2/resources/stats-profile/{statsProfileId}
ApplicationResourcesApi get_resources_stats_profile_content_file GET /api/v2/resources/stats-profile/{statsProfileId}/contentFile
ApplicationResourcesApi get_resources_stats_profile_upload_file_result GET /api/v2/resources/stats-profile/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_strike_by_id GET /api/v2/resources/strikes/{strikeId}
ApplicationResourcesApi get_resources_strike_categories GET /api/v2/resources/strike-categories
ApplicationResourcesApi get_resources_strikes GET /api/v2/resources/strikes
ApplicationResourcesApi get_resources_tls_certificate_by_id GET /api/v2/resources/tls-certificates/{tlsCertificateId}
ApplicationResourcesApi get_resources_tls_certificate_content_file GET /api/v2/resources/tls-certificates/{tlsCertificateId}/contentFile
ApplicationResourcesApi get_resources_tls_certificates GET /api/v2/resources/tls-certificates
ApplicationResourcesApi get_resources_tls_certificates_upload_file_result GET /api/v2/resources/tls-certificates/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_tls_dh_by_id GET /api/v2/resources/tls-dhs/{tlsDhId}
ApplicationResourcesApi get_resources_tls_dh_content_file GET /api/v2/resources/tls-dhs/{tlsDhId}/contentFile
ApplicationResourcesApi get_resources_tls_dhs GET /api/v2/resources/tls-dhs
ApplicationResourcesApi get_resources_tls_dhs_upload_file_result GET /api/v2/resources/tls-dhs/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_tls_key_by_id GET /api/v2/resources/tls-keys/{tlsKeyId}
ApplicationResourcesApi get_resources_tls_key_content_file GET /api/v2/resources/tls-keys/{tlsKeyId}/contentFile
ApplicationResourcesApi get_resources_tls_keys GET /api/v2/resources/tls-keys
ApplicationResourcesApi get_resources_tls_keys_upload_file_result GET /api/v2/resources/tls-keys/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_user_defined_apps GET /api/v2/resources/user-defined-apps
ApplicationResourcesApi get_resources_user_defined_apps_upload_file_result GET /api/v2/resources/user-defined-apps/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi poll_resources_apps_export_all GET /api/v2/resources/apps/operations/export-all/{id}
ApplicationResourcesApi poll_resources_captures_batch_delete GET /api/v2/resources/captures/operations/batch-delete/{id}
ApplicationResourcesApi poll_resources_captures_upload_file GET /api/v2/resources/captures/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_certificates_upload_file GET /api/v2/resources/certificates/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_create_app GET /api/v2/resources/operations/create-app/{id}
ApplicationResourcesApi poll_resources_edit_app GET /api/v2/resources/operations/edit-app/{id}
ApplicationResourcesApi poll_resources_find_param_matches GET /api/v2/resources/operations/find-param-matches/{id}
ApplicationResourcesApi poll_resources_flow_library_upload_file GET /api/v2/resources/flow-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_get_attack_categories GET /api/v2/resources/operations/get-attack-categories/{id}
ApplicationResourcesApi poll_resources_get_attacks GET /api/v2/resources/operations/get-attacks/{id}
ApplicationResourcesApi poll_resources_get_strike_categories GET /api/v2/resources/operations/get-strike-categories/{id}
ApplicationResourcesApi poll_resources_get_strikes GET /api/v2/resources/operations/get-strikes/{id}
ApplicationResourcesApi poll_resources_global_playlists_upload_file GET /api/v2/resources/global-playlists/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_http_library_upload_file GET /api/v2/resources/http-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_media_files_upload_file GET /api/v2/resources/media-files/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_media_library_upload_file GET /api/v2/resources/media-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_other_library_upload_file GET /api/v2/resources/other-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_payloads_upload_file GET /api/v2/resources/payloads/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_pcaps_upload_file GET /api/v2/resources/pcaps/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_playlists_upload_file GET /api/v2/resources/playlists/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_sip_library_upload_file GET /api/v2/resources/sip-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_stats_profile_upload_file GET /api/v2/resources/stats-profile/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_tls_certificates_upload_file GET /api/v2/resources/tls-certificates/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_tls_dhs_upload_file GET /api/v2/resources/tls-dhs/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_tls_keys_upload_file GET /api/v2/resources/tls-keys/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi poll_resources_user_defined_apps_export_all GET /api/v2/resources/user-defined-apps/operations/export-all/{id}
ApplicationResourcesApi poll_resources_user_defined_apps_upload_file GET /api/v2/resources/user-defined-apps/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi start_resources_apps_export_all POST /api/v2/resources/apps/operations/export-all
ApplicationResourcesApi start_resources_captures_batch_delete POST /api/v2/resources/captures/operations/batch-delete
ApplicationResourcesApi start_resources_captures_upload_file POST /api/v2/resources/captures/operations/uploadFile
ApplicationResourcesApi start_resources_certificates_upload_file POST /api/v2/resources/certificates/operations/uploadFile
ApplicationResourcesApi start_resources_create_app POST /api/v2/resources/operations/create-app
ApplicationResourcesApi start_resources_edit_app POST /api/v2/resources/operations/edit-app
ApplicationResourcesApi start_resources_find_param_matches POST /api/v2/resources/operations/find-param-matches
ApplicationResourcesApi start_resources_flow_library_upload_file POST /api/v2/resources/flow-library/operations/uploadFile
ApplicationResourcesApi start_resources_get_attack_categories POST /api/v2/resources/operations/get-attack-categories
ApplicationResourcesApi start_resources_get_attacks POST /api/v2/resources/operations/get-attacks
ApplicationResourcesApi start_resources_get_strike_categories POST /api/v2/resources/operations/get-strike-categories
ApplicationResourcesApi start_resources_get_strikes POST /api/v2/resources/operations/get-strikes
ApplicationResourcesApi start_resources_global_playlists_upload_file POST /api/v2/resources/global-playlists/operations/uploadFile
ApplicationResourcesApi start_resources_http_library_upload_file POST /api/v2/resources/http-library/operations/uploadFile
ApplicationResourcesApi start_resources_media_files_upload_file POST /api/v2/resources/media-files/operations/uploadFile
ApplicationResourcesApi start_resources_media_library_upload_file POST /api/v2/resources/media-library/operations/uploadFile
ApplicationResourcesApi start_resources_other_library_upload_file POST /api/v2/resources/other-library/operations/uploadFile
ApplicationResourcesApi start_resources_payloads_upload_file POST /api/v2/resources/payloads/operations/uploadFile
ApplicationResourcesApi start_resources_pcaps_upload_file POST /api/v2/resources/pcaps/operations/uploadFile
ApplicationResourcesApi start_resources_playlists_upload_file POST /api/v2/resources/playlists/operations/uploadFile
ApplicationResourcesApi start_resources_sip_library_upload_file POST /api/v2/resources/sip-library/operations/uploadFile
ApplicationResourcesApi start_resources_stats_profile_upload_file POST /api/v2/resources/stats-profile/operations/uploadFile
ApplicationResourcesApi start_resources_tls_certificates_upload_file POST /api/v2/resources/tls-certificates/operations/uploadFile
ApplicationResourcesApi start_resources_tls_dhs_upload_file POST /api/v2/resources/tls-dhs/operations/uploadFile
ApplicationResourcesApi start_resources_tls_keys_upload_file POST /api/v2/resources/tls-keys/operations/uploadFile
ApplicationResourcesApi start_resources_user_defined_apps_export_all POST /api/v2/resources/user-defined-apps/operations/export-all
ApplicationResourcesApi start_resources_user_defined_apps_upload_file POST /api/v2/resources/user-defined-apps/operations/uploadFile
AuthorizationApi authenticate POST /auth/realms/keysight/protocol/openid-connect/token
BrokersApi create_brokers POST /api/v2/brokers
BrokersApi delete_broker DELETE /api/v2/brokers/{brokerId}
BrokersApi get_broker_by_id GET /api/v2/brokers/{brokerId}
BrokersApi get_brokers GET /api/v2/brokers
BrokersApi patch_broker PATCH /api/v2/brokers/{brokerId}
ConfigurationsApi create_configs POST /api/v2/configs
ConfigurationsApi delete_config DELETE /api/v2/configs/{configId}
ConfigurationsApi get_config_by_id GET /api/v2/configs/{configId}
ConfigurationsApi get_config_categories GET /api/v2/config-categories
ConfigurationsApi get_configs GET /api/v2/configs
ConfigurationsApi get_resources_custom_import_operations GET /api/v2/resources/custom-import-operations
ConfigurationsApi patch_config PATCH /api/v2/configs/{configId}
ConfigurationsApi poll_configs_batch_delete GET /api/v2/configs/operations/batch-delete/{id}
ConfigurationsApi poll_configs_export_all GET /api/v2/configs/operations/exportAll/{id}
ConfigurationsApi poll_configs_import GET /api/v2/configs/operations/import/{id}
ConfigurationsApi poll_configs_import_all GET /api/v2/configs/operations/importAll/{id}
ConfigurationsApi start_configs_batch_delete POST /api/v2/configs/operations/batch-delete
ConfigurationsApi start_configs_export_all POST /api/v2/configs/operations/exportAll
ConfigurationsApi start_configs_import POST /api/v2/configs/operations/import
ConfigurationsApi start_configs_import_all POST /api/v2/configs/operations/importAll
ConfigurationsApi update_config PUT /api/v2/configs/{configId}
DataMigrationApi poll_controller_migration_export GET /api/v2/controller-migration/operations/export/{id}
DataMigrationApi poll_controller_migration_import GET /api/v2/controller-migration/operations/import/{id}
DataMigrationApi start_controller_migration_export POST /api/v2/controller-migration/operations/export
DataMigrationApi start_controller_migration_import POST /api/v2/controller-migration/operations/import
DiagnosticsApi api_v2_diagnostics_components_get GET /api/v2/diagnostics/components
DiagnosticsApi api_v2_diagnostics_operations_delete_delete DELETE /api/v2/diagnostics/operations/delete
DiagnosticsApi api_v2_diagnostics_operations_delete_id_delete DELETE /api/v2/diagnostics/operations/delete/{id}
DiagnosticsApi api_v2_diagnostics_operations_export_get GET /api/v2/diagnostics/operations/export
DiagnosticsApi api_v2_diagnostics_operations_export_id_get GET /api/v2/diagnostics/operations/export/{id}
DiagnosticsApi api_v2_diagnostics_operations_export_id_result_get GET /api/v2/diagnostics/operations/export/{id}/result
DiagnosticsApi api_v2_diagnostics_operations_export_post POST /api/v2/diagnostics/operations/export
LicenseServersApi create_license_servers POST /api/v2/license-servers
LicenseServersApi delete_license_server DELETE /api/v2/license-servers/{licenseServerId}
LicenseServersApi get_license_server_by_id GET /api/v2/license-servers/{licenseServerId}
LicenseServersApi get_license_servers GET /api/v2/license-servers
LicenseServersApi patch_license_server PATCH /api/v2/license-servers/{licenseServerId}
LicensingApi activate_licenses POST /api/v2/licensing/operations/activate Performs an online request to KSM and activates the requested licenses.
LicensingApi deactivate_licenses POST /api/v2/licensing/operations/deactivate Performs an online request to KSM to deactivate the requested licenses.
LicensingApi generate_offline_request GET /api/v2/licensing/generate-offline-request Generates an offline request that can be used on the offline licensing portal.
LicensingApi get_activation_code_info POST /api/v2/licensing/operations/retrieve-activation-code-info Retrieves the activation code info from KSM.
LicensingApi get_activation_code_info_list POST /api/v2/licensing/operations/retrieve-activation-code-info-list Retrieves the activation code info list from KSM.
LicensingApi get_async_operation_result GET /api/v2/licensing/operations/{operationType}/{id}/result Returns the result of async operation.
LicensingApi get_async_operation_status GET /api/v2/licensing/operations/{operationType}/{id} Returns the status of an ongoing async operation.
LicensingApi get_counted_feature_stats POST /api/v2/licensing/operations/retrieve-counted-feature-stats Retrieves the counted feature stats.
LicensingApi get_entitlement_code_info POST /api/v2/licensing/operations/retrieve-entitlement-code-info Retrieves the activations codes of the supplied entitlement code from KSM.
LicensingApi get_hostid GET /api/v2/licensing/hostid Retrieves the host ID of the license server.
LicensingApi get_installed_licenses GET /api/v2/licensing/licenses Returns the installed licenses.
LicensingApi get_license GET /api/v2/licensing/licenses/{licenseId} Returns the requested license.
LicensingApi get_license_async_operation_result GET /api/v2/licensing/licenses/{licenseId}/operations/{operationType}/{id}/result Returns the result of async operation.
LicensingApi get_license_async_operation_status GET /api/v2/licensing/licenses/{licenseId}/operations/{operationType}/{id} Returns the status of an ongoing async operation.
LicensingApi import_offline_license POST /api/v2/licensing/import-offline-license Installs the offline license.
LicensingApi remove_reservation POST /api/v2/licensing/licenses/{licenseId}/operations/reservation-remove Remove previously reserved features, thus making them available for checkout by other users.
LicensingApi sync_licenses POST /api/v2/licensing/operations/synchronize-licenses Synchronize local licenses with KSM.
LicensingApi test_backend_connectivity POST /api/v2/licensing/operations/test-backend-connectivity Tests connection of the license server with KSM.
LicensingApi update_reservation POST /api/v2/licensing/licenses/{licenseId}/operations/reservation-reserve Retain over a period of time specific counts of installed features, that can be consumed only by current user.
NotificationsApi delete_notification DELETE /api/v2/notifications/{notificationId}
NotificationsApi get_notification_by_id GET /api/v2/notifications/{notificationId}
NotificationsApi get_notification_counts GET /api/v2/notification-counts
NotificationsApi get_notifications GET /api/v2/notifications
NotificationsApi poll_notifications_cleanup GET /api/v2/notifications/operations/cleanup/{id}
NotificationsApi poll_notifications_dismiss GET /api/v2/notifications/operations/dismiss/{id}
NotificationsApi start_notifications_cleanup POST /api/v2/notifications/operations/cleanup
NotificationsApi start_notifications_dismiss POST /api/v2/notifications/operations/dismiss
ReportsApi download_pdf GET /api/v2/results/{resultId}/download-pdf/{pdfId}
ReportsApi get_result_download_csv_by_id GET /api/v2/results/{resultId}/download-csv/{downloadCsvId}
ReportsApi poll_result_generate_csv GET /api/v2/results/{resultId}/operations/generate-csv/{id}
ReportsApi poll_result_generate_pdf GET /api/v2/results/{resultId}/operations/generate-pdf/{id}
ReportsApi start_result_generate_csv POST /api/v2/results/{resultId}/operations/generate-csv
ReportsApi start_result_generate_pdf POST /api/v2/results/{resultId}/operations/generate-pdf
SessionsApi create_session_meta POST /api/v2/sessions/{sessionId}/meta
SessionsApi create_sessions POST /api/v2/sessions
SessionsApi delete_session DELETE /api/v2/sessions/{sessionId}
SessionsApi delete_session_meta DELETE /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi get_appsec_ui_metadata GET /api/v2/appsec-ui-metadata
SessionsApi get_config_docs GET /api/v2/sessions/{sessionId}/config/$docs
SessionsApi get_config_granular_stats GET /api/v2/sessions/{sessionId}/config/granular-stats
SessionsApi get_config_granular_stats_filters GET /api/v2/sessions/{sessionId}/config/granular-stats-filters
SessionsApi get_session_by_id GET /api/v2/sessions/{sessionId}
SessionsApi get_session_config GET /api/v2/sessions/{sessionId}/config
SessionsApi get_session_meta GET /api/v2/sessions/{sessionId}/meta
SessionsApi get_session_meta_by_id GET /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi get_session_test GET /api/v2/sessions/{sessionId}/test
SessionsApi get_sessions GET /api/v2/sessions
SessionsApi patch_session PATCH /api/v2/sessions/{sessionId}
SessionsApi patch_session_meta PATCH /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi patch_session_test PATCH /api/v2/sessions/{sessionId}/test
SessionsApi poll_config_add_applications GET /api/v2/sessions/{sessionId}/config/config/TrafficProfiles/{trafficProfileId}/operations/add-applications/{id}
SessionsApi poll_config_save GET /api/v2/sessions/{sessionId}/config/operations/save/{id}
SessionsApi poll_session_config_granular_stats_default_dashboards GET /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards/{id}
SessionsApi poll_session_load_config GET /api/v2/sessions/{sessionId}/operations/loadConfig/{id}
SessionsApi poll_session_prepare_test GET /api/v2/sessions/{sessionId}/operations/prepareTest/{id}
SessionsApi poll_session_test_end GET /api/v2/sessions/{sessionId}/operations/testEnd/{id}
SessionsApi poll_session_test_init GET /api/v2/sessions/{sessionId}/operations/testInit/{id}
SessionsApi poll_session_touch GET /api/v2/sessions/{sessionId}/operations/touch/{id}
SessionsApi poll_sessions_batch_delete GET /api/v2/sessions/operations/batch-delete/{id}
SessionsApi start_config_add_applications POST /api/v2/sessions/{sessionId}/config/config/TrafficProfiles/{trafficProfileId}/operations/add-applications
SessionsApi start_session_config_granular_stats_default_dashboards POST /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards
SessionsApi start_session_config_save POST /api/v2/sessions/{sessionId}/config/operations/save
SessionsApi start_session_load_config POST /api/v2/sessions/{sessionId}/operations/loadConfig
SessionsApi start_session_prepare_test POST /api/v2/sessions/{sessionId}/operations/prepareTest
SessionsApi start_session_test_end POST /api/v2/sessions/{sessionId}/operations/testEnd
SessionsApi start_session_test_init POST /api/v2/sessions/{sessionId}/operations/testInit
SessionsApi start_session_touch POST /api/v2/sessions/{sessionId}/operations/touch
SessionsApi start_sessions_batch_delete POST /api/v2/sessions/operations/batch-delete
SessionsApi update_session PUT /api/v2/sessions/{sessionId}
SessionsApi update_session_config PUT /api/v2/sessions/{sessionId}/config
SessionsApi update_session_meta PUT /api/v2/sessions/{sessionId}/meta
SessionsApi update_session_test PUT /api/v2/sessions/{sessionId}/test
StatisticsApi create_stats_plugins POST /api/v2/stats/plugins
StatisticsApi delete_stats_plugin DELETE /api/v2/stats/plugins/{pluginId}
StatisticsApi get_result_stat_by_id GET /api/v2/results/{resultId}/stats/{statId}
StatisticsApi get_result_stats GET /api/v2/results/{resultId}/stats
StatisticsApi get_stats_plugins GET /api/v2/stats/plugins
StatisticsApi poll_stats_plugins_ingest GET /api/v2/stats/plugins/operations/ingest/{id}
StatisticsApi start_stats_plugins_ingest POST /api/v2/stats/plugins/operations/ingest
TestOperationsApi poll_test_calibrate_start GET /api/v2/sessions/{sessionId}/test-calibrate/operations/start/{id}
TestOperationsApi poll_test_calibrate_stop GET /api/v2/sessions/{sessionId}/test-calibrate/operations/stop/{id}
TestOperationsApi poll_test_run_abort GET /api/v2/sessions/{sessionId}/test-run/operations/abort/{id}
TestOperationsApi poll_test_run_start GET /api/v2/sessions/{sessionId}/test-run/operations/start/{id}
TestOperationsApi poll_test_run_stop GET /api/v2/sessions/{sessionId}/test-run/operations/stop/{id}
TestOperationsApi start_test_calibrate_start POST /api/v2/sessions/{sessionId}/test-calibrate/operations/start
TestOperationsApi start_test_calibrate_stop POST /api/v2/sessions/{sessionId}/test-calibrate/operations/stop
TestOperationsApi start_test_run_abort POST /api/v2/sessions/{sessionId}/test-run/operations/abort
TestOperationsApi start_test_run_start POST /api/v2/sessions/{sessionId}/test-run/operations/start
TestOperationsApi start_test_run_stop POST /api/v2/sessions/{sessionId}/test-run/operations/stop
TestResultsApi delete_result DELETE /api/v2/results/{resultId}
TestResultsApi delete_result_file DELETE /api/v2/results/{resultId}/files/{fileId}
TestResultsApi get_result_by_id GET /api/v2/results/{resultId}
TestResultsApi get_result_download_all_by_id GET /api/v2/results/{resultId}/download-all/{downloadAllId}
TestResultsApi get_result_download_result_config GET /api/v2/results/{resultId}/download-result-config
TestResultsApi get_result_file_by_id GET /api/v2/results/{resultId}/files/{fileId}
TestResultsApi get_result_file_content GET /api/v2/results/{resultId}/files/{fileId}/content
TestResultsApi get_result_files GET /api/v2/results/{resultId}/files
TestResultsApi get_results GET /api/v2/results
TestResultsApi get_results_tags GET /api/v2/results/tags
TestResultsApi poll_result_generate_all GET /api/v2/results/{resultId}/operations/generate-all/{id}
TestResultsApi poll_result_generate_results GET /api/v2/results/{resultId}/operations/generate-results/{id}
TestResultsApi poll_result_load GET /api/v2/results/{resultId}/operations/load/{id}
TestResultsApi poll_results_batch_delete GET /api/v2/results/operations/batch-delete/{id}
TestResultsApi start_result_generate_all POST /api/v2/results/{resultId}/operations/generate-all
TestResultsApi start_result_generate_results POST /api/v2/results/{resultId}/operations/generate-results
TestResultsApi start_result_load POST /api/v2/results/{resultId}/operations/load
TestResultsApi start_results_batch_delete POST /api/v2/results/operations/batch-delete
UtilsApi check_eulas GET /eula/v1/check Check if all EULAs are accepted
UtilsApi get_cert_manager_certificate GET /api/v2/cert-manager/certificate
UtilsApi get_disk_usage GET /api/v2/disk-usage
UtilsApi get_disk_usage_consumer_by_id GET /api/v2/disk-usage/consumers/{consumerId}
UtilsApi get_disk_usage_consumers GET /api/v2/disk-usage/consumers
UtilsApi get_docs GET /api/v2/docs
UtilsApi get_docs_json GET /api/v2/docs.json
UtilsApi get_docs_yaml GET /api/v2/docs.yaml
UtilsApi get_eula GET /eula/v1/eula/CyPerf Retrieve EULA detail
UtilsApi get_log_config GET /api/v2/log-config
UtilsApi get_time GET /api/v2/time
UtilsApi list_eulas< F987 /td> GET /eula/v1/eula list of EULAs
UtilsApi poll_cert_manager_generate GET /api/v2/cert-manager/operations/generate/{id}
UtilsApi poll_cert_manager_upload GET /api/v2/cert-manager/operations/upload/{id}
UtilsApi poll_disk_usage_cleanup_diagnostics GET /api/v2/disk-usage/operations/cleanup-diagnostics/{id}
UtilsApi poll_disk_usage_cleanup_logs GET /api/v2/disk-usage/operations/cleanup-logs/{id}
UtilsApi poll_disk_usage_cleanup_migration GET /api/v2/disk-usage/operations/cleanup-migration/{id}
UtilsApi poll_disk_usage_cleanup_notifications GET /api/v2/disk-usage/operations/cleanup-notifications/{id}
UtilsApi poll_disk_usage_cleanup_results GET /api/v2/disk-usage/operations/cleanup-results/{id}
UtilsApi post_eula POST /eula/v1/eula/CyPerf Update properties an EULA
UtilsApi start_cert_manager_generate POST /api/v2/cert-manager/operations/generate
UtilsApi start_cert_manager_upload POST /api/v2/cert-manager/operations/upload
UtilsApi start_disk_usage_cleanup_diagnostics POST /api/v2/disk-usage/operations/cleanup-diagnostics
UtilsApi start_disk_usage_cleanup_logs POST /api/v2/disk-usage/operations/cleanup-logs
UtilsApi start_disk_usage_cleanup_migration POST /api/v2/disk-usage/operations/cleanup-migration
UtilsApi start_disk_usage_cleanup_notifications POST /api/v2/disk-usage/operations/cleanup-notifications
UtilsApi start_disk_usage_cleanup_results POST /api/v2/disk-usage/operations/cleanup-results
UtilsApi update_log_config PUT /api/v2/log-config

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
  • offline_access: Required.
  • openid: Required.

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /auth/realms/keysight/protocol/openid-connect/auth
  • Scopes:
  • offline_access: Required.
  • openid: Required.

Author

support@keysight.com

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

2 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages
0