REST API of the Nerve Management System, the cloud-hosted control plane for Nerve edge nodes. Covers authentication and MFA, node registration and lifecycle, workload and workload-version management (Docker, docker-compose, CODESYS, VM), deployment and workload control, labels, LDAP integration, Nerve DNA declarative node configuration, remote connections, notifications, the Nerve Docker registry, node/cloud updates and usage reports. Session-cookie / sessionId authentication with basic and bearer variants; OpenAPI 3.0.3, 151 operations.
This API exposes
151 operations
across 126 paths,
organized into 24 resource areas,
and defines 11 schemas.
It is described by OpenAPI 3.0.3, at version 3.1.0.
Requests are made against a single base URL, https://trynerve1.nerve.cloud.
151 operations126 paths11 schemas12 DELETE66 GET12 PATCH52 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Nerve Management System API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as sessionId (sessionId).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as cookie (cookieAuth).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 151
Across 126 paths, the API surfaces 151 operations — 12 DELETE, 66 GET, 12 PATCH, 52 POST, 9 PUT. They span 24 resource areas, including WORKLOAD, NODE, WORKLOAD_v2, WL_VERSION_v2, WORKLOAD_v3, DOCKER_COMPOSE_FILE, WL_VERSION_v3, WL_VERSION_FILE, and 16 more. Each is listed below with its method, path, parameters, and response codes.
WORKLOAD 2
The operations to manage workloads v1.
POST
/nerve/workload/controller
Control life-cycle and workflow of the deployed workload
managing_deployed_workloadbody→ 200400403404500
DELETE
/nerve/workload/{workloadId}
Delete the selected workload
delete_workload1 param→ 204403404
NODE 13
The operations to manage nodes v1.
GET
/nerve/workload/node/{serialNumber}/devices
Get list of deployed workloads on the selected node
Reload configuration for a specific parameter from configuration.yaml
config_reload1 param→ 200404500
PATCH
/nerve/internal-test-api/config/{parameter}
Modify configuration for a specific parameter from configuration.yaml file
config_modify1 parambody→ 202404500
GET
/nerve/internal-test-api/config/{parameter}
Get the configuration for a specific parameter from configuration.yaml file
get_config1 param→ 200404
POST
/nerve/internal-test-api/mqtt
Publish an MQTT message for testing
publish_mqtt_messagebody→ 204
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are v3_docker_wl_specific_properties (9 properties), add_edit_notification (5 properties), rc_node (2 properties), rc_compose (2 properties). Each schema is shown below with its type and property counts.
v2_create_workload
object
Create Workload - V2 API endpoint
v2_update_workload
object
Used to add a new workload version or to update the existing version - V2 API endpoint
v3_add_edit_file
object
Add/edit file request payload
add_edit_notification
object
Add/edit notification request payload
5 properties2 required
rc_docker
object
2 properties2 required
rc_vm
object
2 properties2 required
rc_codesys
object
2 properties2 required
rc_compose
object
2 properties2 required
rc_node
object
2 properties2 required
v3_docker_wl_specific_properties
object
Docker specific properties
9 properties1 required
v3_docker_compose_wl_specific_properties
object
An object containing a specific properties for docker-compose workload type
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Nerve Management System 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.