Skip to content

Project API

Lists all projects in the space.

Terminal window
curl -b cookies.txt http://localhost:8081/api/projects \
-H "X-Space: claude"

Response:

[
{
"id": 153,
"name": "Energy Monitoring Demo",
"dsc": "Demo project for energy monitoring with simulated data",
"isActive": true,
"latitude": null,
"longitude": null,
"createdBy": "inscada",
"creationDate": "2026-03-04T14:47:52.913+03:00",
"lastModifiedDate": "2026-03-04T14:47:52.913+03:00"
},
{
"id": 353,
"name": "Building",
"dsc": "Building Management System - HVAC & Air Conditioning Demo",
"isActive": true
}
]

Returns project details.

Terminal window
curl -b cookies.txt http://localhost:8081/api/projects/153 \
-H "X-Space: claude"

Response:

{
"id": 153,
"name": "Energy Monitoring Demo",
"dsc": "Demo project for energy monitoring with simulated data",
"isActive": true,
"icon": null,
"address": null,
"latitude": null,
"longitude": null,
"properties": null,
"createdBy": "inscada",
"creationDate": "2026-03-04T14:47:52.913+03:00"
}

Returns the running status of all project components.

Terminal window
curl -b cookies.txt http://localhost:8081/api/projects/153/status \
-H "X-Space: claude"

Response:

{
"connectionStatuses": { "153": "Connected" },
"scriptStatuses": { "160": "Not Scheduled", "159": "Not Scheduled" },
"dataTransferStatuses": {},
"reportStatuses": {},
"alarmGroupStatuses": {}
}
MethodEndpointDescription
POST/api/projectsCreate a new project
PUT/api/projects/{id}Update a project
DELETE/api/projects/{id}Delete a project
POST/api/projects/cloneClone a project
Terminal window
curl -b cookies.txt -X POST http://localhost:8081/api/projects \
-H "X-Space: claude" -H "Content-Type: application/json" \
-d '{
"name": "New Project",
"dsc": "Project description",
"isActive": true,
"latitude": 41.0,
"longitude": 29.0
}'

Lists the connections in a project.

Terminal window
curl -b cookies.txt "http://localhost:8081/api/connections?projectId=153" \
-H "X-Space: claude"

Response:

[
{
"id": 153,
"name": "LOCAL-Energy",
"protocol": "LOCAL",
"ip": "127.0.0.1",
"port": 0,
"projectId": 153,
"dsc": "Local protocol connection for energy simulation",
"owner": "inscada"
}
]
MethodEndpointDescription
POST/api/connections/{id}/startStart a connection
POST/api/connections/{id}/stopStop a connection
GET/api/connections/{id}/statusConnection status