Get's the current version of the tremor server
This endpoint returns version information for the current version of tremor. Versioning policy follows Semantic Versioning
Responses
Response samples
- 200
{- "version": "0.11.4",
- "debug": true
}Get's the current runtime status
This endpoint returns the runtime status of the tremor server.
It returns a summary of the status of all deployed flows and
contains a flag all_running to check if all flows are alive and well.
Responses
Response samples
- 200
- 503
{- "all_running": false,
- "num_flows": 2,
- "flows": {
- "initializing": 1,
- "failed": 1
}
}Get information on all flows in the tremor runtime.
Get information on all flows in the tremor runtime. It returns an array with 1 item for each flow with information on name, current status and connectors.
Responses
Response samples
- 200
[- {
- "alias": "kafka",
- "status": "initializing",
- "connectors": [
- "consumer1",
- "metrics",
- "out"
]
}
]change the status of a flow
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
Request Body schema:
Intended status description
| status required | string Enum: "running" "paused" Valid statusses flows and connectors can be switched to |
Responses
Request samples
- Payload
{- "status": "paused"
}Response samples
- 200
- 400
{- "alias": "kafka",
- "status": "initializing",
- "connectors": [
- "consumer1",
- "metrics",
- "out"
]
}Get detailed information on all connectors in the flow identified by 'flow-id'
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
Responses
Response samples
- 200
[- {
- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}
]Get detailed information on the connector 'connector-id' in the flow 'flow-id'.
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
| connector-id required | string The unique id of the connector within the flow |
Responses
Response samples
- 200
{- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}change the status of a connector
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
| connector-id required | string The unique id of the connector within the flow |
Request Body schema:
Intended status description
| status required | string Enum: "running" "paused" Valid statusses flows and connectors can be switched to |
Responses
Request samples
- Payload
{- "status": "paused"
}Response samples
- 200
- 400
- 404
{- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}Get detailed information on all connectors in the flow identified by 'flow-id'
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
Responses
Response samples
- 200
[- {
- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}
]Get detailed information on the connector 'connector-id' in the flow 'flow-id'.
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
| connector-id required | string The unique id of the connector within the flow |
Responses
Response samples
- 200
{- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}change the status of a connector
path Parameters
| flow-id required | string The unique id of the flow in the runtime |
| connector-id required | string The unique id of the connector within the flow |
Request Body schema:
Intended status description
| status required | string Enum: "running" "paused" Valid statusses flows and connectors can be switched to |
Responses
Request samples
- Payload
{- "status": "paused"
}Response samples
- 200
- 400
- 404
{- "alias": "foo",
- "status": "running",
- "connectivity": "connected",
- "pipelines": {
- "out": [
- {
- "alias": "pass",
- "port": "in"
}
]
}
}