Connection Management Controller

post
Authorizations
Path parameters
connectionIdstringRequired
Responses
204

No Content

No content

post
/api/connections/{connectionId}/stop
POST /api/connections/{connectionId}/stop HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Path parameters
connectionIdstringRequired
Responses
204

No Content

No content

post
/api/connections/{connectionId}/start
POST /api/connections/{connectionId}/start HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Query parameters
projectIdstringRequired
Responses
204

No Content

No content

post
/api/connections/stop/by-project
POST /api/connections/stop/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204

No Content

No content

post
/api/connections/stop/by-project-and-name
POST /api/connections/stop/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204

No Content

No content

post
/api/connections/start
POST /api/connections/start?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Query parameters
projectIdstringRequired
Responses
204

No Content

No content

post
/api/connections/start/by-project
POST /api/connections/start/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204

No Content

No content

post
/api/connections/start/by-project-and-name
POST /api/connections/start/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/connections/{connectionId}/status
GET /api/connections/{connectionId}/status HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
Connected
get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200

OK

*/*
Responseobject
get
/api/connections/{connectionId}/browse
GET /api/connections/{connectionId}/browse HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{}
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/connections/status/by-project-and-name
GET /api/connections/status/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
Connected
get
Authorizations
Query parameters
connectionIdsstring[]Required
Responses
200

OK

*/*
get
/api/connections/status/by-ids
GET /api/connections/status/by-ids?connectionIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": "Connected"
}

Last updated