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.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nerve-node-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.0.1
info:
version: 2.10.0
description: "Nerve OVDM API to manage:\n - node configuration\n - system configuration\n - system network configuration\n - workloads\n - remote connections\n - dna\n"
title: Nerve Node API
contact:
name: Nerve support
email: support@tttech-industrial.com
tags:
- name: AUTH
- name: USERS
- name: INITIALIZATION
- name: CONFIGURATION
description: Node configuration operations (onboarding, retrieving the Management system version, retrieving the node's secure ID, etc.)
- name: NODE
- name: SETUP NETWORK
- name: SYSTEM
- name: PROXY SETTINGS
- name: CODESYS PROCESS
- name: WORKLOAD CODESYS
- name: WORKLOADS
- name: WORKLOADS NETWORKS
- name: WORKLOADS SNAPSHOTS
- name: WORKLOADS BACKUPS
- name: WORKLOADS COMPOSE
- name: WORKLOADS LOGS
- name: REPOSITORIES
- name: REMOTE CONNECTIONS
- name: DNA
- name: DATAPATH
- name: DOCKER_RESOURCES_VOLUMES
- name: DOCKER_RESOURCES_IMAGES
paths:
/api/auth/login:
post:
tags:
- AUTH
operationId: login
summary: Log in user
description: Log in user and set authorization cookie.
security: []
x-permissions:
- AUTH:LOGIN
requestBody:
required: true
description: Login credentials consisting of a username in email format and a password.
content:
application/json:
schema:
type: object
description: Login credentials
required:
- username
- password
additionalProperties: false
properties:
username:
description: User's username in email format
type: string
minLength: 1
maxLength: 1001
password:
description: User's password
type: string
minLength: 1
maxLength: 1001
example:
username: demo@nerve.com
password: Passw0rd
responses:
'200':
description: User logged in successfully and cookie is set.
content:
application/json:
schema:
type: object
description: Logged user data
required:
- firstName
- lastName
- username
- email
- roles
- permissions
properties:
username:
description: User's username in email format used to log in
type: string
firstName:
description: User's first name
type: string
lastName:
description: User's last name
type: string
email:
description: User's email address
type: string
roles:
description: User's roles.
type: string
permissions:
description: User's permissions in object format, where the keys represent permission names and the values are set to TRUE.
type: object
additionalProperties: false
example:
firstName: Demo
lastName: Nerve
username: demo@nerve.com
email: demo@nerve.com
roles: admin
permissions:
UI_NODE_CONFIGURATION:VIEW: true
CONFIGURATION:VIEW: true
CLOUD_VERSION:VIEW: true
SECURE_ID:VIEW: true
UI_NODE_CONFIGURATION:EDIT: true
CONFIGURATION:EDIT: true
headers:
Set-Cookie:
schema:
type: string
description: Set-Cookie header
example: authorization=a1B2c3.d5e6f7g8h9i0.j_k-l1m2n3o; Max-Age=3600; Path=/; Expires=Wed, 01 Jan 2024 00:00:00 GMT; HttpOnly
'400':
description: Bad request
content:
application/json:
schema:
oneOf:
- type: object
description: Validation error.
required:
- status
- message
- errors
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
message:
type: string
minLength: 1
maxLength: 1001
description: The validation error message
errors:
type: array
minItems: 1
maxItems: 1001
description: Detailed description of what does not match the schema
items:
type: object
properties:
path:
type: string
minLength: 1
maxLength: 1001
description: Specified location within the document where the error occurred
message:
type: string
minLength: 1
maxLength: 1001
description: Error message
- type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
examples:
invalid_credentials:
value:
status: 400
msg: invalid_credentials
default_admin_account_deactivated:
value:
status: 400
msg: default_admin_account_is_deactivated_use_your_personal_credentials_to_log_in
'403':
description: Access Denied. User(with Management System credentials) does not have required permissions to access this application.
content:
application/json:
schema:
type: object
description: Message associated with HTTP status code
required:
- status
- msg
additionalProperties: false
properties:
status:
description: HTTP status code
enum:
- 403
msg:
description: Response message
enum:
- access_denied_user_does_not_have_permission_to_access_this_application
'429':
description: Too many requests made, user temporarily blocked.
content:
application/json:
schema:
type: object
description: Message associated with HTTP status code
required:
- status
- msg
additionalProperties: false
properties:
status:
description: HTTP status code
enum:
- 429
msg:
description: Response message
enum:
- auth_brute_force_too_many_failed_requests
/api/auth/logged-user:
get:
tags:
- AUTH
operationId: get_logged_user
summary: Get currently logged in user data from database
description: Get logged in user from database.
x-permissions:
- AUTH:VIEW
responses:
'200':
description: User successfully fetched from database.
content:
application/json:
schema:
type: object
description: Logged user data
required:
- firstName
- lastName
- username
- email
- roles
- permissions
properties:
username:
description: User's username in email format used to log in
type: string
firstName:
description: User's first name
type: string
lastName:
description: User's last name
type: string
email:
description: User's email address
type: string
roles:
description: User's roles.
type: string
permissions:
description: User's permissions in object format, where the keys represent permission names and the values are set to TRUE.
type: object
additionalProperties: false
example:
username: demo@nerve.com
firstName: Demo
lastName: Nerve
email: demo@nerve.com
roles: admin
permissions:
UI_NODE_CONFIGURATION:VIEW: true
CONFIGURATION:VIEW: true
CLOUD_VERSION:VIEW: true
SECURE_ID:VIEW: true
UI_NODE_CONFIGURATION:EDIT: true
CONFIGURATION:EDIT: true
'401':
description: You are not authorized to perform this operation
content:
application/json:
schema:
oneOf:
- type: object
description: User not authorized
required:
- user
additionalProperties: false
properties:
user:
type: string
description: Not authorized
enum:
- not authorized
- type: object
description: User not authorized
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
minimum: 401
maximum: 401
description: HTTP status code
msg:
type: string
description: Error message
enum:
- Not authorized
- not authorized
- type: object
description: Cookie header is missing in the request
required:
- status
- message
- errors
additionalProperties: false
properties:
status:
description: HTTP status code
type: integer
enum:
- 401
message:
type: string
description: The validation error message
enum:
- '''cookie'' header required'
errors:
type: array
minItems: 1
maxItems: 1001
description: List of errors
items:
type: object
properties:
path:
type: string
minLength: 1
maxLength: 1001
description: Specified location within the document where the error occurred
message:
type: string
minLength: 1
maxLength: 1001
description: Error message
examples:
not_authorized_usr:
value:
user: not authorized
not_authorized_status:
value:
status: 401
msg: Not authorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
examples:
forbidden:
value:
status: 403
msg: Forbidden
/api/auth/logout:
get:
tags:
- AUTH
operationId: logout
summary: Logs out user
description: Logs out currently logged in user.
x-permissions:
- AUTH:LOGOUT
responses:
'204':
description: User successfully logged out.
'401':
description: You are not authorized to perform this operation
content:
application/json:
schema:
oneOf:
- type: object
description: User not authorized
required:
- user
additionalProperties: false
properties:
user:
type: string
description: Not authorized
enum:
- not authorized
- type: object
description: User not authorized
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
minimum: 401
maximum: 401
description: HTTP status code
msg:
type: string
description: Error message
enum:
- Not authorized
- not authorized
- type: object
description: Cookie header is missing in the request
required:
- status
- message
- errors
additionalProperties: false
properties:
status:
description: HTTP status code
type: integer
enum:
- 401
message:
type: string
description: The validation error message
enum:
- '''cookie'' header required'
errors:
type: array
minItems: 1
maxItems: 1001
description: List of errors
items:
type: object
properties:
path:
type: string
minLength: 1
maxLength: 1001
description: Specified location within the document where the error occurred
message:
type: string
minLength: 1
maxLength: 1001
description: Error message
examples:
not_authorized_usr:
value:
user: not authorized
not_authorized_status:
value:
status: 401
msg: Not authorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
examples:
forbidden:
value:
status: 403
msg: Forbidden
/api/users:
get:
tags:
- USERS
operationId: get_users
summary: Get a list of all users from the database
description: Retrieve a list of all users from the database, including the default admin account if it is active.
x-permissions:
- USER:LIST
responses:
'200':
description: Users successfully fetched from database.
content:
application/json:
schema:
type: object
description: Object containing a list of users.
required:
- users
additionalProperties: false
properties:
users:
type: array
description: Users from the database
minItems: 0
maxItems: 1001
items:
type: object
required:
- firstName
- lastName
- email
- username
- roles
- id
properties:
id:
description: User's database id
type: integer
firstName:
description: User's first name
type: string
lastName:
description: User's last name
type: string
email:
description: User's email address
type: string
username:
description: User's username
type: string
roles:
description: User's role
type: string
lastLoggedInAt:
description: Timestamp of the user's last login event
type: integer
nullable: true
additionalProperties: false
example:
users:
- firstName: Demo
lastName: Nerve
username: demo@nerve.com
email: demo@nerve.com
roles: admin
lastLoggedInAt: 1716803144649
id: 1
'401':
description: You are not authorized to perform this operation
content:
application/json:
schema:
oneOf:
- type: object
description: User not authorized
required:
- user
additionalProperties: false
properties:
user:
type: string
description: Not authorized
enum:
- not authorized
- type: object
description: User not authorized
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
minimum: 401
maximum: 401
description: HTTP status code
msg:
type: string
description: Error message
enum:
- Not authorized
- not authorized
- type: object
description: Cookie header is missing in the request
required:
- status
- message
- errors
additionalProperties: false
properties:
status:
description: HTTP status code
type: integer
enum:
- 401
message:
type: string
description: The validation error message
enum:
- '''cookie'' header required'
errors:
type: array
minItems: 1
maxItems: 1001
description: List of errors
items:
type: object
properties:
path:
type: string
minLength: 1
maxLength: 1001
description: Specified location within the document where the error occurred
message:
type: string
minLength: 1
maxLength: 1001
description: Error message
examples:
not_authorized_usr:
value:
user: not authorized
not_authorized_status:
value:
status: 401
msg: Not authorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
examples:
forbidden:
value:
status: 403
msg: Forbidden
delete:
tags:
- USERS
operationId: delete_user
summary: Delete all users, or delete a specific user from the database
description: Delete all users from the database, or delete a specific user defined via a query parameter 'username'. If all users are deleted, the default admin account is reactivated.
x-permissions:
- USER:DELETE
parameters:
- name: username
in: query
required: false
allowReserved: true
description: Username of the user to be deleted
schema:
description: User's username in email format
type: string
minLength: 1
maxLength: 1001
responses:
'204':
description: The user was successfully deleted, or all users were deleted and the default account was reactivated.
'401':
description: You are not authorized to perform this operation
content:
application/json:
schema:
oneOf:
- type: object
description: User not authorized
required:
- user
additionalProperties: false
properties:
user:
type: string
description: Not authorized
enum:
- not authorized
- type: object
description: User not authorized
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
minimum: 401
maximum: 401
description: HTTP status code
msg:
type: string
description: Error message
enum:
- Not authorized
- not authorized
- type: object
description: Cookie header is missing in the request
required:
- status
- message
- errors
additionalProperties: false
properties:
status:
description: HTTP status code
type: integer
enum:
- 401
message:
type: string
description: The validation error message
enum:
- '''cookie'' header required'
errors:
type: array
minItems: 1
maxItems: 1001
description: List of errors
items:
type: object
properties:
path:
type: string
minLength: 1
maxLength: 1001
description: Specified location within the document where the error occurred
message:
type: string
minLength: 1
maxLength: 1001
description: Error message
examples:
not_authorized_usr:
value:
user: not authorized
not_authorized_status:
value:
status: 401
msg: Not authorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
examples:
forbidden:
value:
status: 403
msg: Forbidden
'404':
description: The resource not found
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
description: Description of error associated with status code.
required:
- status
- msg
additionalProperties: false
properties:
status:
type: integer
description: HTTP status code
msg:
type: string
minLength: 1
maxLength: 1001
description: Error message
pattern: .*
/api/users/change-password:
post:
tags:
- USERS
operationId: change_password
summary: Change user password
description: Password modification is restricted to the default admin account. MS users are unable to change their passwords using the LocalUI application, but can do so through MS.
x-permissions:
- USER_PASSWORD:CHANGE
requestBody:
required: true
description: A password change object containing the username, oldPassword, newPassword and newPasswordConfirmation.
content:
application/json:
schema:
type: object
description: Representing the data required to change a user's password
required:
- username
- oldPassword
- newPassword
- newPasswordConfirmation
properties:
username:
description: User's username in email format
type: string
minLength: 1
maxLength: 1001
oldPassword:
description: User's old password that is currently in the database.
type: string
minLength: 1
maxLength: 1001
newPassword:
description: User's new password that will replace the old password in the database.
type: string
minLength: 8
maxLength: 100
pattern: (?=.*[a-z])(?=.*[A-Z])(?=.*\d).+
newPasswordConfirmation:
description: The same values as the new password, used as a confirmation that the new password was entered correctly.
type: string
minLength: 1
maxLength: 1001
additionalProperties: false
example:
username: demo@nerve.cloud
oldPassword: Passw0rd
newPassword: Passw0rd1
newPasswordConfirmation: Passw0rd1
responses:
'200':
description: Password changed successfully.
content:
application/json:
schema:
type: object
description: Successful response after a user's password has been changed
required:
- message
properties:
message:
description: Message confirming that the password was successfully changed.
type: string
enum:
- Password changed successfully.
additiona
# --- truncated at 32 KB (713 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tttech/refs/heads/main/openapi/tttech-nerve-node-openapi.yml