API docs by Redocly

Real-Time API — Version Settings (1.0.0)

Download OpenAPI specification:

HTTP API for managing per-user measurement queue version preferences. Use this API to schedule a switch from the v1 measurement stream (Kinesis) to the v2 stream (Kafka), or to cancel an upcoming switch.

Schedule a version switch

Schedules a schema version switch for a queue from a given point in time (ISO 8601 UTC). A sentinel row with version 1 and activeFrom 1970-01-01T00:00:00Z is automatically created on first save as the default fallback. Downgrading to a lower version number is not allowed.

Authorizations:
bearerAuth
Request Body schema: application/json
required
queue
required
string
Enum: "measurements" "alarms"

The queue this setting applies to.

version
required
integer
Value: 2

Target version. Only upgrading to version 2 is supported.

activeFrom
required
string <date-time>

UTC timestamp (ISO 8601) from which this version becomes active.

Responses

Request samples

Content type
application/json
{
  • "queue": "measurements",
  • "version": 2,
  • "activeFrom": "2026-07-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "queue": "measurements",
  • "version": 2,
  • "activeFrom": "2026-07-01T00:00:00Z"
}

List version settings

Returns all stored version settings entries for the authenticated user and the given queue, including the default sentinel row with activeFrom 1970-01-01T00:00:00Z.

Authorizations:
bearerAuth
query Parameters
queue
required
string
Enum: "measurements" "alarms"

The measurement queue to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Delete upcoming version entries

Deletes future entries (activeFrom > now) for the authenticated user and queue. The sentinel row (activeFrom = 1970-01-01T00:00:00Z) and fully completed history entries are always kept.

By default, entries currently mid-transition (activeFrom <= now but activeFrom + 4h > now) are also kept. Pass deleteTransition=true to also cancel an in-progress transition.

Authorizations:
bearerAuth
query Parameters
queue
required
string
Enum: "measurements" "alarms"

The measurement queue to operate on.

deleteTransition
boolean
Default: false

When true, also deletes entries currently in the 4-hour transition window (activeFrom <= now < activeFrom + 4h). Defaults to false.

Responses

Response samples

Content type
application/json
"queue must be one of: [measurements, alarms]"