Systems
The /systems
endpoint provides methods for discovering, creating and interacting with systems. For more on the role that systems play, see:
All systems provide a base set of metadata that helps to describe their role and capabilities, as well as provide references to the modules they contain, and the zones they exist in.
Model
Discovery
Search
GET
https://example.com/api/control/systems
Direct queries to the systems endpoint list, or search for existing systems.
Query Parameters
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Management
Create
POST
https://example.com/api/control/systems
Defines a new system. Systems names must be unique within the instance they are running on and all systems must have at least one zone associated. All other attributes are optional at the time of creation.
Request Body
Retrieve
GET
https://example.com/api/control/systems/{id}
Retrieve all metadata associated with the system.
Path Parameters
Query Parameters
Update
PUT
https://example.com/api/control/systems/{id}
Updates system attributes. Any selection of attributes form the request - unspecified items will keep their current values. All requests must include a version parameter that matches the current system version.
Path Parameters
Request Body
Delete
DELETE
https://example.com/api/control/systems/{id}
Removes a system. This will stop, and remove any modules that are not associated with other systems.
Path Parameters
Interaction
Start
POST
https://example.com/api/control/systems/{id}/start
Starts all modules associated with the system.
Path Parameters
Stop
POST
https://example.com/api/control/systems/{id}/stop
Stops all modules associated with the system.
Path Parameters
Exec
POST
https://example.com/api/control/systems/{id}/exec
Run behaviour exposed by a module. The associated method will execute and the response returned. If this includes asynchronous or long running behaviour, the result will be awaiting up until a timeout value.
Path Parameters
Request Body
State
GET
https://example.com/api/control/systems/{id}/state
Query the state exposed by a module within the system.
Path Parameters
Query Parameters
Funcs
GET
https://example.com/api/control/systems/{id}/funcs
Query the behaviour exposed by a module within the system.
Path Parameters
Query Parameters
Count
GET
https://example.com/api/control/systems/{id}/count
Counts the instances of a driver type within a system.
Path Parameters
Query Parameters
Types
GET
https://example.com/api/control/systems/{id}/types
Query the types of modules available within a system.
Path Parameters
Last updated