TTTech REMOTE CONNECTIONS API
The operations to manage remote connections.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/tttech-remote-connections-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Tttech REMOTE CONNECTIONS API
contact:
name: Nerve support
email: support@tttech-industrial.com
version: '1.0'
description: 'Operations tagged REMOTE_CONNECTIONS across 2 of this provider''s published API definitions: tttech-nerve-management-system-openapi-original.json, tttech-nerve-node-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://trynerve1.nerve.cloud
tags:
- name: Remote Connections
description: The operations to manage remote connections.
paths:
/nerve/remote-connections/connect:
post:
summary: Connect remote connections
operationId: connect_remote_connections
tags:
- Remote Connections
description: Used to establish remote connections defined in body.
requestBody:
content:
application/json:
schema:
description: Object containing data about remote connection which should be established.
type: object
additionalProperties: false
required:
- acknowledgment
- name
- port
- serialNumber
- type
- versionId
- workloadId
- _id
- uniqueConnectionRequestNo
properties:
acknowledgment:
type: string
description: Defines if local acknowledgement is required to establish a connection. To confirm connection, it is necessary to have access to the LocalUI web application.
enum:
- 'Yes'
- 'No'
connection:
description: Remote screen type
type: string
enum:
- VNC
- SSH
- RDP
name:
type: string
description: Remote connection name
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
minLength: 1
maxLength: 40
port:
type: integer
format: int32
minimum: 0
maximum: 65535
description: Port on the target to which connection is established (port on the node for opening tunnel to chisel server)
serialNumber:
description: The serial number of the node
type: string
maxLength: 12
minLength: 12
pattern: ([A-Z0-9]){12}
type:
description: The type of remote connection
type: string
enum:
- TUNNEL
- SCREEN
versionId:
oneOf:
- description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
workloadId:
oneOf:
- description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
_id:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
uniqueConnectionRequestNo:
description: Remote connection unique identifier.
type: string
minLength: 36
maxLength: 36
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
examples:
screen_on_node:
value:
acknowledgment: 'Yes'
connection: VNC
name: screen node vnc
port: 5900
serialNumber: MARINAM12345
type: SCREEN
versionId: ''
workloadId: ''
_id: 66e727bc2b5aaf9be9bea769
uniqueConnectionRequestNo: 9f0e0ef0-7402-11ef-bf05-a1acbd98ce10
tunnel_on_node:
value:
acknowledgment: 'No'
name: tunnel node
port: 1134
serialNumber: MARINAM12345
type: TUNNEL
versionId: ''
workloadId: ''
_id: 66e727bc2b5aaf9be9bea769
uniqueConnectionRequestNo: 9f0e0ef0-7402-11ef-bf05-a1acbd98ce10
tunnel_on_wl:
value:
acknowledgment: 'No'
name: tunnel node
port: 1134
serialNumber: MARINAM12345
type: TUNNEL
versionId: 66b323e6b59fc012ffd9eebd
workloadId: 66b323e6b59fc012ffd9eeb4
_id: 66c7313fb0358b55c8c7d486
uniqueConnectionRequestNo: bac60170-7402-11ef-bf05-a1acbd98ce10
required: true
x-permissions:
- REMOTE_CONN:CONNECT
responses:
'200':
description: Connection successfully established.
content:
application/json:
schema:
anyOf:
- type: object
description: Response object containing details of remote connection that is already active on the system or just requestUid if connection is not active.
required:
- requestUid
properties:
connected:
description: Indicates weather remote connection is active or not.
type: boolean
requestId:
description: Remote connection unique identifier.
type: string
minLength: 36
maxLength: 36
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
requestUid:
description: Remote connection unique identifier.
type: string
minLength: 36
maxLength: 36
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type:
description: The type of remote connection
type: string
enum:
- TUNNEL
- SCREEN
url:
type: string
pattern: ^[\x20-\x7E\t\n\r]*$
description: request url for opening Nerve Connection Manager to active tunnel.
minLength: 0
maxLength: 1001
expiresAt:
description: The date indicating when the session of the remote connection will expire.
type: string
format: date-time
minLength: 8
maxLength: 30
- type: object
description: Response object in case there is some error while trying to establish remote connection.
required:
- requestUid
- error
properties:
requestUid:
description: Remote connection unique identifier.
type: string
minLength: 36
maxLength: 36
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
error:
description: Error message and code
type: object
required:
- code
- message
properties:
code:
description: String that is used as a key for appropriate translation on the front-end application.
type: string
minLength: 4
maxLength: 100
pattern: ^[a-zA-Z0-9_-]*$
message:
type: string
pattern: ^[\x20-\x7E\t\n\r]*$
description: Error message in English.
minLength: 5
maxLength: 512
examples:
connected_successfully:
value:
requestUid: 840a6990-7408-11ef-9596-5da4601f695f
expiresAt: '2024-09-17T10:49:49.481Z'
connected_successfully_rc_already_active:
value:
requestId: e5a1e04f-726e-4f4b-83b1-218bfc41e76e
type: TUNNEL
url: nerverm://docker-test.dev.nerve.cloud/66e7e746096ce88e5ab15c9a/840a6990-7408-11ef-9596-5da4601f695f
connected: true
requestUid: 840a6990-7408-11ef-9596-5da4601f695f
expiresAt: '2024-09-17T10:49:49.481Z'
rc_not_found:
value:
requestUid: 26dba360-740d-11ef-af07-a1973757c259
error:
code: 862
message: Remote connection you are looking for does not exist!
'403':
description: You are not authorized to perform this operation
content:
application/json:
schema:
description: Generic error response returned from the server in case of a failed operation.
properties:
errorCode:
description: String that is used as a key for appropriate translation on the front-end application.
type: string
minLength: 4
maxLength: 100
pattern: ^[a-zA-Z0-9_-]*$
httpCode:
description: Http error code assigned to the error.
type: string
minLength: 3
maxLength: 3
pattern: ^[0-9]*$
message:
description: Error message in English.
minLength: 5
maxLength: 512
type: string
pattern: ^[\x20-\x7E\t\n\r]*$
examples:
not_authorized:
value:
errorCode: '00003'
httpCode: '403'
message: You are not authorized
'409':
description: Maximum number of remote connection requests exceeded
content:
application/json:
schema:
description: Generic error response returned from the server in case of a failed operation.
properties:
errorCode:
description: String that is used as a key for appropriate translation on the front-end application.
type: string
minLength: 4
maxLength: 100
pattern: ^[a-zA-Z0-9_-]*$
httpCode:
description: Http error code assigned to the error.
type: string
minLength: 3
maxLength: 3
pattern: ^[0-9]*$
message:
description: Error message in English.
minLength: 5
maxLength: 512
type: string
pattern: ^[\x20-\x7E\t\n\r]*$
example:
errorCode: nerve_remote_connection_18
httpCode: '409'
message: You have exceeded the maximum number of remote connection requests allowed
'500':
description: Internal server error
content:
application/json:
schema:
description: Generic error response returned from the server in case of a failed operation.
properties:
errorCode:
description: String that is used as a key for appropriate translation on the front-end application.
type: string
minLength: 4
maxLength: 100
pattern: ^[a-zA-Z0-9_-]*$
httpCode:
description: Http error code assigned to the error.
type: string
minLength: 3
maxLength: 3
pattern: ^[0-9]*$
message:
description: Error message in English.
minLength: 5
maxLength: 512
type: string
pattern: ^[\x20-\x7E\t\n\r]*$
example:
httpCode: '500'
errorCode: nerve_dna_006
message: Operation failed for unknown reason.
security:
- sessionId: []
servers:
- url: https://trynerve1.nerve.cloud
/nerve/active-remote-connections:
get:
summary: Get list of active remote connections
operationId: get_list_of_active_remote_connections
tags:
- Remote Connections
description: Method is used to get list of active remote connections
parameters:
- name: limit
in: query
description: Number of items per page of result.
schema:
description: Number of items in result set when paging is applied
type: integer
format: int32
default: 10
minimum: 1
maximum: 500
- name: page
in: query
description: Page of results to be returned, according to number of items per page defined in limit parameter.
schema:
description: Page (zero indexed) of results to get from backend
type: integer
format: int32
default: 0
minimum: 0
maximum: 1000
- name: order
in: query
description: Order by connection name, time of creation, node name, serial number of node, acknowledgment, target or user that established connection.
allowReserved: true
schema:
type: string
description: Sort by connection, creation, node, serialNumber, acknowledgment, target or user in descending or ascending order.
enum:
- '{"connection":"desc"}'
- '{"connection":"asc"}'
- '{"created":"desc"}'
- '{"created":"asc"}'
- '{"node":"desc"}'
- '{"node":"asc"}'
- '{"serialNumber":"desc"}'
- '{"serialNumber":"asc"}'
- '{"acknowledgment":"desc"}'
- '{"acknowledgment":"asc"}'
- '{"target":"desc"}'
- '{"target":"asc"}'
- '{"user":"desc"}'
- '{"user":"asc"}'
- '{"expiresAt":"desc"}'
- '{"expiresAt":"asc"}'
- name: type
in: query
description: Apply filtering by remote connection type (tunnel, screen)
allowReserved: true
schema:
type: string
enum:
- ''
- tunnel
- screen
- name: search
in: query
description: Searching remote connections by name.
required: false
schema:
type: string
minLength: 0
maxLength: 1001
pattern: ^(?:$|(?=.*[^ ].*)([^\u0000-\u001f\u007f-\u009f]*))$
x-permissions:
- REMOTE_CONN:LIST
responses:
'200':
description: Request successful. Object containing count and list of active remote connections returned.
content:
application/json:
schema:
type: object
description: Count of all established remote connections and object containing the list of specific active remote connections depending on the query parameters.
required:
- count
- data
properties:
count:
type: integer
format: int32
minimum: 0
maximum: 1000000
description: Number of results
data:
description: List of active remote connections
type: array
minItems: 0
maxItems: 1001
items:
type: object
description: Remote connection and connection request basic information.
additionalProperties: false
required:
- _id
- name
- connection
- connectionRequest
properties:
_id:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
name:
type: string
description: Remote connection name
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
minLength: 1
maxLength: 40
connection:
anyOf:
- allOf:
- type: object
description: Basic information about an active remote connection
required:
- _id
- serialNumber
- target
- nodeStatus
- connectionUid
- acknowledgment
properties:
_id:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
serialNumber:
description: The serial number of the node
type: string
maxLength: 12
minLength: 12
pattern: ([A-Z0-9]){12}
target:
type: object
description: Object containing basic information about target to which remote connection is being established.
required:
- workloadOrHostname
- workloadVersion
- workloadId
- versionId
- _id
properties:
workloadOrHostname:
oneOf:
- type: string
description: Target hostname or ip address to which connection is established
minLength: 1
maxLength: 40
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
- type: string
description: Workload name and port
minLength: 1
maxLength: 46
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
workloadVersion:
oneOf:
- type: string
description: Version name
minLength: 1
maxLength: 40
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
nodeName:
type: string
description: The name of the node
minLength: 1
maxLength: 40
pattern: ^\s*(?=[a-zA-Z0-9_ -]+$)\S.*$
nodeId:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
workloadId:
oneOf:
- description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
versionId:
oneOf:
- description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
_id:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
nodeStatus:
description: Status if the node connection to MS
enum:
- online
- offline
connectionUid:
description: Remote connection unique identifier.
type: string
minLength: 36
maxLength: 36
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
localPort:
type: integer
format: int32
minimum: 0
maximum: 65535
description: Port on local PC to establish remote tunnel
acknowledgment:
type: string
description: Defines if local acknowledgement is required to establish a connection. To confirm connection, it is necessary to have access to the LocalUI web application.
enum:
- 'Yes'
- 'No'
- type: object
properties:
connection:
description: Remote screen type
type: string
enum:
- VNC
- SSH
- RDP
guacamoleConnectionId:
description: Guacamole connection id
type: number
type:
description: The type of remote connection
type: string
enum:
- SCREEN
required:
- type
- connection
- allOf:
- type: object
description: Basic information about an active remote connection
required:
- _id
- serialNumber
- target
- nodeStatus
- connectionUid
- acknowledgment
properties:
_id:
description: ID (from Management System) of the entry. Can be a string or an object.
oneOf:
- description: ID (from Management System) of the entry
type: string
pattern: ^[0-9a-fA-F]{24}$
minLength: 24
maxLength: 24
- type: object
serialNumber:
description: The serial number of the node
type: string
maxLength: 12
minLength: 12
pattern: ([A-Z0-9]){12}
target:
type: object
description: Object containing basic information about target to which remote connection is being established.
required:
- workloadOrHostname
- workloadVersion
- workloadId
- versionId
- _id
properties:
workloadOrHostname:
oneOf:
- type: string
description: Target hostname or ip address to which connection is established
minLength: 1
maxLength: 40
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
- type: string
description: Workload name and port
minLength: 1
maxLength: 46
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
workloadVersion:
oneOf:
- type: string
description: Version name
minLength: 1
maxLength: 40
pattern: (?=.*[^ ].*)(?=(^[^\u0000-\u001f\u007f-\u009f]*$))
- type: string
description: Empty string
enum:
- ''
minLength: 0
maxLength: 0
pattern: ^$
nodeName:
type: string
description: The name of the node
minLength: 1
maxLength: 40
pattern: ^\s*(?=[a-zA-Z0-9_ -]+$)\S.*$
nodeId:
description: ID (from Management System) of the entry. Can be a string or an object.
# --- truncated at 32 KB (177 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tttech/refs/heads/main/openapi/tttech-remote-connections-api-openapi.yml