KAI Inference Builder REST API
This Python package is automatically generated by the OpenAPI Generator project:
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.11+
You can install directly by doing:
pip install .from the base of this repository.
Then import the package:
import kai_inference_builderPlease follow the installation procedure and then run the following:
import kai_inference_builder
from kai_inference_builder.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 = kai_inference_builder.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_KAI_IB_UI"]
configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_KAI_IB_UI"]
# Enter a context with an instance of the API client
with kai_inference_builder.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kai_inference_builder.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)All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AgentsApi | delete_agent | DELETE /kai-ib/api/v2/agents/{agentId} | |
| AgentsApi | get_agent_by_id | GET /kai-ib/api/v2/agents/{agentId} | |
| AgentsApi | get_agents | GET /kai-ib/api/v2/agents | |
| AgentsApi | get_compute_node_port_by_id | GET /kai-ib/api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/ports/{portId} | |
| AgentsApi | get_compute_node_ports | GET /kai-ib/api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/ports | |
| AgentsApi | get_controller_by_id | GET /kai-ib/api/v2/controllers/{controllerId} | |
| AgentsApi | get_controller_compute_node_by_id | GET /kai-ib/api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId} | |
| AgentsApi | get_controller_compute_nodes | GET /kai-ib/api/v2/controllers/{controllerId}/compute-nodes | |
| AgentsApi | get_controllers | GET /kai-ib/api/v2/controllers | |
| AgentsApi | get_tags | GET /kai-ib/api/v2/tags | |
| AgentsApi | patch_agent | PATCH /kai-ib/api/v2/agents/{agentId} | |
| AgentsApi | start_agents_batch_delete | POST /kai-ib/api/v2/agents/operations/batch-delete | |
| AgentsApi | start_agents_export_files | POST /kai-ib/api/v2/agents/operations/exportFiles | |
| AgentsApi | start_agents_reboot | POST /kai-ib/api/v2/agents/operations/reboot | |
| AgentsApi | start_agents_release | POST /kai-ib/api/v2/agents/operations/release | |
| AgentsApi | start_agents_reserve | POST /kai-ib/api/v2/agents/operations/reserve | |
| AgentsApi | start_agents_set_dpdk_mode | POST /kai-ib/api/v2/agents/operations/set-dpdk-mode | |
| AgentsApi | start_agents_set_ntp | POST /kai-ib/api/v2/agents/operations/set-ntp | |
| AgentsApi | start_agents_update | POST /kai-ib/api/v2/agents/operations/update | |
| AgentsApi | start_controllers_clear_port_ownership | POST /kai-ib/api/v2/controllers/operations/clear-port-ownership | |
| AgentsApi | start_controllers_power_cycle_nodes | POST /kai-ib/api/v2/controllers/operations/power-cycle-nodes | |
| AgentsApi | start_controllers_reboot_port | POST /kai-ib/api/v2/controllers/operations/reboot-port | |
| AgentsApi | start_controllers_set_app | POST /kai-ib/api/v2/controllers/operations/set-app | |
| AgentsApi | start_controllers_set_node_aggregation | POST /kai-ib/api/v2/controllers/operations/set-node-aggregation | |
| AgentsApi | start_controllers_set_node_app | POST /kai-ib/api/v2/controllers/operations/set-node-app | |
| AgentsApi | start_controllers_set_port_link_state | POST /kai-ib/api/v2/controllers/operations/set-port-link-state | |
| AgentsApi | start_controllers_update_port_tags | POST /kai-ib/api/v2/controllers/operations/update-port-tags | |
| ApplicationResourcesApi | get_resources_profile_by_id | GET /kai-ib/api/v2/resources/profiles/{profileId} | |
| ApplicationResourcesApi | get_resources_profile_icon | GET /kai-ib/api/v2/resources/profiles/{profileId}/icon | |
| ApplicationResourcesApi | get_resources_profile_topology_img | GET /kai-ib/api/v2/resources/profiles/{profileId}/topologyImg | |
| ApplicationResourcesApi | get_resources_profiles | GET /kai-ib/api/v2/resources/profiles | |
| ApplicationResourcesApi | get_resources_sub_profile_by_id | GET /kai-ib/api/v2/resources/sub-profiles/{subProfileId} | |
| ApplicationResourcesApi | get_resources_sub_profile_categories | GET /kai-ib/api/v2/resources/sub-profile-categories | |
| ApplicationResourcesApi | get_resources_sub_profiles | GET /kai-ib/api/v2/resources/sub-profiles | |
| ApplicationResourcesApi | get_sub_profile_formatted_description | GET /kai-ib/api/v2/resources/sub-profiles/{subProfileId}/formattedDescription | |
| ApplicationResourcesApi | get_sub_profile_keywords | GET /kai-ib/api/v2/resources/sub-profiles/{subProfileId}/keywords | |
| ApplicationResourcesApi | start_resources_get_sub_profile_categories | POST /kai-ib/api/v2/resources/operations/get-sub-profile-categories | |
| ApplicationResourcesApi | start_resources_get_sub_profiles | POST /kai-ib/api/v2/resources/operations/get-sub-profiles | |
| ApplicationResourcesApi | start_resources_sub_profile_modify_excluded_dut_recursively | POST /kai-ib/api/v2/resources/sub-profiles/{subProfileId}/operations/modify-excluded-dut-recursively | |
| ApplicationResourcesApi | start_resources_sub_profile_modify_tags_recursively | POST /kai-ib/api/v2/resources/sub-profiles/{subProfileId}/operations/modify-tags-recursively | |
| AuthorizationApi | authenticate | POST /auth/realms/keysight/protocol/openid-connect/token | |
| ConfigurationsApi | create_configs | POST /kai-ib/api/v2/configs | |
| ConfigurationsApi | delete_config | DELETE /kai-ib/api/v2/configs/{configId} | |
| ConfigurationsApi | get_config_by_id | GET /kai-ib/api/v2/configs/{configId} | |
| ConfigurationsApi | get_config_categorie_by_id | GET /kai-ib/api/v2/config-categories/{configCategorieId} | |
| ConfigurationsApi | get_config_categorie_subcategories | GET /kai-ib/api/v2/config-categories/{configCategorieId}/subcategories | |
| ConfigurationsApi | get_config_categories | GET /kai-ib/api/v2/config-categories | |
| ConfigurationsApi | get_configs | GET /kai-ib/api/v2/configs | |
| ConfigurationsApi | get_resources_custom_import_operations | GET /kai-ib/api/v2/resources/custom-import-operations | |
| ConfigurationsApi | patch_config | PATCH /kai-ib/api/v2/configs/{configId} | |
| ConfigurationsApi | start_configs_batch_delete | POST /kai-ib/api/v2/configs/operations/batch-delete | |
| ConfigurationsApi | start_configs_export_all | POST /kai-ib/api/v2/configs/operations/exportAll | |
| ConfigurationsApi | start_configs_import | POST /kai-ib/api/v2/configs/operations/import | |
| ConfigurationsApi | start_configs_import_all | POST /kai-ib/api/v2/configs/operations/importAll | |
| ConfigurationsApi | update_config | PUT /kai-ib/api/v2/configs/{configId} | |
| 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 | |
| KAIInferenceBuilderDataModelApi | create_dns_resolver_name_servers | POST /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers | |
| KAIInferenceBuilderDataModelApi | create_network_ip_ranges | POST /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges | |
| KAIInferenceBuilderDataModelApi | create_network_profile_duts | POST /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts | |
| KAIInferenceBuilderDataModelApi | create_network_profile_networks | POST /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks | |
| KAIInferenceBuilderDataModelApi | delete_config_sub_profile | DELETE /kai-ib/api/v2/sessions/{sessionId}/config/subProfiles/{subProfileId} | |
| KAIInferenceBuilderDataModelApi | delete_network_ip_range | DELETE /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges/{ipRangeId} | |
| KAIInferenceBuilderDataModelApi | delete_network_profile_dut | DELETE /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts/{dutId} | |
| KAIInferenceBuilderDataModelApi | delete_network_profile_network | DELETE /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId} | |
| KAIInferenceBuilderDataModelApi | get_assigned_agents_id_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId} | |
| KAIInferenceBuilderDataModelApi | get_assigned_agents_ids | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids | |
| KAIInferenceBuilderDataModelApi | get_assigned_agents_port_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId} | |
| KAIInferenceBuilderDataModelApi | get_assigned_agents_ports | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports | |
| KAIInferenceBuilderDataModelApi | get_config_network_profile | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile | |
| KAIInferenceBuilderDataModelApi | get_config_objectives_and_timeline | GET /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline | |
| KAIInferenceBuilderDataModelApi | get_config_sub_profile_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/subProfiles/{subProfileId} | |
| KAIInferenceBuilderDataModelApi | get_config_sub_profiles | GET /kai-ib/api/v2/sessions/{sessionId}/config/subProfiles | |
| KAIInferenceBuilderDataModelApi | get_dns_resolver_name_server_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers/{nameServerId} | |
| KAIInferenceBuilderDataModelApi | get_dns_resolver_name_servers | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers | |
| KAIInferenceBuilderDataModelApi | get_id_capture_settings | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | get_network_assigned_agents | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents | |
| KAIInferenceBuilderDataModelApi | get_network_dns_resolver | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver | |
| KAIInferenceBuilderDataModelApi | get_network_ip_range_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges/{ipRangeId} | |
| KAIInferenceBuilderDataModelApi | get_network_ip_ranges | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges | |
| KAIInferenceBuilderDataModelApi | get_network_profile_dut_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts/{dutId} | |
| KAIInferenceBuilderDataModelApi | get_network_profile_duts | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts | |
| KAIInferenceBuilderDataModelApi | get_network_profile_network_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId} | |
| KAIInferenceBuilderDataModelApi | get_network_profile_networks | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks | |
| KAIInferenceBuilderDataModelApi | get_objectives_and_timeline_primary_objective | GET /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/primaryObjective | |
| KAIInferenceBuilderDataModelApi | get_objectives_and_timeline_secondary_objective | GET /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/secondaryObjective | |
| KAIInferenceBuilderDataModelApi | get_port_capture_settings | GET /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | get_session_config | GET /kai-ib/api/v2/sessions/{sessionId}/config | |
| KAIInferenceBuilderDataModelApi | patch_assigned_agents_id | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId} | |
| KAIInferenceBuilderDataModelApi | patch_assigned_agents_port | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId} | |
| KAIInferenceBuilderDataModelApi | patch_config_network_profile | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile | |
| KAIInferenceBuilderDataModelApi | patch_config_objectives_and_timeline | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline | |
| KAIInferenceBuilderDataModelApi | patch_config_sub_profile | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/subProfiles/{subProfileId} | |
| KAIInferenceBuilderDataModelApi | patch_dns_resolver_name_server | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers/{nameServerId} | |
| KAIInferenceBuilderDataModelApi | patch_id_capture_settings | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | patch_network_assigned_agents | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents | |
| KAIInferenceBuilderDataModelApi | patch_network_dns_resolver | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver | |
| KAIInferenceBuilderDataModelApi | patch_network_ip_range | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges/{ipRangeId} | |
| KAIInferenceBuilderDataModelApi | patch_network_profile_dut | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts/{dutId} | |
| KAIInferenceBuilderDataModelApi | patch_network_profile_network | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId} | |
| KAIInferenceBuilderDataModelApi | patch_objectives_and_timeline_primary_objective | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/primaryObjective | |
| KAIInferenceBuilderDataModelApi | patch_objectives_and_timeline_secondary_objective | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/secondaryObjective | |
| KAIInferenceBuilderDataModelApi | patch_port_capture_settings | PATCH /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | start_session_config_add_sub_profiles | POST /kai-ib/api/v2/sessions/{sessionId}/config/operations/addSubProfiles | |
| KAIInferenceBuilderDataModelApi | start_session_config_save_kai_ib_session_config | POST /kai-ib/api/v2/sessions/{sessionId}/config/operations/saveKaiIbSessionConfig | |
| KAIInferenceBuilderDataModelApi | start_session_load_kai_ib_session_config | POST /kai-ib/api/v2/sessions/{sessionId}/operations/loadKaiIbSessionConfig | |
| KAIInferenceBuilderDataModelApi | start_session_test_end | POST /kai-ib/api/v2/sessions/{sessionId}/operations/testEnd | |
| KAIInferenceBuilderDataModelApi | start_session_test_init | POST /kai-ib/api/v2/sessions/{sessionId}/operations/testInit | |
| KAIInferenceBuilderDataModelApi | update_assigned_agents_id | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId} | |
| KAIInferenceBuilderDataModelApi | update_assigned_agents_ids | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids | |
| KAIInferenceBuilderDataModelApi | update_assigned_agents_port | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId} | |
| KAIInferenceBuilderDataModelApi | update_assigned_agents_ports | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports | |
| KAIInferenceBuilderDataModelApi | update_config_network_profile | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile | |
| KAIInferenceBuilderDataModelApi | update_config_objectives_and_timeline | PUT /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline | |
| KAIInferenceBuilderDataModelApi | update_config_sub_profile | PUT /kai-ib/api/v2/sessions/{sessionId}/config/subProfiles/{subProfileId} | |
| KAIInferenceBuilderDataModelApi | update_dns_resolver_name_server | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers/{nameServerId} | |
| KAIInferenceBuilderDataModelApi | update_dns_resolver_name_servers | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver/nameServers | |
| KAIInferenceBuilderDataModelApi | update_id_capture_settings | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ids/{idId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | update_network_assigned_agents | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents | |
| KAIInferenceBuilderDataModelApi | update_network_dns_resolver | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/dnsResolver | |
| KAIInferenceBuilderDataModelApi | update_network_ip_range | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges/{ipRangeId} | |
| KAIInferenceBuilderDataModelApi | update_network_ip_ranges | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/ipRanges | |
| KAIInferenceBuilderDataModelApi | update_network_profile_dut | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/duts/{dutId} | |
| KAIInferenceBuilderDataModelApi | update_network_profile_network | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId} | |
| KAIInferenceBuilderDataModelApi | update_objectives_and_timeline_primary_objective | PUT /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/primaryObjective | |
| KAIInferenceBuilderDataModelApi | update_objectives_and_timeline_secondary_objective | PUT /kai-ib/api/v2/sessions/{sessionId}/config/objectivesAndTimeline/secondaryObjective | |
| KAIInferenceBuilderDataModelApi | update_port_capture_settings | PUT /kai-ib/api/v2/sessions/{sessionId}/config/networkProfile/networks/{networkId}/assignedAgents/ports/{portId}/captureSettings | |
| KAIInferenceBuilderDataModelApi | update_session_config | PUT /kai-ib/api/v2/sessions/{sessionId}/config | |
| LicenseServersApi | create_license_servers | POST /kai-ib/api/v2/license-servers | |
| LicenseServersApi | delete_license_server | DELETE /kai-ib/api/v2/license-servers/{licenseServerId} | |
| LicenseServersApi | get_license_server_by_id | GET /kai-ib/api/v2/license-servers/{licenseServerId} | |
| LicenseServersApi | get_license_servers | GET /kai-ib/api/v2/license-servers | |
| LicenseServersApi | patch_license_server | PATCH /kai-ib/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 /kai-ib/api/v2/notifications/{notificationId} | |
| NotificationsApi | get_notification_by_id | GET /kai-ib/api/v2/notifications/{notificationId} | |
| NotificationsApi | get_notification_counts | GET /kai-ib/api/v2/notification-counts | |
| NotificationsApi | get_notifications | GET /kai-ib/api/v2/notifications | |
| NotificationsApi | start_notifications_cleanup | POST /kai-ib/api/v2/notifications/operations/cleanup | |
| NotificationsApi | start_notifications_dismiss | POST /kai-ib/api/v2/notifications/operations/dismiss | |
| ReportsApi | download_pdf | GET /kai-ib/api/v2/results/{resultId}/download-pdf/{pdfId} | |
| ReportsApi | get_result_download_csv_by_id | GET /kai-ib/api/v2/results/{resultId}/download-csv/{downloadCsvId} | |
| ReportsApi | start_result_generate_csv | POST /kai-ib/api/v2/results/{resultId}/operations/generate-csv | |
| ReportsApi | start_result_generate_pdf | POST /kai-ib/api/v2/results/{resultId}/operations/generate-pdf | |
| SessionsApi | create_session_meta | POST /kai-ib/api/v2/sessions/{sessionId}/meta | |
| SessionsApi | create_sessions | POST /kai-ib/api/v2/sessions | |
| SessionsApi | delete_session | DELETE /kai-ib/api/v2/sessions/{sessionId} | |
| SessionsApi | delete_session_meta | DELETE /kai-ib/api/v2/sessions/{sessionId}/meta/{metaId} | |
| SessionsApi | get_session_by_id | GET /kai-ib/api/v2/sessions/{sessionId} | |
| SessionsApi | get_session_meta | GET /kai-ib/api/v2/sessions/{sessionId}/meta | |
| SessionsApi | get_session_meta_by_id | GET /kai-ib/api/v2/sessions/{sessionId}/meta/{metaId} | |
| SessionsApi | get_session_test | GET /kai-ib/api/v2/sessions/{sessionId}/test | |
| SessionsApi | get_sessions | GET /kai-ib/api/v2/sessions | |
| SessionsApi | patch_session | PATCH /kai-ib/api/v2/sessions/{sessionId} | |
| SessionsApi | patch_session_meta | PATCH /kai-ib/api/v2/sessions/{sessionId}/meta/{metaId} | |
| SessionsApi | patch_session_test | PATCH /kai-ib/api/v2/sessions/{sessionId}/test | |
| SessionsApi | start_session_load_config | POST /kai-ib/api/v2/sessions/{sessionId}/operations/loadConfig | |
| SessionsApi | start_session_touch | POST /kai-ib/api/v2/sessions/{sessionId}/operations/touch | |
| SessionsApi | start_sessions_batch_delete | POST /kai-ib/api/v2/sessions/operations/batch-delete | |
| SessionsApi | update_session | PUT /kai-ib/api/v2/sessions/{sessionId} | |
| SessionsApi | update_session_meta | PUT /kai-ib/api/v2/sessions/{sessionId}/meta | |
| SessionsApi | update_session_test | PUT /kai-ib/api/v2/sessions/{sessionId}/test | |
| StatisticsApi | create_stats_plugins | POST /kai-ib/api/v2/stats/plugins | |
| StatisticsApi | delete_stats_plugin | DELETE /kai-ib/api/v2/stats/plugins/{pluginId} | |
| StatisticsApi | get_result_stat_by_id | GET /kai-ib/api/v2/results/{resultId}/stats/{statId} | |
| StatisticsApi | get_result_stats | GET /kai-ib/api/v2/results/{resultId}/stats | |
| StatisticsApi | get_stats_plugins | GET /kai-ib/api/v2/stats/plugins | |
| StatisticsApi | start_stats_plugins_ingest | POST /kai-ib/api/v2/stats/plugins/operations/ingest | |
| TelemetryCollectorApi | create_telemetry_collector_telemetry_servers | POST /kai-ib/api/v2/telemetry-collector/telemetry-servers | |
| TelemetryCollectorApi | delete_telemetry_collector_telemetry_server | DELETE /kai-ib/api/v2/telemetry-collector/telemetry-servers/{telemetryServerId} | |
| TelemetryCollectorApi | get_telemetry_collector_telemetry_server_by_id | GET /kai-ib/api/v2/telemetry-collector/telemetry-servers/{telemetryServerId} | |
| TelemetryCollectorApi | get_telemetry_collector_telemetry_servers | GET /kai-ib/api/v2/telemetry-collector/telemetry-servers | |
| TelemetryCollectorApi | patch_telemetry_collector_telemetry_server | PATCH /kai-ib/api/v2/telemetry-collector/telemetry-servers/{telemetryServerId} | |
| TelemetryCollectorApi | start_telemetry_collector_check_reachability | POST /kai-ib/api/v2/telemetry-collector/operations/checkReachability | |
| TestOperationsApi | start_test_run_abort | POST /kai-ib/api/v2/sessions/{sessionId}/test-run/operations/abort | |
| TestOperationsApi | start_test_run_start | POST /kai-ib/api/v2/sessions/{sessionId}/test-run/operations/start | |
| TestOperationsApi | start_test_run_stop | POST /kai-ib/api/v2/sessions/{sessionId}/test-run/operations/stop | |
| TestResultsApi | delete_result | DELETE /kai-ib/api/v2/results/{resultId} | |
| TestResultsApi | delete_result_file | DELETE /kai-ib/api/v2/results/{resultId}/files/{fileId} | |
| TestResultsApi | get_result_by_id | GET /kai-ib/api/v2/results/{resultId} | |
| TestResultsApi | get_result_download_all_by_id | GET /kai-ib/api/v2/results/{resultId}/download-all/{downloadAllId} | |
| TestResultsApi | get_result_download_result_config | GET /kai-ib/api/v2/results/{resultId}/download-result-config | |
| TestResultsApi | get_result_file_by_id | GET /kai-ib/api/v2/results/{resultId}/files/{fileId} | |
| TestResultsApi | get_result_file_content | GET /kai-ib/api/v2/results/{resultId}/files/{fileId}/content | |
| TestResultsApi | get_result_files | GET /kai-ib/api/v2/results/{resultId}/files | |
| TestResultsApi | get_results | GET /kai-ib/api/v2/results | |
| TestResultsApi | get_results_tags | GET /kai-ib/api/v2/results/tags | |
| TestResultsApi | start_result_export_events | POST /kai-ib/api/v2/results/{resultId}/operations/export-events | |
| TestResultsApi | start_result_generate_all | POST /kai-ib/api/v2/results/{resultId}/operations/generate-all | |
| TestResultsApi | start_result_generate_results | POST /kai-ib/api/v2/results/{resultId}/operations/generate-results | |
| TestResultsApi | start_result_load | POST /kai-ib/api/v2/results/{resultId}/operations/load | |
| TestResultsApi | start_results_batch_delete | POST /kai-ib/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 /kai-ib/api/v2/cert-manager/certificate | |
| UtilsApi | get_disk_usage | GET /kai-ib/api/v2/disk-usage | |
| UtilsApi | get_disk_usage_consumer_by_id | GET /kai-ib/api/v2/disk-usage/consumers/{consumerId} | |
| UtilsApi | get_disk_usage_consumers | GET /kai-ib/api/v2/disk-usage/consumers | |
| UtilsApi | get_eula | GET /eula/v1/eula/{id} | Retrieve EULA detail |
| UtilsApi | list_eulas | GET /eula/v1/eula | list of EULAs |
| UtilsApi | post_eula | POST /eula/v1/eula/{id} | Update properties an EULA |
| UtilsApi | start_cert_manager_generate | POST /kai-ib/api/v2/cert-manager/operations/generate | |
| UtilsApi | start_cert_manager_upload | POST /kai-ib/api/v2/cert-manager/operations/upload | |
| UtilsApi | start_disk_usage_cleanup_diagnostics | POST /kai-ib/api/v2/disk-usage/operations/cleanup-diagnostics | |
| UtilsApi | start_disk_usage_cleanup_logs | POST /kai-ib/api/v2/disk-usage/operations/cleanup-logs | |
| UtilsApi | start_disk_usage_cleanup_migration | POST /kai-ib/api/v2/disk-usage/operations/cleanup-migration | |
| UtilsApi | start_disk_usage_cleanup_notifications | POST /kai-ib/api/v2/disk-usage/operations/cleanup-notifications | |
| UtilsApi | start_disk_usage_cleanup_results | POST /kai-ib/api/v2/disk-usage/operations/cleanup-results |
- APILink
- APIRelationship
- Action
- ActionBase
- ActivationCodeInfo
- ActivationCodeListRequest
- ActivationCodeRequest
- AddActionInfo
- AddSubProfilesOperation
- Address
- AdvancedSettings
- Agent
- AgentAssignmentByPort
- AgentAssignmentDetails
- AgentAssignments
- AgentCPUInfo
- AgentFeatures
- AgentOptimizationMode
- AgentRelease
- AgentReservation
- AgentToBeRebooted
- AgentsGroup
- AppMode
- Application
- ApplicationProfile
- ArchiveInfo
- AssignedAgent
- AssignedAgents
- AssignedPort
- AsyncContext
- Attack
- AttackAction
- AttackObjectivesAndTimeline
- AttackProfile
- AttackTimelineSegment
- AttackTrack
- AuthMethodType
- AuthSettings
- Authenticate200Response
- AuthenticationSettings
- AutomaticIpType
- BasicAuthProfile
- CaptureSettings
- Category
- CategoryFilter
- CategoryValue
- CertConfig
- Certificate
- ChassisInfo
- Choice
- CipherTLS12
- CipherTLS13
- CiscoAnyConnectSettings
- CiscoEncapsulation
- ClassicalSignatureAlgorithmTLS13
- ClearPortsOwnershipOperation
- CompositePqcSignatureAlgorithmTLS13
- ComputeNode
- Config
- ConfigCategory
- ConfigId
- ConfigMetadata
- ConfigMetadataConfigDataValue
- ConfigSubCategory
- ConfigValidation
- Conflict
- Connection
- ConnectionPersistence
- Consumer
- ContentBlock
- Controller
- CountedFeatureConsumer
- CountedFeatureStats
- CreateAppOrAttackOperationInput
- CustomDashboards
- CustomImportHandler
- CustomSequence
- DNSResolver
- DNSServer
- DTLSSettings
- DUTNetwork
- DUTRange
- Dashboard
- DataType
- DataTypeValuesInner
- DhP1Group
- DiagnosticComponent
- DiagnosticComponentContext
- DiagnosticOptions
- DiskUsage
- DismissOperation
- Dut
- ESPOverUDPSettings
- EffectivePorts
- EmulatedRouter
- EmulatedRouterRange
- EmulatedSubnetConfig
- EncP1Algorithm
- EncP2Algorithm
- Endpoint
- EntitlementCodeInfo
- EntitlementCodeRequest
- ErrorDescription
- ErrorResponse
- EthRange
- EulaDetails
- EulaSummary
- Exchange
- ExpectedDiskSpace
- ExpectedDiskSpaceMessage
- ExpectedDiskSpacePrettySize
- ExpectedDiskSpaceSize
- ExportAllOperation
- ExportFilesOperationInput
- ExportFilesRequest
- ExternalResourceInfo
- F5Encapsulation
- F5Settings
- Feature
- FeatureReservation
- FeatureReservationReserve
- FileValue
- Filter
- FilteredStat
- FormattedDescription
- FortinetEncapsulation
- FortinetSettings
- FulfillmentRequest
- GenerateAllOperation
- GenerateCSVReportsOperation
- GeneratePDFReportOperation
- GetAsyncOperationResult200Response
- GetCategoriesOperation
- GetConfigCategorieSubcategories200Response
- GetConfigCategorieSubcategories200ResponseOneOf
- GetConfigCategories200Response
- GetConfigCategories200ResponseOneOf
- GetConfigs200Response
- GetConfigs200ResponseOneOf
- GetControllers200Response
- GetControllers200ResponseOneOf
- GetDiskUsageConsumers200Response
- GetDiskUsageConsumers200ResponseOneOf
- GetLicenseAsyncOperationResult200Response
- GetLicenseServers200Response
- GetLicenseServers200ResponseOneOf
- GetNotifications200Response
- GetNotifications200ResponseOneOf
- GetResourcesCustomImportOperations200Response
- GetResourcesCustomImportOperations200ResponseOneOf
- GetResourcesProfiles200Response
- GetResourcesProfiles200ResponseOneOf
- GetResourcesSubProfiles200Response
- GetResourcesSubProfiles200ResponseOneOf
- GetResultFiles200Response
- GetResultFiles200ResponseOneOf
- GetResultStats200Response
- GetResultStats200ResponseOneOf
- GetResults200Response
- GetResults200ResponseOneOf
- GetResultsTags200Response
- GetResultsTags200ResponseOneOf
- GetScenariosOperation
- GetSessionMeta200Response
- GetSessionMeta200ResponseOneOf
- GetSessions200Response
- GetSessions200ResponseOneOf
- GetStatsPlugins200Response
- GetStatsPlugins200ResponseOneOf
- GetTags200Response
- GetTags200ResponseOneOf
- GetTelemetryCollectorTelemetryServers200Response
- GetTelemetryCollectorTelemetryServers200ResponseOneOf
- GroupTLS13
- HTTPProfile
- HTTPVersion
- HashP1Algorithm
- HashP2Algorithm
- HealthCheckConfig
- HealthIssue
- HostID
- IPNetwork
- IPRange
- IPSecRange
- IPSecStack
- IdPSignatureAlgo
- IdentificationConfig
- ImportAllOperation
- ImportOfflineLicenseResult
- IngestOperation
- InnerIPRange
- InnerIPSecRange
- Interface
- IpMask
- IpPreference
- IpVer
- KAIIBConfig
- Keyword
- LLMAPIProfile
- LayoutConfig
- License
- LicenseReceipt
- LicenseServerMetadata
- Link
- LoadConfigOperation
- LocalSubnetConfig
- LogLevel
- MacDtlsStack
- MappingType
- MarkedAsDeleted
- Md2Tlv
- MediaFile
- MediaTrack
- MosMode
- NameIdFormat
- NameServer
- Network
- NetworkMapping
- NetworkMeshing
- NetworkProfile
- NetworkSegmentBase
- NodesByController
- NodesPowerCycleOperation
- Notification
- NotificationCounts
- NtpInfo
- ObjectiveType
- ObjectiveUnit
- ObjectiveValueEntry
- ObjectivesAndTimeline
- P1Config
- P2Config
- PANGPEncapsulation
- PANGPSettings
- PPKPair
- PSPRange
- PSPStack
- Pair
- ParamMetadata
- ParamMetadataTypeInfo
- ParamMetadataTypeInfoArrayV2
- ParamMetadataTypeInfoArrayV2ElementsInner
- ParamMetadataTypeInfoInt
- ParamMetadataTypeInfoMedia
- ParamMetadataTypeInfoString
- ParamSourceType
- ParamType
- Parameter
- Params
- ParamsEnum
- PayloadMeta
- PepDUT
- PfsP2Group
- PlaylistSequencingMethod
- Plugin
- PluginStats
- Port
- PortSettings
- PortsByController
- PortsByNode
- PqcSignatureAlgorithmTLS13
- PrfP1Algorithm
- PrimaryObjective
- Profile
- ProtectedSubnetConfig
- QUICProfile
- QUICVersion
- RTPEncryptionMode
- RTPProfile
- ReachabilityCheck
- RebootOperationInput
- RebootPortsOperation
- ReleaseOperationInput
- RemoteAccess
- RemoteSubnetConfig
- RequiredFileTypes
- ReserveOperationInput
- ResultFileMetadata
- ResultMetadata
- ResultsGroup
- SaveConfigOperation
- Scenario
- SecondaryObjective
- Section
- SegmentType
- SelectedEnv
- SequenceDataTypes
- SequenceValue
- SequenceValueTypes
- Session
- SessionReuseMethodTLS12
- SessionReuseMethodTLS13
- SetAggregationModeOperation
- SetControllerAppOperation
- SetDpdkModeOperationInput
- SetNodesAppOperation
- SetNtpOperationInput
- SetPortsLinkStateOperation
- SimpleSequenceValue
- SimulatedIdP
- SingleValue
- Snapshot
- SnowflakeExporter
- SortBodyField
- SpecificObjective
- StartAgentsBatchDeleteRequestInner
- StatelessStream
- StaticARPEntry
- StatsResult
- SteadySegment
- StepSegment
- StreamDirection
- StreamPayloadType
- StreamProfile
- SubProfile
- SubStep
- SupportedGroupTLS13
- SystemInfo
- TLSProfile
- TcpProfile
- TelemetryServerConfig
- TestInfo
- TestStateChangedOperation
- TextSegment
- TimelineSegment
- TimelineSegmentBase
- TimelineSegmentUnion
- Timers
- Track
- TrackType
- TrafficAgentInfo
- TrafficProfileBase
- TrafficSettings
- TransportProfile
- TransportProfileBase
- TunnelRange
- TunnelSettings
- TunnelStack
- UdpProfile
- UpdateNetworkMapping
- UpdatePortTagsOperation
- VLANRange
- VLANType
- ValidationMessage
- Version
- VxLANId
- VxLANRange
- VxLANStack
Authentication schemes defined for the API:
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes:
- offline_access: Required.
- openid: Required.
- Type: OAuth
- Flow: accessCode
- Authorization URL: /auth/realms/keysight/protocol/openid-connect/auth
- Scopes:
- offline_access: Required.
- openid: Required.