HTTP operations

Generated from eve-iac OpenAPI/semantics. Do not edit manually.

Candidate public v1 HTTPS API. Clients talk only to eve-iac-agent. Native EVE REST is not a client API.

Connection / Authentication

getHealth

GET /api/v1/health

GET /api/v1/health. operationId getHealth. Timeout 15000ms.

  • Auth: none
  • Timeout: 15000 ms
  • Response data: HealthData

login

POST /api/v1/login

POST /api/v1/login. operationId login. Timeout 15000ms.

  • Auth: none
  • Timeout: 15000 ms
  • Request: LoginRequest
  • Response data: LoginData

logout

POST /api/v1/logout

POST /api/v1/logout. operationId logout. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: LogoutRequest
  • Response data: StatusOkData

getSession

GET /api/v1/session

GET /api/v1/session. operationId getSession. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: SessionData

getCapabilities

GET /api/v1/capabilities

GET /api/v1/capabilities. operationId getCapabilities. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: CapabilitiesData

Templates / Metadata

listTemplates

GET /api/v1/templates

GET /api/v1/templates. operationId listTemplates. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: TemplatesData

getTemplate

GET /api/v1/templates/{id}

GET /api/v1/templates/{id}. operationId getTemplate. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: TemplateDetail

listTemplateImages

GET /api/v1/templates/{id}/images

GET /api/v1/templates/{id}/images. operationId listTemplateImages. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: TemplateImagesData

listTemplateAttributes

GET /api/v1/templates/{id}/attributes

GET /api/v1/templates/{id}/attributes. operationId listTemplateAttributes. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: TemplateAttributesData

listNetworkTypes

GET /api/v1/network-types

GET /api/v1/network-types. operationId listNetworkTypes. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: NetworkTypesData

listIcons

GET /api/v1/icons

GET /api/v1/icons. operationId listIcons. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Response data: IconsData

completeLinkInterfaces

POST /api/v1/authoring/link-completions

POST /api/v1/authoring/link-completions. operationId completeLinkInterfaces. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: CompleteLinkInterfacesRequest
  • Response data: LinkCompletionsData

previewInterfaces

POST /api/v1/authoring/interfaces

POST /api/v1/authoring/interfaces. operationId previewInterfaces. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: PreviewInterfacesRequest
  • Response data: InterfacesPreviewData

Projects

validateProject

POST /api/v1/projects/validate

POST /api/v1/projects/validate. operationId validateProject. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: ValidateProjectRequest
  • Response data: ValidateData

importProject

POST /api/v1/projects/import

POST /api/v1/projects/import. operationId importProject. Timeout 120000ms. Clones source_lab into a managed working copy. Does not mutate source_lab. from_eve is not this operation.

  • Auth: Bearer
  • Timeout: 120000 ms
  • Request: ImportProjectRequest
  • Response data: ImportData

planProject

POST /api/v1/projects/plan

POST /api/v1/projects/plan. operationId planProject. Timeout 180000ms. Dry-run. Omitted direction is to_eve. Never writes Local files or EVE.

  • Auth: Bearer
  • Timeout: 180000 ms
  • Request: PlanProjectRequest
  • Response data: PlanData

deployProject

POST /api/v1/projects/deploy

POST /api/v1/projects/deploy. operationId deployProject. Timeout 300000ms.

  • Auth: Bearer
  • Timeout: 300000 ms
  • Request: DeployProjectRequest
  • Response data: DeployData

reconcileProject

POST /api/v1/projects/reconcile

POST /api/v1/projects/reconcile. operationId reconcileProject. Timeout 300000ms. to_eve mutates EVE. from_eve updates Local from the managed lab with no mutating EVE writes. from_eve is not Import.

  • Auth: Bearer
  • Timeout: 300000 ms
  • Request: ReconcileProjectRequest
  • Response data: ReconcileData

destroyProject

POST /api/v1/projects/destroy

POST /api/v1/projects/destroy. operationId destroyProject. Timeout 180000ms.

  • Auth: Bearer
  • Timeout: 180000 ms
  • Request: DestroyProjectRequest
  • Response data: DestroyData

getProjectStatus

POST /api/v1/projects/status

POST /api/v1/projects/status. operationId getProjectStatus. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: GetProjectStatusRequest
  • Response data: ProjectStatusData

inspectProject

POST /api/v1/projects/inspect

POST /api/v1/projects/inspect. operationId inspectProject. Timeout 120000ms. Observation, not desired state.

  • Auth: Bearer
  • Timeout: 120000 ms
  • Request: InspectProjectRequest
  • Response data: InspectionData

openProject

POST /api/v1/projects/open

POST /api/v1/projects/open. operationId openProject. Timeout 30000ms.

  • Auth: Bearer
  • Timeout: 30000 ms
  • Request: OpenProjectRequest
  • Response data: OpenData

Execution / Consoles

listProjectConsoles

POST /api/v1/projects/consoles

POST /api/v1/projects/consoles. operationId listProjectConsoles. Timeout 30000ms.

  • Auth: Bearer
  • Timeout: 30000 ms
  • Request: ListProjectConsolesRequest
  • Response data: ConsolesData

execProject

POST /api/v1/projects/exec

POST /api/v1/projects/exec. operationId execProject. Timeout 180000ms. action is start|stop|wipe. Omitted or empty node means all nodes. Success data is BulkResult with stable lowercase keys. Omitted stopmode is 3; explicit 0 is graceful.

  • Auth: Bearer
  • Timeout: 180000 ms
  • Request: ExecProjectRequest
  • Response data: BulkResult

execConsole

POST /api/v1/console/exec

POST /api/v1/console/exec. operationId execConsole. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: ExecConsoleRequest
  • Response data: ConsoleExecData

execConsoleMany

POST /api/v1/console/exec-many

POST /api/v1/console/exec-many. operationId execConsoleMany. Timeout 15000ms.

  • Auth: Bearer
  • Timeout: 15000 ms
  • Request: ExecConsoleManyRequest
  • Response data: ConsoleExecManyData

attachConsole

POST /api/v1/console/attach

POST /api/v1/console/attach. operationId attachConsole. Timeout 30000ms.

  • Auth: Bearer
  • Timeout: 30000 ms
  • Request: AttachConsoleRequest
  • Response data: ConsoleAttachData

streamConsole

GET /api/v1/console/stream/{ticket}

GET /api/v1/console/stream/{ticket}. operationId streamConsole. Timeout 15000ms. Success is 101 Switching Protocols, not a JSON envelope.

  • Auth: Bearer
  • Timeout: 15000 ms