Skip to main content

Tremor Api (12.0)

Download OpenAPI specification:Download

License: Apache 2.0

REST API for tremor

version

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

Content type
application/json
{
  • "version": "0.11.4",
  • "debug": true
}

status

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

Content type
{
  • "all_running": false,
  • "num_flows": 2,
  • "flows": {
    }
}

flows

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

Content type
[
  • {
    }
]

Get information

path Parameters
flow-id
required
string

The unique id of the flow in the runtime

Responses

Response samples

Content type
{
  • "alias": "kafka",
  • "status": "initializing",
  • "connectors": [
    ]
}

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

Content type
{
  • "status": "paused"
}

Response samples

Content type
{
  • "alias": "kafka",
  • "status": "initializing",
  • "connectors": [
    ]
}

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

Content type
[
  • {
    }
]

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

Content type
{
  • "alias": "foo",
  • "status": "running",
  • "connectivity": "connected",
  • "pipelines": {
    }
}

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

Content type
{
  • "status": "paused"
}

Response samples

Content type
{
  • "alias": "foo",
  • "status": "running",
  • "connectivity": "connected",
  • "pipelines": {
    }
}

connectors

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

Content type
[
  • {
    }
]

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

Content type
{
  • "alias": "foo",
  • "status": "running",
  • "connectivity": "connected",
  • "pipelines": {
    }
}

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

Content type
{
  • "status": "paused"
}

Response samples

Content type
{
  • "alias": "foo",
  • "status": "running",
  • "connectivity": "connected",
  • "pipelines": {
    }
}