How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nerve Node API

REST API served by the Nerve Local UI on each Nerve edge node. Covers node initialization and license activation, system and network configuration, proxy settings, local users and permissions, Docker image and volume resources, workload deployment, snapshots, backups, logs and compose, CODESYS process control, remote connections, the Data Services datapath and Nerve DNA. Cookie / basic authentication; OpenAPI 3.0.1, 77 operations.

This API exposes 77 operations across 63 paths, organized into 22 resource areas. It is described by OpenAPI 3.0.1, at version 2.10.0.

Requests are made against the base URL http://172.20.2.1:3333.

77 operations 63 paths 0 schemas 6 DELETE40 GET1 PATCH21 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.10.0
Base URL
http://172.20.2.1:3333
Authentication
API Key, HTTP Basic
Resource Areas
22

Authentication & Security 2

Nerve Node API declares 2 security schemes for authenticating requests. An API key is passed in the header as cookie (cookieAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 77

Across 63 paths, the API surfaces 77 operations — 6 DELETE, 40 GET, 1 PATCH, 21 POST, 9 PUT. They span 22 resource areas, including AUTH, USERS, INITIALIZATION, CONFIGURATION, NODE, SETUP NETWORK, SYSTEM, PROXY SETTINGS, and 14 more. Each is listed below with its method, path, parameters, and response codes.

AUTH 3
POST
/api/auth/login
Log in user
login body → 200400403429
GET
/api/auth/logged-user
Get currently logged in user data from database
get_logged_user → 200401403
GET
/api/auth/logout
Logs out user
logout → 204401403
USERS 3
GET
/api/users
Get a list of all users from the database
get_users → 200401403
DELETE
/api/users
Delete all users, or delete a specific user from the database
delete_user 1 param → 204401403404500
POST
/api/users/change-password
Change user password
change_password body → 200400401403
INITIALIZATION 1
POST
/api/init
Configuration for node connection to cloud
set_configuration body → 200400401
CONFIGURATION 5

Node configuration operations (onboarding, retrieving the Management system version, retrieving the node's secure ID, etc.)

GET
/api/setup/configurations
Get the current node configuration
get_node_configuration → 200401403500
POST
/api/setup/configurations
Configure node
set_node_configuration body → 200400401403415500
GET
/api/setup/configurations/cloud-version
Get Management system version(cloud version)
get_cloud_version 1 param → 200400401403404500
GET
/api/setup/configurations/secure-id
Get node secure id
get_node_secure_id → 200401403500
GET
/api/setup/configurations/secureIddeprecated
Get node secure id
get_node_secure_id_deprecated → 200401403500
NODE 3
POST
/api/setup/node/password
Set new password for the node
set_node_password 1 param body → 200400401403
GET
/api/setup/node/info
Get node information
get_node_info → 200401403
GET
/api/version
Get node version
get_node_version → 200401403
SETUP NETWORK 3
GET
/api/setup/network/interfaces
Get network configuration
get_network_configuration → 200401403
GET
/api/setup/network/check-update-status
Get network update status
get_network_update_status → 200401403500
POST
/api/setup/network/init-config-update
Initiating network interface update
initiating_network_update body → 200400401403500
SYSTEM 8
GET
/api/system/status
Get an overview of the system state
get_system_status → 200400401403
POST
/api/system/reboot
Initiates a system reboot
node_system_reboot body → 200400401403415
GET
/api/system/info
Get system information
get_system_info → 200400401403404
GET
/api/system/network
Get the current network state
get_network_state → 200400401403404
PUT
/api/system/network
Set network state
set_network_state body → 200400401403404
POST
/api/system/offboard
Initiates node offboarding
node_offboarding → 202400401403
GET
/api/system/audit-logs
Download audit logs in a zip archive
download_audit_logs → 200401403404500
GET
/api/system/debug-logs-archive
Download debug logs in a zip archive
download_debug_logs → 200401403404500
PROXY SETTINGS 2
GET
/api/proxy-settings
Get proxy configuration
get_proxy_configuration → 200400401403
POST
/api/proxy-settings
Set proxy configuration
set_proxy_configuration body → 204400401403404500
CODESYS PROCESS 1
GET
/api/codesys-process/restart
Restart the CODESYS application
restart_codesys → 200404
WORKLOAD CODESYS 2
GET
/api/workload/codesys/download
Download CODESYS application as zip archive
codesys_download → 200400401403404
POST
/api/workload/codesys/upload
Upload CODESYS zip archive
upload_codesys body → 204400
WORKLOADS 6
POST
/api/workloads/deploy
Deploy workload
deploy_workload 1 param body → 204400401403409415500
GET
/api/workloads
Get list of workloads installed on the system
list_deployed_workloads → 200401403500
GET
/api/workloads/{deviceId}/details
Get details of workload
deployed_workload_details 1 param → 200400401403404500
PUT
/api/workloads/{deviceId}/control/{command}
Workload control
control_workload 2 params body → 200400401403404415500
POST
/api/workloads/{deviceId}/apply-resources
Update CPU and memory resources of VM workloads
update_workload_resources 1 param body → 204400401403404415500
POST
/api/workloads/{deviceId}/apply-configuration
Apply configuration to workload
apply_workload_configuration 1 param body → 204400401403404415500
WORKLOADS NETWORKS 1
GET
/api/workloads/{deviceId}/network-details
Gets network interface information of VM workload
get_workload_network_details 1 param → 200400401403404500
WORKLOADS SNAPSHOTS 6
POST
/api/workloads/{deviceId}/snapshots
Create snapshot of the selected VM workload
create_vm_snapshot 1 param body → 202400401403404500
DELETE
/api/workloads/{deviceId}/snapshots
Delete snapshot of the selected VM workload
delete_vm_snapshot 2 params → 200400401403404500
PUT
/api/workloads/{deviceId}/snapshots
Restore snapshot to the selected VM workload
revert_vm_snapshot 1 param body → 200400401403404500
GET
/api/workloads/{deviceId}/snapshots
Get snapshots of the selected VM workload
get_vm_snapshots 1 param → 200400401403404500
DELETE
/api/workloads/{deviceId}/snapshots/schedule
Delete snapshot scheduled of the selected VM workload
delete_vm_schedule_snapshot_config 1 param → 200400401403404500
POST
/api/workloads/{deviceId}/snapshots/schedule
Create a snapshot schedule for the selected VM workload
create_vm_schedule_snapshot_config 1 param body → 201400401403404500
WORKLOADS BACKUPS 4
GET
/api/workloads/{deviceId}/backups
Get backups for the specified VM workload
get_vm_backups_history 1 param → 200400401403404500
POST
/api/workloads/{deviceId}/backups
Create backup for specified VM workload
create_vm_backup 1 param body → 202400401403404500
POST
/api/workloads/{deviceId}/backups/restart
Restart creation of VM backup
restart_vm_backup_creation 1 param body → 200400401403404500
POST
/api/workloads/backups/deploy
Deploy the selected backup from the local repository
deploy_vm_backups body → 200400401403404415500
WORKLOADS COMPOSE 2
GET
/api/workloads/{deviceId}/compose-services-details
Get detailed information about docker-compose workload services
get_compose_services_details 1 param → 200400401403404
GET
/api/workloads/{deviceId}/compose-service-docker-inspect/{name}
Get docker inspect output for specified compose service Docker container
compose_service_inspect 2 params → 200400401403404
WORKLOADS LOGS 2
GET
/api/workloads/{deviceId}/logs/{name}/events
Get the logs of specific docker container through an event stream
get_workload_log_event 2 params → 200400404
GET
/api/workloads/{deviceId}/logs/{name}
Download logs of a specific Docker container
get_workload_logs 2 params → 200400401404
REPOSITORIES 7
POST
/api/repositories
Create local repository
create_local_repository body → 201400401403500
GET
/api/repositories
Get list of repositories
get_repository_list → 200401403
GET
/api/repositories/{id}
Get local repository
get_local_repository 1 param → 200400401403404500
PUT
/api/repositories/{id}
Update local repository
update_local_repository 1 param body → 200400401403404500
DELETE
/api/repositories/{id}
Delete local repository
delete_local_repository 1 param → 204400401403404500
GET
/api/repositories/list/backups
Get the list of VM backups
get_backup_repository_list 4 params → 200400401403404500
PUT
/api/repositories/{id}/mount
Mount the NFS file system
mount_repository_to_nfs_server 1 param → 200400401403404
REMOTE CONNECTIONS 6
GET
/api/rc-requests
Get a list of remote connections waiting for approval
get_remote_connections_waiting_approval → 200400401403
PUT
/api/rc-requests/resolve
Resolve remote connection requests before they can be established
resolve_remote_connections_requests body → 200400401403
GET
/api/rc-settings
Get the current configuration of the auto-approval option for remote connection
get_auto_approval_configuration → 200400401403
PUT
/api/rc-settings
Update auto-approval settings, enable or disable it
update_auto_approval_settings body → 200400401403
GET
/api/rc-connections
Get the list of established remote connections
get_remote_connections_list 1 param → 200400401403500
POST
/api/rc-connections/terminate-connections
Terminate established remote connections
terminate_established_remote_connections body → 200400401403
DNA 6
GET
/api/dna/target
Get target node configuration
get_dna_target_configuration → 200400401403404
PUT
/api/dna/target
Apply target configuration
apply_dna_configuration 3 params body → 202400401403404415500
GET
/api/dna/status
Get configuration status
dna_configuration_status → 200400401403404
PATCH
/api/dna/target/cancel
Cancel DNA configuration in progress
cancel_dna_configuration → 202400401403404500
GET
/api/dna/current
Get current node configuration
dna_current_configuration → 200400401403
PUT
/api/dna/target/re-apply
Re-apply target configuration
re_apply_dna_configuration 3 params → 202400401403404
DOCKER_RESOURCES_VOLUMES 4
GET
/api/docker-resources/volumes
List all docker volumes from the node
list_volumes → 200401403500
DELETE
/api/docker-resources/volumes/{name}
Delete a docker volume
delete_volume 1 param → 204401403404409500
POST
/api/docker-resources/volumes/{name}/import
Import data to an existing docker volume
import_data_to_volume 1 param body → 200400401403404409415500
GET
/api/docker-resources/volumes/{name}/export
Export a Docker volume
export_volume 1 param → 200400401403404409500
DOCKER_RESOURCES_IMAGES 1
DELETE
/api/docker-resources/images/unused
Remove docker images that are not used by any docker container
remove_unused_docker_images → 202400401403409500
DATAPATH 1
GET
/api/auth/authenticate
Authenticate Data Path user
authenticate_data_path_user → 200401403

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tttech-nerve-node-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Nerve Node API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.