REST API

Caladrius exposes several REST endpoints over which to request performance modelling.

Model

Traffic

GET /model/traffic/{dsps-name}/model_info

Returns:
A JSON list of objects each with a name and decription attribute for the configured traffic models. The names are unique across Caladrius and can be used in the model fields of other requests.

GET /model/traffic/{dsps-name}

Parameters:
topology_id
Required - The topology identification string
cluster
Required - The cluster the topology is running on
environ
Required - The environment the cluster is running in (“prod”, “devel”, etc)
model
Required - Repeated - One or more models to be run. These names should match the names returned by the model information endpoint. Alternatively, all can be supplied to run all configured traffic models.
source_hours
Required - The number of hours of source data to use in the traffic model predictions.

Topology

GET /model/topology/{dsps-name}/model_info

Returns:
A JSON list of objects each with a name and decription attribute for the configured topology performance models. The names are unique across Caladrius and can be used in the model fields of other requests.

POST /model/topology/{dsps-name}/current

Parameters:
topology_id
Required - The topology identification string
cluster
Required - The cluster the topology is running on
environ
Required - The environment the cluster is running in (“prod”, “devel”, etc)
model
Required - Repeated - One or more models to be run. These names should match the names returned by the model information endpoint. Alternatively, all can be supplied to run all configured traffic models.