Skip to main content
API docs by Redocly

VILLAScontroller API (0.0.1)

Download OpenAPI specification:Download

Steffen Vogel: svogel2@eonerc.rwth-aachen.de License: Apache-2.0

A HTTP/REST API for controlling VILLAScontroller remotely for querying component status as well as issuing control actions.

status

Get status of VILLAScontroller daemon

Responses

Response samples

Content type
application/json
{
  • "components": [
    ],
  • "status": {
    }
}

Query health of daemon.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get the current status of a component

path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "components": [ ],
  • "status": {
    },
  • "properties": {
    },
  • "schema": {
    }
}

Send a control action to the component

Request Body schema: application/json
action
string
Enum: "start" "stop" "pause" "resume" "create" "delete" "shutdown" "reset"
create (object) or create-2 (object) or start (object) or start-2 (object)

Responses

Request samples

Content type
application/json
{}