Skip to content

Miscellaneous branch #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
soumo033 wants to merge 2 commits into from
Closed

Miscellaneous branch #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe25ca5
poetry lock
soumo033 Aug 20, 2025
795a3b1
added files for appmix-builder
soumo033 Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 76 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# cyperf
# CyPerf
CyPerf REST API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
Expand All @@ -8,20 +8,79 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
- 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:

```sh
pip install .
```

from the base of this repository.
# CyPerf API Wrapper Installation Instructions

## Table of Contents

* [Prerequisites](#prerequisites)
* [Step 1: Install Python](#step-1-install-python)
* [Step 2: Create a New Directory and Virtual Environment](#step-2-create-a-new-directory-and-virtual-environment)
* [Step 3: Clone the CyPerf API Wrapper Repository](#step-3-clone-the-cyperf-api-wrapper-repository)
* [Step 4: Install Dependencies and Build the Package](#step-4-install-dependencies-and-build-the-package)

## Prerequisites

* Python 3.11+ (check the [README.md file](https://github.com/Keysight/cyperf-api-wrapper/blob/main/README.md) for the latest requirement)

## Step 1: Install Python

* Download and install Python from the [official Python website](https://www.python.org/downloads/).
* Ensure necessary dependencies are installed:
+ On Linux (Debian-based):
```bash
sudo apt install libssl-dev libffi-dev python3-dev

* If installing Python from source:
```bash
sudo apt update
sudo apt upgrade
./configure --enable-optimizations --with-ssl
make -j $(nproc)
sudo make altinstall

* Verify the installation:
```bash
python3.X --version

## Step 2: Create a New Directory and Virtual Environment
* Create a new directory:
```bash
mkdir cyperf-api
* Navigate to the directory:
```bash
cd cyperf-api
* Create a virtual environment:
```bash
python3.X -m venv env1
* Activate the virtual environment:
```bash
source env1/bin/activate

## Step 3: Clone the CyPerf API Wrapper Repository and install tshark
* Clone the repository:
```bash
git clone https://github.com/Keysight/cyperf-api-wrapper.git
* Navigate to the repository directory:
```bash
cd cyperf-api-wrapper
sudo apt install tshark

## Step 4: Install Dependencies and Build the Package
* Upgrade pip:
```bash
python3 -m pip install --upgrade pip
python3 -m pip install pyshark
* Install poetry:
```bash
python3 -m pip install poetry
* Install dependencies:
```bash
poetry install
* Build the package:
```bash
poetry build

Then import the package:
```python
Expand Down Expand Up @@ -117,7 +176,6 @@ Class | Method | HTTP request | Description
*AgentsApi* | [**start_controllers_set_port_link_state**](docs/AgentsApi.md#start_controllers_set_port_link_state) | **POST** /api/v2/controllers/operations/set-port-link-state |
*ApplicationResourcesApi* | [**delete_resources_capture**](docs/ApplicationResourcesApi.md#delete_resources_capture) | **DELETE** /api/v2/resources/captures/{captureId} |
*ApplicationResourcesApi* | [**delete_resources_certificate**](docs/ApplicationResourcesApi.md#delete_resources_certificate) | **DELETE** /api/v2/resources/certificates/{certificateId} |
*ApplicationResourcesApi* | [**delete_resources_custom_fuzzing_script**](docs/ApplicationResourcesApi.md#delete_resources_custom_fuzzing_script) | **DELETE** /api/v2/resources/custom-fuzzing-scripts/{customFuzzingScriptId} |
*ApplicationResourcesApi* | [**delete_resources_flow_library**](docs/ApplicationResourcesApi.md#delete_resources_flow_library) | **DELETE** /api/v2/resources/flow-library/{flowLibraryId} |
*ApplicationResourcesApi* | [**delete_resources_global_playlist**](docs/ApplicationResourcesApi.md#delete_resources_global_playlist) | **DELETE** /api/v2/resources/global-playlists/{globalPlaylistId} |
*ApplicationResourcesApi* | [**delete_resources_http_library**](docs/ApplicationResourcesApi.md#delete_resources_http_library) | **DELETE** /api/v2/resources/http-library/{httpLibraryId} |
Expand Down Expand Up @@ -151,10 +209,6 @@ Class | Method | HTTP request | Description
*ApplicationResourcesApi* | [**get_resources_certificate_content_file**](docs/ApplicationResourcesApi.md#get_resources_certificate_content_file) | **GET** /api/v2/resources/certificates/{certificateId}/contentFile |
*ApplicationResourcesApi* | [**get_resources_certificates**](docs/ApplicationResourcesApi.md#get_resources_certificates) | **GET** /api/v2/resources/certificates |
*ApplicationResourcesApi* | [**get_resources_certificates_upload_file_result**](docs/ApplicationResourcesApi.md#get_resources_certificates_upload_file_result) | **GET** /api/v2/resources/certificates/operations/uploadFile/{uploadFileId}/result |
*ApplicationResourcesApi* | [**get_resources_custom_fuzzing_script_by_id**](docs/ApplicationResourcesApi.md#get_resources_custom_fuzzing_script_by_id) | **GET** /api/v2/resources/custom-fuzzing-scripts/{customFuzzingScriptId} |
*ApplicationResourcesApi* | [**get_resources_custom_fuzzing_script_content_file**](docs/ApplicationResourcesApi.md#get_resources_custom_fuzzing_script_content_file) | **GET** /api/v2/resources/custom-fuzzing-scripts/{customFuzzingScriptId}/contentFile |
*ApplicationResourcesApi* | [**get_resources_custom_fuzzing_scripts**](docs/ApplicationResourcesApi.md#get_resources_custom_fuzzing_scripts) | **GET** /api/v2/resources/custom-fuzzing-scripts |
*ApplicationResourcesApi* | [**get_resources_custom_fuzzing_scripts_upload_file_result**](docs/ApplicationResourcesApi.md#get_resources_custom_fuzzing_scripts_upload_file_result) | **GET** /api/v2/resources/custom-fuzzing-scripts/operations/uploadFile/{uploadFileId}/result |
*ApplicationResourcesApi* | [**get_resources_flow_library**](docs/ApplicationResourcesApi.md#get_resources_flow_library) | **GET** /api/v2/resources/flow-library |
*ApplicationResourcesApi* | [**get_resources_flow_library_by_id**](docs/ApplicationResourcesApi.md#get_resources_flow_library_by_id) | **GET** /api/v2/resources/flow-library/{flowLibraryId} |
*ApplicationResourcesApi* | [**get_resources_flow_library_content_file**](docs/ApplicationResourcesApi.md#get_resources_flow_library_content_file) | **GET** /api/v2/resources/flow-library/{flowLibraryId}/contentFile |
Expand Down Expand Up @@ -223,9 +277,7 @@ Class | Method | HTTP request | Description
*ApplicationResourcesApi* | [**poll_resources_captures_batch_delete**](docs/ApplicationResourcesApi.md#poll_resources_captures_batch_delete) | **GET** /api/v2/resources/captures/operations/batch-delete/{id} |
*ApplicationResourcesApi* | [**poll_resources_captures_upload_file**](docs/ApplicationResourcesApi.md#poll_resources_captures_upload_file) | **GET** /api/v2/resources/captures/operations/uploadFile/{uploadFileId} |
*ApplicationResourcesApi* | [**poll_resources_certificates_upload_file**](docs/ApplicationResourcesApi.md#poll_resources_certificates_upload_file) | **GET** /api/v2/resources/certificates/operations/uploadFile/{uploadFileId} |
*ApplicationResourcesApi* | [**poll_resources_config_export_user_defined_apps**](docs/ApplicationResourcesApi.md#poll_resources_config_export_user_defined_apps) | **GET** /api/v2/resources/configs/{configId}/operations/export-user-defined-apps/{id} |
*ApplicationResourcesApi* | [**poll_resources_create_app**](docs/ApplicationResourcesApi.md#poll_resources_create_app) | **GET** /api/v2/resources/operations/create-app/{id} |
*ApplicationResourcesApi* | [**poll_resources_custom_fuzzing_scripts_upload_file**](docs/ApplicationResourcesApi.md#poll_resources_custom_fuzzing_scripts_upload_file) | **GET** /api/v2/resources/custom-fuzzing-scripts/operations/uploadFile/{uploadFileId} |
*ApplicationResourcesApi* | [**poll_resources_edit_app**](docs/ApplicationResourcesApi.md#poll_resources_edit_app) | **GET** /api/v2/resources/operations/edit-app/{id} |
*ApplicationResourcesApi* | [**poll_resources_find_param_matches**](docs/ApplicationResourcesApi.md#poll_resources_find_param_matches) | **GET** /api/v2/resources/operations/find-param-matches/{id} |
*ApplicationResourcesApi* | [**poll_resources_flow_library_upload_file**](docs/ApplicationResourcesApi.md#poll_resources_flow_library_upload_file) | **GET** /api/v2/resources/flow-library/operations/uploadFile/{uploadFileId} |
Expand All @@ -252,9 +304,7 @@ Class | Method | HTTP request | Description
*ApplicationResourcesApi* | [**start_resources_captures_batch_delete**](docs/ApplicationResourcesApi.md#start_resources_captures_batch_delete) | **POST** /api/v2/resources/captures/operations/batch-delete |
*ApplicationResourcesApi* | [**start_resources_captures_upload_file**](docs/ApplicationResourcesApi.md#start_resources_captures_upload_file) | **POST** /api/v2/resources/captures/operations/uploadFile |
*ApplicationResourcesApi* | [**start_resources_certificates_upload_file**](docs/ApplicationResourcesApi.md#start_resources_certificates_upload_file) | **POST** /api/v2/resources/certificates/operations/uploadFile |
*ApplicationResourcesApi* | [**start_resources_config_export_user_defined_apps**](docs/ApplicationResourcesApi.md#start_resources_config_export_user_defined_apps) | **POST** /api/v2/resources/configs/{configId}/operations/export-user-defined-apps |
*ApplicationResourcesApi* | [**start_resources_create_app**](docs/ApplicationResourcesApi.md#start_resources_create_app) | **POST** /api/v2/resources/operations/create-app |
*ApplicationResourcesApi* | [**start_resources_custom_fuzzing_scripts_upload_file**](docs/ApplicationResourcesApi.md#start_resources_custom_fuzzing_scripts_upload_file) | **POST** /api/v2/resources/custom-fuzzing-scripts/operations/uploadFile |
*ApplicationResourcesApi* | [**start_resources_edit_app**](docs/ApplicationResourcesApi.md#start_resources_edit_app) | **POST** /api/v2/resources/operations/edit-app |
*ApplicationResourcesApi* | [**start_resources_find_param_matches**](docs/ApplicationResourcesApi.md#start_resources_find_param_matches) | **POST** /api/v2/resources/operations/find-param-matches |
*ApplicationResourcesApi* | [**start_resources_flow_library_upload_file**](docs/ApplicationResourcesApi.md#start_resources_flow_library_upload_file) | **POST** /api/v2/resources/flow-library/operations/uploadFile |
Expand Down Expand Up @@ -352,6 +402,7 @@ Class | Method | HTTP request | Description
*SessionsApi* | [**create_sessions**](docs/SessionsApi.md#create_sessions) | **POST** /api/v2/sessions |
*SessionsApi* | [**delete_session**](docs/SessionsApi.md#delete_session) | **DELETE** /api/v2/sessions/{sessionId} |
*SessionsApi* | [**delete_session_meta**](docs/SessionsApi.md#delete_session_meta) | **DELETE** /api/v2/sessions/{sessionId}/meta/{metaId} |
*SessionsApi* | [**get_appsec_ui_metadata**](docs/SessionsApi.md#get_appsec_ui_metadata) | **GET** /api/v2/appsec-ui-metadata |
*SessionsApi* | [**get_config_docs**](docs/SessionsApi.md#get_config_docs) | **GET** /api/v2/sessions/{sessionId}/config/$docs |
*SessionsApi* | [**get_config_granular_stats**](docs/SessionsApi.md#get_config_granular_stats) | **GET** /api/v2/sessions/{sessionId}/config/granular-stats |
*SessionsApi* | [**get_config_granular_stats_filters**](docs/SessionsApi.md#get_config_granular_stats_filters) | **GET** /api/v2/sessions/{sessionId}/config/granular-stats-filters |
Expand All @@ -365,8 +416,8 @@ Class | Method | HTTP request | Description
*SessionsApi* | [**patch_session_meta**](docs/SessionsApi.md#patch_session_meta) | **PATCH** /api/v2/sessions/{sessionId}/meta/{metaId} |
*SessionsApi* | [**patch_session_test**](docs/SessionsApi.md#patch_session_test) | **PATCH** /api/v2/sessions/{sessionId}/test |
*SessionsApi* | [**poll_config_add_applications**](docs/SessionsApi.md#poll_config_add_applications) | **GET** /api/v2/sessions/{sessionId}/config/config/TrafficProfiles/{trafficProfileId}/operations/add-applications/{id} |
*SessionsApi* | [**poll_config_save**](docs/SessionsApi.md#poll_config_save) | **GET** /api/v2/sessions/{sessionId}/config/operations/save/{id} |
*SessionsApi* | [**poll_session_config_granular_stats_default_dashboards**](docs/SessionsApi.md#poll_session_config_granular_stats_default_dashboards) | **GET** /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards/{id} |
*SessionsApi* | [**poll_session_config_save**](docs/SessionsApi.md#poll_session_config_save) | **GET** /api/v2/sessions/{sessionId}/config/operations/save/{id} |
*SessionsApi* | [**poll_session_load_config**](docs/SessionsApi.md#poll_session_load_config) | **GET** /api/v2/sessions/{sessionId}/operations/loadConfig/{id} |
*SessionsApi* | [**poll_session_prepare_test**](docs/SessionsApi.md#poll_session_prepare_test) | **GET** /api/v2/sessions/{sessionId}/operations/prepareTest/{id} |
*SessionsApi* | [**poll_session_test_end**](docs/SessionsApi.md#poll_session_test_end) | **GET** /api/v2/sessions/{sessionId}/operations/testEnd/{id} |
Expand Down Expand Up @@ -463,7 +514,6 @@ Class | Method | HTTP request | Description
- [ActivationCodeInfo](docs/ActivationCodeInfo.md)
- [ActivationCodeListRequest](docs/ActivationCodeListRequest.md)
- [ActivationCodeRequest](docs/ActivationCodeRequest.md)
- [AddActionInfo](docs/AddActionInfo.md)
- [AddInput](docs/AddInput.md)
- [AdvancedSettings](docs/AdvancedSettings.md)
- [Agent](docs/Agent.md)
Expand Down Expand Up @@ -497,15 +547,12 @@ Class | Method | HTTP request | Description
- [AsyncOperationResponse](docs/AsyncOperationResponse.md)
- [Attack](docs/Attack.md)
- [AttackAction](docs/AttackAction.md)
- [AttackMetadata](docs/AttackMetadata.md)
- [AttackMetadataKeywordsInner](docs/AttackMetadataKeywordsInner.md)
- [AttackObjectivesAndTimeline](docs/AttackObjectivesAndTimeline.md)
- [AttackProfile](docs/AttackProfile.md)
- [AttackTimelineSegment](docs/AttackTimelineSegment.md)
- [AttackTrack](docs/AttackTrack.md)
- [AuthMethodType](docs/AuthMethodType.md)
- [AuthProfile](docs/AuthProfile.md)
- [AuthProfileMetadata](docs/AuthProfileMetadata.md)
- [AuthSettings](docs/AuthSettings.md)
- [Authenticate200Response](docs/Authenticate200Response.md)
- [AuthenticationSettings](docs/AuthenticationSettings.md)
Expand All @@ -532,6 +579,7 @@ Class | Method | HTTP request | Description
- [ConfigCategory](docs/ConfigCategory.md)
- [ConfigId](docs/ConfigId.md)
- [ConfigMetadata](docs/ConfigMetadata.md)
- [ConfigMetadataConfigDataValue](docs/ConfigMetadataConfigDataValue.md)
- [ConfigValidation](docs/ConfigValidation.md)
- [Conflict](docs/Conflict.md)
- [Connection](docs/Connection.md)
Expand All @@ -541,7 +589,6 @@ Class | Method | HTTP request | Description
- [CountedFeatureConsumer](docs/CountedFeatureConsumer.md)
- [CountedFeatureStats](docs/CountedFeatureStats.md)
- [CreateAppOperation](docs/CreateAppOperation.md)
- [CreateAppOrAttackOperationInput](docs/CreateAppOrAttackOperationInput.md)
- [CustomDashboards](docs/CustomDashboards.md)
- [CustomImportHandler](docs/CustomImportHandler.md)
- [CustomStat](docs/CustomStat.md)
Expand Down Expand Up @@ -850,6 +897,5 @@ Authentication schemes defined for the API:

## Author

support@keysight.com

soumya.neogy@keysight.com

Loading
Loading