SDK operation index¶
Generated from eve-iac OpenAPI/semantics. Do not edit manually.
Cross-language map of the 58 public operations. Traceability key is OpenAPI operationId.
| Group | Family | operationId | TypeScript | Python | Go | HTTP |
|---|---|---|---|---|---|---|
| Connection / Authentication | Session | getHealth |
getHealth |
get_health |
GetHealth |
GET /api/v1/health |
| Connection / Authentication | Session | login |
login |
login |
Login |
POST /api/v1/login |
| Connection / Authentication | Session | logout |
logout |
logout |
Logout |
POST /api/v1/logout |
| Connection / Authentication | Session | getSession |
getSession |
get_session |
GetSession |
GET /api/v1/session |
| Connection / Authentication | Session | getCapabilities |
getCapabilities |
get_capabilities |
GetCapabilities |
GET /api/v1/capabilities |
| Templates / Metadata | Metadata | getPublicSchema |
getPublicSchema |
get_public_schema |
GetPublicSchema |
POST /api/v1/schema |
| Templates / Metadata | Metadata | listTemplates |
listTemplates |
list_templates |
ListTemplates |
GET /api/v1/templates |
| Templates / Metadata | Presentation | getTemplateCatalog |
getTemplateCatalog |
get_template_catalog |
GetTemplateCatalog |
GET /api/v1/templates/catalog |
| Templates / Metadata | Metadata | getTemplate |
getTemplate |
get_template |
GetTemplate |
GET /api/v1/templates/{id} |
| Templates / Metadata | Metadata | listTemplateImages |
listTemplateImages |
list_template_images |
ListTemplateImages |
GET /api/v1/templates/{id}/images |
| Templates / Metadata | Metadata | listTemplateAttributes |
listTemplateAttributes |
list_template_attributes |
ListTemplateAttributes |
GET /api/v1/templates/{id}/attributes |
| Templates / Metadata | Metadata | listNetworkTypes |
listNetworkTypes |
list_network_types |
ListNetworkTypes |
GET /api/v1/network-types |
| Templates / Metadata | Metadata | getNetworkAuthoring |
getNetworkAuthoring |
get_network_authoring |
GetNetworkAuthoring |
GET /api/v1/authoring/networks/{id} |
| Templates / Metadata | Presentation | listIcons |
listIcons |
list_icons |
ListIcons |
GET /api/v1/icons |
| Templates / Metadata | Metadata | listFolders |
listFolders |
list_folders |
ListFolders |
GET /api/v1/folders |
| Templates / Metadata | Presentation | getAuthoringIconsZip |
getAuthoringIconsZip |
get_authoring_icons_zip |
GetAuthoringIconsZip |
GET /api/v1/authoring/icons.zip |
| Templates / Metadata | Metadata | getAuthoringRevision |
getAuthoringRevision |
get_authoring_revision |
GetAuthoringRevision |
GET /api/v1/authoring/revision |
| Templates / Metadata | Metadata | getAuthoringSnapshot |
getAuthoringSnapshot |
get_authoring_snapshot |
GetAuthoringSnapshot |
GET /api/v1/authoring/snapshot |
| Templates / Metadata | Metadata | completeLinkInterfaces |
completeLinkInterfaces |
complete_link_interfaces |
CompleteLinkInterfaces |
POST /api/v1/authoring/link-completions |
| Templates / Metadata | Metadata | previewInterfaces |
previewInterfaces |
preview_interfaces |
PreviewInterfaces |
POST /api/v1/authoring/interfaces |
| Projects | Intent | validateProject |
validateProject |
validate_project |
ValidateProject |
POST /api/v1/projects/validate |
| Projects | Lifecycle | importProject |
importProject |
import_project |
ImportProject |
POST /api/v1/projects/import |
| Projects | Planning | planProject |
planProject |
plan_project |
PlanProject |
POST /api/v1/projects/plan |
| Projects | Lifecycle | deployProject |
deployProject |
deploy_project |
DeployProject |
POST /api/v1/projects/deploy |
| Projects | Reconciliation | reconcileProject |
reconcileProject |
reconcile_project |
ReconcileProject |
POST /api/v1/projects/reconcile |
| Projects | Lifecycle | destroyProject |
destroyProject |
destroy_project |
DestroyProject |
POST /api/v1/projects/destroy |
| Projects | Observation | getProjectStatus |
getProjectStatus |
get_project_status |
GetProjectStatus |
POST /api/v1/projects/status |
| Projects | Observation | inspectProject |
inspectProject |
inspect_project |
InspectProject |
POST /api/v1/projects/inspect |
| Projects | Intent | getPublicProject |
getPublicProject |
get_public_project |
GetPublicProject |
POST /api/v1/projects/public |
| Projects | Intent | editProject |
editProject |
edit_project |
EditProject |
POST /api/v1/projects/edit |
| Projects | Intent | getProjectConfig |
getProjectConfig |
get_project_config |
GetProjectConfig |
POST /api/v1/projects/config |
| Projects | Intent | editProjectConfig |
editProjectConfig |
edit_project_config |
EditProjectConfig |
POST /api/v1/projects/config/edit |
| Projects | Session | openProject |
openProject |
open_project |
OpenProject |
POST /api/v1/projects/open |
| Execution / Consoles | Console | listProjectConsoles |
listProjectConsoles |
list_project_consoles |
ListProjectConsoles |
POST /api/v1/projects/consoles |
| Execution / Consoles | Lifecycle | execProject |
execProject |
exec_project |
ExecProject |
POST /api/v1/projects/exec |
| Execution / Consoles | Startup config | exportProjectConfig |
exportProjectConfig |
export_project_config |
ExportProjectConfig |
POST /api/v1/projects/export-config |
| Execution / Consoles | Runtime interaction | applyLinkQuality |
applyLinkQuality |
apply_link_quality |
ApplyLinkQuality |
POST /api/v1/projects/links/quality |
| Execution / Consoles | Runtime interaction | setLinkSuspend |
setLinkSuspend |
set_link_suspend |
SetLinkSuspend |
POST /api/v1/projects/links/suspend |
| Execution / Consoles | Capture | startCapture |
startCapture |
start_capture |
StartCapture |
POST /api/v1/projects/capture |
| Execution / Consoles | Capture | attachTraffic |
attachTraffic |
attach_traffic |
AttachTraffic |
POST /api/v1/projects/traffic/attach |
| Execution / Consoles | Console | execConsole |
execConsole |
exec_console |
ExecConsole |
POST /api/v1/console/exec |
| Execution / Consoles | Console | execConsoleMany |
execConsoleMany |
exec_console_many |
ExecConsoleMany |
POST /api/v1/console/exec-many |
| Execution / Consoles | Console | createConsoleSession |
createConsoleSession |
create_console_session |
CreateConsoleSession |
POST /api/v1/console/sessions |
| Execution / Consoles | Console | listConsoleSessions |
listConsoleSessions |
list_console_sessions |
ListConsoleSessions |
POST /api/v1/console/sessions/list |
| Execution / Consoles | Console | getConsoleSession |
getConsoleSession |
get_console_session |
GetConsoleSession |
POST /api/v1/console/sessions/get |
| Execution / Consoles | Console | closeConsoleSession |
closeConsoleSession |
close_console_session |
CloseConsoleSession |
POST /api/v1/console/sessions/close |
| Execution / Consoles | Console | getConsoleHistory |
getConsoleHistory |
get_console_history |
GetConsoleHistory |
POST /api/v1/console/history |
| Execution / Consoles | Console | waitConsole |
waitConsole |
wait_console |
WaitConsole |
POST /api/v1/console/wait |
| Execution / Consoles | Console | runConsole |
runConsole |
run_console |
RunConsole |
POST /api/v1/console/run |
| Execution / Consoles | Console | attachConsole |
attachConsole |
attach_console |
AttachConsole |
POST /api/v1/console/attach |
| Execution / Consoles | Console | streamConsole |
streamConsole |
stream_console |
StreamConsole |
GET /api/v1/console/stream/{ticket} |
| Execution / Consoles | Capture | streamTraffic |
streamTraffic |
stream_traffic |
StreamTraffic |
GET /api/v1/projects/traffic/stream/{ticket} |
| Execution / Consoles | Console | startOob |
startOob |
start_oob |
StartOob |
POST /api/v1/oob/start |
| Execution / Consoles | Console | getOobStatus |
getOobStatus |
get_oob_status |
GetOobStatus |
POST /api/v1/oob/status |
| Execution / Consoles | Console | getOobCredentials |
getOobCredentials |
get_oob_credentials |
GetOobCredentials |
POST /api/v1/oob/credentials |
| Execution / Consoles | Console | stopOob |
stopOob |
stop_oob |
StopOob |
POST /api/v1/oob/stop |
| Execution / Consoles | Console | openOob |
openOob |
open_oob |
OpenOob |
POST /api/v1/oob/open |
| Execution / Consoles | Console | streamOob |
streamOob |
stream_oob |
StreamOob |
GET /api/v1/oob/stream/{ticket} |