This page lists every HTTP endpoint exposed by an MTConnect.NET agent. The list is generated by walking the source tree with Roslyn.
Surface taxonomy
- Agent API — the MTConnect-Standard request types (
/probe,/current,/sample,/assets,/asset/{id}, and the per-device variants of the same). Every endpoint listed below currently belongs to this surface. - Admin / diagnostic — none. No administrative endpoint is currently exposed. A search for
/admin,/diagnostics,/metrics, or/healthacross the source tree returns no hits.
Ceen transport (MTConnect.NET-HTTP)
Routes are registered inside MTConnectHttpServer.ConfigureServer and dispatched by the bundled Ceen router.
| Method | Path | Handler | Source |
|---|---|---|---|
GET |
(any) |
probeHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:354 |
GET |
/ |
probeHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:340 |
GET |
/*/assets |
assetsHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:348 |
GET |
/*/current |
currentHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:344 |
GET |
/*/probe |
probeHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:342 |
GET |
/*/sample |
sampleHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:346 |
GET |
/asset/* |
assetHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:349 |
GET |
/assets |
assetsHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:347 |
GET |
/current |
currentHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:343 |
GET |
/probe |
probeHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:341 |
GET |
/sample |
sampleHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:345 |
POST |
(any) |
postHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:336 |
PUT |
(any) |
putHandler |
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:332 |
Per-endpoint detail
GET (any) — Ceen
- Handler:
probeHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:354
Method-gated dispatcher; routes the request to the handler matching the request method.
GET / — Ceen
- Handler:
probeHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:340 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Probe endpoint (GET /probe and GET /{deviceKey}/probe, plus the bare GET / alias). Returns an MTConnectDevices Response Document describing the device metadata visible to the agent. The optional leading path segment selects a single device by name or UUID. The response document format is negotiated via the documentFormat query parameter (xml | json | json-cppagent) and defaults to XML; deviceType, version, validationLevel, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format (xml | json | json-cppagent). |
validationLevel |
Query | int |
0=ignore, 1=warning, 2=remove, 3=strict. | |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /*/assets — Ceen
- Handler:
assetsHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:348 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Assets endpoint (GET /assets and GET /{deviceKey}/assets). Returns an MTConnectAssets Response Document containing the asset records known to the agent. The optional leading path segment scopes the response to assets owned by a specific device; the type, removed, and count query parameters filter the asset set; documentFormat (xml | json | json-cppagent, default XML) and indentOutput negotiate the rendered representation.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
type |
Query | string |
Asset type filter (e.g. CuttingTool). | |
removed |
Query | bool |
Include removed assets when true. | |
count |
Query | int |
Maximum number of assets. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. |
GET /*/current — Ceen
- Handler:
currentHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:344 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Current endpoint (GET /current and GET /{deviceKey}/current). Returns an MTConnectStreams Response Document containing the current observation snapshot for every data item visible to the agent, optionally filtered by an XPath in the path query parameter and anchored to a sequence number via at. When interval is supplied, the handler upgrades the response to a multipart x-mixed-replace stream and emits a fresh snapshot every interval milliseconds, interleaved with heartbeats. The response document format is negotiated via documentFormat (xml | json | json-cppagent), defaulting to XML; deviceType, version, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
path |
Query | string |
XPath that filters the data items included in the response. | |
at |
Query | ulong |
Sequence number anchoring the snapshot. | |
interval |
Query | int |
Streaming interval in milliseconds; switches to multipart streaming when > 0. | |
heartbeat |
Query | int |
10000 | Heartbeat interval for the streaming response. |
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /*/probe — Ceen
- Handler:
probeHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:342 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Probe endpoint (GET /probe and GET /{deviceKey}/probe, plus the bare GET / alias). Returns an MTConnectDevices Response Document describing the device metadata visible to the agent. The optional leading path segment selects a single device by name or UUID. The response document format is negotiated via the documentFormat query parameter (xml | json | json-cppagent) and defaults to XML; deviceType, version, validationLevel, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format (xml | json | json-cppagent). |
validationLevel |
Query | int |
0=ignore, 1=warning, 2=remove, 3=strict. | |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /*/sample — Ceen
- Handler:
sampleHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:346 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Sample endpoint (GET /sample and GET /{deviceKey}/sample). Returns an MTConnectStreams Response Document containing a slice of historical observations bounded by the from / to / count query parameters, optionally filtered by an XPath in path. When interval is supplied, the handler upgrades the response to a multipart x-mixed-replace stream and emits successive sample windows every interval milliseconds, interleaved with heartbeats. The response document format is negotiated via documentFormat (xml | json | json-cppagent), defaulting to XML; deviceType, version, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
path |
Query | string |
XPath that filters the data items included in the response. | |
from |
Query | ulong |
Sequence number lower bound. | |
to |
Query | ulong |
Sequence number upper bound. | |
count |
Query | int |
100 | Maximum number of observations. |
interval |
Query | int |
Streaming interval in milliseconds; switches to multipart streaming when > 0. | |
heartbeat |
Query | int |
10000 | Heartbeat interval for the streaming response. |
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /asset/* — Ceen
- Handler:
assetHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:349 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the single-asset MTConnect endpoint (GET /asset/{assetId}). Returns an MTConnectAssets Response Document containing the asset identified by the trailing path segment, or an MTConnectError document with status 404 when no such asset exists. The response document format is negotiated via the documentFormat query parameter (xml | json | json-cppagent) and defaults to XML.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
assetId |
Route | string |
Asset identifier captured from the trailing path segment. | |
documentFormat |
Query | string |
xml | Response document format. |
GET /assets — Ceen
- Handler:
assetsHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:347 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Assets endpoint (GET /assets and GET /{deviceKey}/assets). Returns an MTConnectAssets Response Document containing the asset records known to the agent. The optional leading path segment scopes the response to assets owned by a specific device; the type, removed, and count query parameters filter the asset set; documentFormat (xml | json | json-cppagent, default XML) and indentOutput negotiate the rendered representation.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
type |
Query | string |
Asset type filter (e.g. CuttingTool). | |
removed |
Query | bool |
Include removed assets when true. | |
count |
Query | int |
Maximum number of assets. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. |
GET /current — Ceen
- Handler:
currentHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:343 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Current endpoint (GET /current and GET /{deviceKey}/current). Returns an MTConnectStreams Response Document containing the current observation snapshot for every data item visible to the agent, optionally filtered by an XPath in the path query parameter and anchored to a sequence number via at. When interval is supplied, the handler upgrades the response to a multipart x-mixed-replace stream and emits a fresh snapshot every interval milliseconds, interleaved with heartbeats. The response document format is negotiated via documentFormat (xml | json | json-cppagent), defaulting to XML; deviceType, version, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
path |
Query | string |
XPath that filters the data items included in the response. | |
at |
Query | ulong |
Sequence number anchoring the snapshot. | |
interval |
Query | int |
Streaming interval in milliseconds; switches to multipart streaming when > 0. | |
heartbeat |
Query | int |
10000 | Heartbeat interval for the streaming response. |
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /probe — Ceen
- Handler:
probeHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:341 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Probe endpoint (GET /probe and GET /{deviceKey}/probe, plus the bare GET / alias). Returns an MTConnectDevices Response Document describing the device metadata visible to the agent. The optional leading path segment selects a single device by name or UUID. The response document format is negotiated via the documentFormat query parameter (xml | json | json-cppagent) and defaults to XML; deviceType, version, validationLevel, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format (xml | json | json-cppagent). |
validationLevel |
Query | int |
0=ignore, 1=warning, 2=remove, 3=strict. | |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
GET /sample — Ceen
- Handler:
sampleHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:345 - Response status codes: 200, 400, 404, 406, 500
Ceen request handler for the MTConnect Sample endpoint (GET /sample and GET /{deviceKey}/sample). Returns an MTConnectStreams Response Document containing a slice of historical observations bounded by the from / to / count query parameters, optionally filtered by an XPath in path. When interval is supplied, the handler upgrades the response to a multipart x-mixed-replace stream and emits successive sample windows every interval milliseconds, interleaved with heartbeats. The response document format is negotiated via documentFormat (xml | json | json-cppagent), defaulting to XML; deviceType, version, indentOutput, and outputComments further shape the payload.
Parameters
| Name | Kind | Type | Default | Description |
|---|---|---|---|---|
path |
Query | string |
XPath that filters the data items included in the response. | |
from |
Query | ulong |
Sequence number lower bound. | |
to |
Query | ulong |
Sequence number upper bound. | |
count |
Query | int |
100 | Maximum number of observations. |
interval |
Query | int |
Streaming interval in milliseconds; switches to multipart streaming when > 0. | |
heartbeat |
Query | int |
10000 | Heartbeat interval for the streaming response. |
deviceType |
Query | string |
Optional device-type filter. | |
version |
Query | string |
Target MTConnect Standard version of the response document. | |
documentFormat |
Query | string |
xml | Response document format. |
indentOutput |
Query | bool |
Pretty-print the response document. | |
outputComments |
Query | bool |
Emit comments / annotations in the response document. |
POST (any) — Ceen
- Handler:
postHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:336
Method-gated dispatcher; routes the request to the handler matching the request method.
PUT (any) — Ceen
- Handler:
putHandler - Surface: Agent
- Source:
libraries/MTConnect.NET-HTTP/Servers/MTConnectHttpServer.cs:332
Method-gated dispatcher; routes the request to the handler matching the request method.