logo
Documentation Powered by ReDoc

StackState API (0.0.1)

Download OpenAPI specification:Download

StackState: info@stackstate.com URL: https://stackstate.com License: Apache 2.0

StackState's API specification

Documentation

Authentication

ApiToken

Security Scheme Type API Key
Header parameter name: X-API-Token

ServiceToken

Security Scheme Type API Key
Header parameter name: X-API-Key

ServiceBearer

Security Scheme Type API Key
Header parameter name: X-API-ServiceBearer

import

Import settings

Import StackState Templated JSON (STJ) setting nodes.

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
timeoutSeconds
integer <int64>
namespace
string
unlocked
string
Enum: "fail" "skip" "overwrite"
Request Body schema: plain/text
string

Responses

Response samples

Content type
application/json
[
  • { }
]

export

Export settings

Export StackState Templated JSON (STJ) setting nodes.

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json
nodesWithIds
Array of integers <int64>
allNodesOfTypes
Array of strings
namespace
string
allowReferences
Array of strings

Responses

Request samples

Content type
application/json
{
  • "nodesWithIds": [
    ],
  • "allNodesOfTypes": [
    ],
  • "namespace": "string",
  • "allowReferences": [
    ]
}

node

Node API

list all node types

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "nodeTypes": [
    ]
}

Node type API

list all nodes of that type

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
nodeType
required
string
query Parameters
namespace
string
ownedBy
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

stackpack

StackPack API

upload a StackPack

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: multipart/form-data
stackPack
string <binary>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "version": "string",
  • "logo": "string",
  • "categories": [
    ],
  • "isNew": true,
  • "overviewUrl": "string",
  • "detailedOverviewUrl": "string",
  • "resourcesUrl": "string",
  • "faqs": [
    ],
  • "configurationUrls": [
    ],
  • "releaseStatus": "AVAILABLE",
  • "isCompatible": true
}

StackPack API

list of stackpack

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Provision API

Provision details

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
stackName
required
string (stackName)
Request Body schema: application/json
property name*
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "name": "string",
  • "stackPackVersion": "string",
  • "lastUpdateTimestamp": 0
}

Provision API

Provision details

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
stackName
required
string
stackId
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

Upgrade API

Upgrade stackpack

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
stackName
required
string
query Parameters
unlocked
required
string

Responses

Response samples

Content type
application/json
"string"

Confirm manual steps

Confirm manual steps of the stackpack

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
stackpackName
required
string
stackpackInstanceId
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

monitor

List monitors

List all available monitor in the system

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "monitors": [
    ]
}

Get a monitor

Returns a monitor full representation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
monitorIdOrUrn
required
string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "identifier": "string",
  • "description": "string",
  • "functionId": 0,
  • "arguments": [
    ],
  • "remediationHint": "string",
  • "intervalSeconds": 0,
  • "tags": [
    ],
  • "status": "ENABLED"
}

Update some monitor properties

Performs a patch on the monitor base properties.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
monitorIdOrUrn
required
string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Request Body schema: application/json

Monitor base properties

name
string
identifier
string (MonitorUrn)
description
string
remediationHint
string
intervalSeconds
integer
tags
Array of strings
status
string (MonitorStatusValue)
Enum: "ENABLED" "DISABLED"

If a monitor status is set to DISABLED it won't produce any health states but it can still be run manually to inspect it's output

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "description": "string",
  • "remediationHint": "string",
  • "intervalSeconds": 0,
  • "tags": [
    ],
  • "status": "ENABLED"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "identifier": "string",
  • "description": "string",
  • "functionId": 0,
  • "arguments": [
    ],
  • "remediationHint": "string",
  • "intervalSeconds": 0,
  • "tags": [
    ],
  • "status": "ENABLED"
}

Delete a monitor

Deletes existing monitor

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
monitorIdOrUrn
required
string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

Content type
application/json
{
  • "monitorIdOrUrn": "string",
  • "_type": "InvalidMonitorIdentifierError"
}

Run a monitor

Performs a run of a monitor. If 'dryRun' is set, topology state will not be modified.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
monitorIdOrUrn
required
string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

query Parameters
dryRun
boolean

If set, the topology state will not be modified

Responses

Response samples

Content type
application/json
{
  • "result": { }
}

Get a monitor with stream information

Returns a monitor full representation with the stream status information

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
monitorIdOrUrn
required
string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

Content type
application/json
{
  • "monitor": {
    },
  • "errors": [
    ],
  • "metrics": {
    },
  • "monitorHealthStateStateCount": 0,
  • "topologyMatchResult": {
    }
}

userProfile

Get current user profile

Get current user profile.

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "description": "string",
  • "identifier": "string",
  • "starredViews": [
    ],
  • "ownedBy": "string"
}

Save current user profile

Save current user profile.

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json
name
required
string
description
string
identifier
string
starredViews
Array of integers <int64>
ownedBy
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "identifier": "string",
  • "starredViews": [
    ],
  • "ownedBy": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "description": "string",
  • "identifier": "string",
  • "starredViews": [
    ],
  • "ownedBy": "string"
}

apiToken

Get current user's API tokens

Get all API token of the logged-in user.

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

event

Get events

Gets you a list of events that exist for topology and time selections.

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json
startTimestampMs
required
integer <instant>
endTimestampMs
required
integer <instant>
topologyQuery
required
string
limit
required
integer
playHeadTimestampMs
integer <instant>
rootCauseMode
string (RootCauseMode)
Enum: "no-cause" "cause-only" "full-cause-tree"
eventTypes
Array of strings
eventTags
Array of strings
eventCategories
Array of strings (EventCategory)
Items Enum: "Changes" "Alerts" "Anomalies" "Activities" "Others"
eventSources
Array of strings
object (EventCursor)

Responses

Request samples

Content type
application/json
{
  • "startTimestampMs": 0,
  • "endTimestampMs": 0,
  • "topologyQuery": "string",
  • "limit": 0,
  • "playHeadTimestampMs": 0,
  • "rootCauseMode": "no-cause",
  • "eventTypes": [
    ],
  • "eventTags": [
    ],
  • "eventCategories": [
    ],
  • "eventSources": [
    ],
  • "cursor": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get single event

Retrieves a specific event by its identifier.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
eventId
required
string (EventId)

The Identifier of an event.

query Parameters
startTimestampMs
required
integer <instant>
endTimestampMs
required
integer <instant>
playHeadTimestampMs
integer <instant>

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "sourceIdentifier": "string",
  • "elementIdentifiers": [
    ],
  • "elements": [
    ],
  • "source": "string",
  • "category": "Changes",
  • "description": "string",
  • "name": "string",
  • "sourceLinks": [
    ],
  • "data": { },
  • "eventType": "string",
  • "eventTime": 0,
  • "processedTime": 0,
  • "tags": [
    ],
  • "causingEvents": [
    ]
}

Get event types

Get a list of event types for a certain STQL query.

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
startTimestampMs
required
integer <instant>
endTimestampMs
required
integer <instant>
topologyQuery
required
string
rootCauseMode
string (RootCauseMode)
Enum: "no-cause" "cause-only" "full-cause-tree"
playHeadTimestampMs
integer <instant>
eventTypes
Array of strings
limit
required
integer
eventCategories
Array of strings (EventCategory)
Items Enum: "Changes" "Alerts" "Anomalies" "Activities" "Others"

The category labels of an event.

eventSources
Array of strings
eventTags
Array of strings
match
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get event sources

Get a list of event sources.

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
startTimestampMs
required
integer <instant>
endTimestampMs
required
integer <instant>
topologyQuery
required
string
rootCauseMode
string (RootCauseMode)
Enum: "no-cause" "cause-only" "full-cause-tree"
playHeadTimestampMs
integer <instant>
eventTypes
Array of strings
limit
required
integer
eventCategories
Array of strings (EventCategory)
Items Enum: "Changes" "Alerts" "Anomalies" "Activities" "Others"

The category labels of an event.

eventSources
Array of strings
eventTags
Array of strings
match
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get event tags

Gets a list of tags that exist in a list of events.

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
startTimestampMs
required
integer <instant>
endTimestampMs
required
integer <instant>
topologyQuery
required
string
rootCauseMode
string (RootCauseMode)
Enum: "no-cause" "cause-only" "full-cause-tree"
playHeadTimestampMs
integer <instant>
eventTypes
Array of strings
limit
required
integer
eventCategories
Array of strings (EventCategory)
Items Enum: "Changes" "Alerts" "Anomalies" "Activities" "Others"

The category labels of an event.

eventSources
Array of strings
eventTags
Array of strings
match
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

healthSynchronization

List health sync streams

Status overview of the health synchronization streams.

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get health sync stream status

Status overview of a single health synchronization stream

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

Responses

Response samples

Content type
application/json
{
  • "partition": 0,
  • "consistencyModel": "string",
  • "recoverMessage": "string",
  • "globalErrors": [
    ],
  • "aggregateMetrics": {
    },
  • "mainStreamStatus": {
    }
}

Clear health sync stream errors

Clear all errors for a stream and its sub-streams.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

Responses

Response samples

Content type
application/json
{
  • "urn": "string",
  • "message": "string"
}

Delete health sync stream

Delete a health synchronization stream. Deletion will not be immediate.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

Responses

Response samples

Content type
application/json
{
  • "urn": "string",
  • "message": "string"
}

List health sync sub-streams

Overview of all sub-streams in a certain health stream.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

Responses

Response samples

Content type
application/json
{
  • "subStreams": [
    ]
}

List health sync stream check-states

Overview of check-states matched to topology on the main stream.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

Responses

Response samples

Content type
application/json
{
  • "matchedCheckStates": 0,
  • "unmatchedCheckStates": [
    ],
  • "multipleMatchesCheckStates": [
    ]
}

Get health sync sub-stream status

Status overview of a single health synchronization sub stream

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

healthSyncSubStreamId
required
string

Health synchronization sub stream id.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "metrics": {
    },
  • "subStreamState": {
    },
  • "checkStateCount": 0
}

List health sync sub-stream check-states

Overview of check-states matched to topology on the main stream.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
healthStreamUrn
required
string

Urn of the health stream.

healthSyncSubStreamId
required
string

Health synchronization sub stream id.

Responses

Response samples

Content type
application/json
{
  • "matchedCheckStates": 0,
  • "unmatchedCheckStates": [
    ],
  • "multipleMatchesCheckStates": [
    ]
}

topologySynchronization

Overview of the topology synchronization streams

Overview of the topology synchronization streams

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "streams": [
    ]
}

Overview of a specific Topology Stream, queried by node id or sync identifier

Overview of a specific Topology Stream, queried by node id or sync identifier

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
identifier
required
string
identifierType
required
string (IdentifierType)
Enum: "NodeId" "Identifier"

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "errorDetails": [
    ]
}

Metrics of a specific Topology Stream, queried by node id

Metrics of a specific Topology Stream, queried by node id

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "bucketSizeSeconds": 0,
  • "latencySeconds": [
    ]
}

Clear all the errors related to a specific sync

Clear all the errors related to a specific sync

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
identifier
required
string
identifierType
required
string (IdentifierType)
Enum: "NodeId" "Identifier"

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

scripting

Execute script

Execute a StackState Scripting Language or Template Language script with arbitrary arguments.

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json
timeoutMs
integer
script
required
string
argumentsScript
string

Responses

Request samples

Content type
application/json
{
  • "timeoutMs": 0,
  • "script": "string",
  • "argumentsScript": "string"
}

Response samples

Content type
application/json
{
  • "result": { }
}

server

Get server info

Get information of the StackState information, such as version, deployment mode, etc.

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "deploymentMode": "Saas"
}

serviceToken

Get service tokens

Get service tokens.

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new service token

Create new service token.

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json
name
required
string
expiryDate
integer <int64>
roles
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expiryDate": 0,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "expiration": 0
}

Delete service token

Delete service token.

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
serviceTokenId
required
integer <int64> (ServiceTokenId)

The identifier of a service token

Responses

Response samples

Content type
application/json
{
  • "_type": "ErrorsResponse",
  • "trackingKey": "string",
  • "serverTimestamp": 0,
  • "errors": [
    ]
}

subscription

Get subscription info

Get the state of the StackState license

Authorizations:
ApiTokenServiceTokenServiceBearer

Responses

Response samples

Content type
application/json
Example
ExpiredSubscription
ExpiredSubscription
UnlicensedSubscription
LicensedSubscription
{
  • "_type": "ExpiredSubscription",
  • "subscription": {
    }
}

Submit a new license to update the subscription

Update the StackState license

Authorizations:
ApiTokenServiceTokenServiceBearer
Request Body schema: application/json

The new license

key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
Example
ExpiredSubscription
ExpiredSubscription
UnlicensedSubscription
LicensedSubscription
{
  • "_type": "ExpiredSubscription",
  • "subscription": {
    }
}

exportAnomaly

Export anomalies with metric history and feedback

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
startTime
required
integer <int64>

Beginning of timerange of to be exported anomalies. Timestamp in unix millis.

endTime
integer <int64>

End of timerange of to be exported anomalies. Timestamp in unix millis.

history
integer <int64>

Amount of historic data, leading up to the anomaly, to be exported. Duration in unix millis.

feedback
required
string
Value: "present"

Type of filtering to do on feedback. Filtering on feedback is currently mandatory, with only the 'present' value being supporeted (feedback is available).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

component

List all streams from the component

List all streams from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create the Stream on the component

Adds a DataStream/TelemetryStreamDefinition on the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

Request Body schema: application/json

Single telemetry stream definition

_type
required
string
EventStream
MetricStream
EventStream
dataSource
required
integer <int64>
dataType
required
string (DataType)
Enum: "METRICS" "TOPOLOGY_ELEMENTS" "EVENTS"
description
string
id
integer <int64>
lastUpdateTimestamp
integer <int64>
name
required
string
priority
string (StreamPriority)
Enum: "HIGH" "MEDIUM" "LOW"
required
object (EventTelemetryQuery)
syncCreated
required
boolean

Responses

Request samples

Content type
application/json
Example
EventStream
EventStream
MetricStream
{
  • "_type": "EventStream",
  • "dataSource": 0,
  • "dataType": "METRICS",
  • "description": "string",
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "priority": "HIGH",
  • "query": {
    },
  • "syncCreated": true
}

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Get the stream from the component

Get a Specific stream from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Update the stream on the component

Update a Specific stream from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

Request Body schema: application/json

Single telemetry stream definition

_type
required
string
EventStream
MetricStream
EventStream
dataSource
required
integer <int64>
dataType
required
string (DataType)
Enum: "METRICS" "TOPOLOGY_ELEMENTS" "EVENTS"
description
string
id
integer <int64>
lastUpdateTimestamp
integer <int64>
name
required
string
priority
string (StreamPriority)
Enum: "HIGH" "MEDIUM" "LOW"
required
object (EventTelemetryQuery)
syncCreated
required
boolean

Responses

Request samples

Content type
application/json
Example
EventStream
EventStream
MetricStream
{
  • "_type": "EventStream",
  • "dataSource": 0,
  • "dataType": "METRICS",
  • "description": "string",
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "priority": "HIGH",
  • "query": {
    },
  • "syncCreated": true
}

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Delete the stream from the component

Delete a Specific stream from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

Responses

Response samples

Content type
application/json
No sample

Get the latests metrics

Gets a top 3 metrics for a datapoint, always takes the last 15 minutes before provided timepoint

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

streamIds
required
Array of integers <int64> (StreamIds)

Ids of streams to query for

Responses

Response samples

Content type
application/json
No sample

List all checks from the component

List all checks from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create the Checks on the component

Adds a Check on the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

Request Body schema: application/json

Single Check

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Get the check from the component

Get a Specific check from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
No sample

Update the check on the component

Update a Specific check from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

Request Body schema: application/json

Single Check

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Delete the check from the component

Delete a Specific check from the component

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
componentId
required
integer <int64> (ComponentId)

The Identifier of a component

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

Responses

Response samples

Content type
application/json
No sample

relation

List all streams from the relation

List all streams from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create the Stream on the relation

Adds a DataStream/TelemetryStreamDefinition on the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

Request Body schema: application/json

Single telemetry stream definition

_type
required
string
EventStream
MetricStream
EventStream
dataSource
required
integer <int64>
dataType
required
string (DataType)
Enum: "METRICS" "TOPOLOGY_ELEMENTS" "EVENTS"
description
string
id
integer <int64>
lastUpdateTimestamp
integer <int64>
name
required
string
priority
string (StreamPriority)
Enum: "HIGH" "MEDIUM" "LOW"
required
object (EventTelemetryQuery)
syncCreated
required
boolean

Responses

Request samples

Content type
application/json
Example
EventStream
EventStream
MetricStream
{
  • "_type": "EventStream",
  • "dataSource": 0,
  • "dataType": "METRICS",
  • "description": "string",
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "priority": "HIGH",
  • "query": {
    },
  • "syncCreated": true
}

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Get the stream from the relation

Get a Specific stream from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Update the stream on the relation

Update a Specific stream from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

Request Body schema: application/json

Single telemetry stream definition

_type
required
string
EventStream
MetricStream
EventStream
dataSource
required
integer <int64>
dataType
required
string (DataType)
Enum: "METRICS" "TOPOLOGY_ELEMENTS" "EVENTS"
description
string
id
integer <int64>
lastUpdateTimestamp
integer <int64>
name
required
string
priority
string (StreamPriority)
Enum: "HIGH" "MEDIUM" "LOW"
required
object (EventTelemetryQuery)
syncCreated
required
boolean

Responses

Request samples

Content type
application/json
Example
EventStream
EventStream
MetricStream
{
  • "_type": "EventStream",
  • "dataSource": 0,
  • "dataType": "METRICS",
  • "description": "string",
  • "id": 0,
  • "lastUpdateTimestamp": 0,
  • "name": "string",
  • "priority": "HIGH",
  • "query": {
    },
  • "syncCreated": true
}

Response samples

Content type
application/json
Example
MetricTelemetryStreamDefinition
MetricTelemetryStreamDefinition
EventTelemetryStreamDefinition
{
  • "_type": "MetricTelemetryStreamDefinition",
  • "bindQuery": "string",
  • "dataSourceId": 0,
  • "description": "string",
  • "id": 0,
  • "identifier": "string",
  • "labels": [
    ],
  • "lastUpdateTimestamp": 0,
  • "metricValuation": "higher-is-better",
  • "name": "string",
  • "ownedBy": "string",
  • "priority": "None",
  • "telemetryQuery": {
    },
  • "topologyMapping": [
    ]
}

Delete the stream from the relation

Delete a Specific stream from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

streamId
required
integer <int64> (StreamId)

The Identifier of a stream

Responses

Response samples

Content type
application/json
No sample

List all checks from the relation

List all checks from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create the Checks on the relation

Adds a Check on the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

Request Body schema: application/json

Single Check

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Get the check from the relation

Get a Specific check from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

query Parameters
queryTime
required
integer <instant> (QueryTime)

A Data point for a query either point from timeline or 'now' if livemode

Responses

Response samples

Content type
application/json
No sample

Update the check on the relation

Update a Specific check from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

Request Body schema: application/json

Single Check

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

Delete the check from the relation

Delete a Specific check from the relation

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
relationId
required
integer <int64> (RelationId)

The Identifier of a relation

checkId
required
integer <int64> (CheckId)

The Identifier of a Check

Responses

Response samples

Content type
application/json
No sample

problem

List possible events which led to the problem

Resulting events are ordered by likeness to be an actual problem cause

Authorizations:
ApiTokenServiceTokenServiceBearer
path Parameters
problemId
required
integer <int64> (ProblemId)

The problem id number.

query Parameters
topologyTime
integer <instant> (Instant)

A timestamp at which resources will be queried. If not given the resources are quired for current time.

limit
integer <int32> (Limit) >= 1

Maximum number of resources to be returned in result.

Responses

Response samples

Content type
application/json
Example
CausingEventsResult
CausingEventsResult
TooManyTopologyResults
CausingEventsAreNotAvailableForTheTime
{
  • "_type": "CausingEventsResult",
  • "items": [
    ]
}

metric

Instant query at a single point in time

The endpoint evaluates an instant query at a single point in time

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
query
required
string (PromQuery)

Prometheus expression query string

time
string (PromTime) (^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(...
Example: time=2015-07-01T20:10:51.781Z or 1660817432

Evaluation timestamp in rfc3339 format or unix format

timeout
string (PromTimeout) ^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]...

Evaluation timeout

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    },
  • "errorType": "string",
  • "error": "string",
  • "warnings": [
    ]
}

Query over a range of time

The endpoint evaluates an expression query over a range of time

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
query
required
string (PromQuery)

Prometheus expression query string

start
required
string (PromTime) (^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(...
Example: start=2015-07-01T20:10:51.781Z or 1660817432

Start timestamp in rfc3339 format or unix format

end
required
string (PromTime) (^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(...
Example: end=2015-07-01T20:10:51.781Z or 1660817432

End timestamp in rfc3339 format or unix format

step
required
string (PromStep) (^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9...
Example: step=5m or 300

Query resolution step width in duration format or float number of seconds.

timeout
string (PromTimeout) ^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]...

Evaluation timeout

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    },
  • "errorType": "string",
  • "error": "string",
  • "warnings": [
    ]
}

Experimental: Exemplars for a specific time range

Experimental: The returns a list of exemplars for a valid PromQL query for a specific time range

Authorizations:
ApiTokenServiceTokenServiceBearer
query Parameters
query
required
string (PromQuery)

Prometheus expression query string

start
required
string (PromTime) (^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(...
Example: start=2015-07-01T20:10:51.781Z or 1660817432

Start timestamp in rfc3339 format or unix format

end
required
string (PromTime) (^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(...
Example: end=2015-07-01T20:10:51.781Z or 1660817432

End timestamp in rfc3339 format or unix format

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": [
    ],
  • "errorType": "string",
  • "error": "string",
  • "warnings": [
    ]
}