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

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

import

Import settings

Import StackState Templated JSON (STJ) setting nodes.

Authorizations:

ApiTokenServiceToken

query Parameters

timeoutSeconds	integer <int64>
namespace	string
unlocked	string Enum: "fail" "skip" "overwrite"

Request Body schema: plain/text

string

Responses

Response samples

200
400
500

Content type

application/json

[{ }
]

export

Export settings

Export StackState Templated JSON (STJ) setting nodes.

Authorizations:

ApiTokenServiceToken

Request Body schema: application/json

nodesWithIds	Array of integers <int64> [ items <int64 > ]
allNodesOfTypes	Array of strings
namespace	string
allowReferences	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"nodesWithIds": [0
],
"allNodesOfTypes": ["string"
],
"namespace": "string",
"allowReferences": ["string"
]
}

node

Node API

list all node types

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
500

Content type

application/json

{"nodeTypes": [{"typeName": "string",
"description": "string"
}
]
}

Node type API

list all nodes of that type

Authorizations:

ApiTokenServiceToken

path Parameters

nodeType

required

string

query Parameters

namespace	string
ownedBy	string

Responses

Response samples

200
500

Content type

application/json

[{"typeName": "string",
"id": 0,
"lastUpdateTimestamp": 0,
"identifier": "string",
"name": "string",
"description": "string",
"ownedBy": "string",
"manual": true,
"isSettingsNode": true
}
]

stackpack

StackPack API

upload a StackPack

Authorizations:

ApiTokenServiceToken

Request Body schema: multipart/form-data

stackPack

string <binary>

Responses

Response samples

202
400
500

Content type

application/json

{"name": "string",
"displayName": "string",
"version": "string",
"logo": "string",
"categories": ["string"
],
"isNew": true,
"overviewUrl": "string",
"detailedOverviewUrl": "string",
"resourcesUrl": "string",
"faqs": [{"question": "string",
"answer": "string"
}
],
"configurationUrls": [["string"
]
],
"releaseStatus": "AVAILABLE",
"isCompatible": true
}

StackPack API

list of stackpack

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
400
500

Content type

application/json

[{"name": "string",
"displayName": "string",
"version": "string",
"configurations": [{"id": 0,
"status": "string",
"lastUpdateTimestamp": 0,
"stackPackVersion": "string"
}
],
"latestVersion": {"version": "string"
},
"nextVersion": {"version": "string"
},
"steps": [{"display": "string",
"name": "string",
"value": {"_type": "string"
}
}
]
}
]

Provision API

Provision details

Authorizations:

ApiTokenServiceToken

path Parameters

stackName

required

string (stackName)

Request Body schema: application/json

property name*

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Response samples

200
500

Content type

application/json

{"id": 0,
"status": "string",
"name": "string",
"stackPackVersion": "string",
"lastUpdateTimestamp": 0
}

Provision API

Provision details

Authorizations:

ApiTokenServiceToken

path Parameters

stackName required	string
stackId required	integer <int64>

Responses

Response samples

200
400
500

Content type

application/json

"string"

Upgrade API

Upgrade stackpack

Authorizations:

ApiTokenServiceToken

path Parameters

stackName

required

string

query Parameters

unlocked

required

string

Responses

Response samples

200
500

Content type

application/json

"string"

Confirm manual steps

Confirm manual steps of the stackpack

Authorizations:

ApiTokenServiceToken

path Parameters

stackpackName required	string
stackpackInstanceId required	integer <int64>

Responses

Response samples

200
500

Content type

application/json

"string"

monitor

List monitors

List all available monitor in the system

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
500

Content type

application/json

{"monitors": [{"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"functionId": 0,
"arguments": [{ }
],
"remediationHint": "string",
"intervalSeconds": 0
}
]
}

Get a monitor

Returns a monitor full representation

Authorizations:

ApiTokenServiceToken

path Parameters

monitorIdOrUrn

required

string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"functionId": 0,
"arguments": [{ }
],
"remediationHint": "string",
"intervalSeconds": 0
}

Delete a monitor

Deletes existing monitor

Authorizations:

ApiTokenServiceToken

path Parameters

monitorIdOrUrn

required

string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

400
404
500

Content type

application/json

{"monitorIdOrUrn": "string",
"_type": "InvalidMonitorIdentifier"
}

Run a monitor

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

Authorizations:

ApiTokenServiceToken

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

200
400
404
500

Content type

application/json

{"result": { }
}

Get a monitor with stream information

Returns a monitor full representation with the stream status information

Authorizations:

ApiTokenServiceToken

path Parameters

monitorIdOrUrn

required

string (MonitorIdOrUrn) ^urn:.+|[0-9]+$

The id or identifier (urn) of a monitor

Responses

Response samples

200
400
404
500

Content type

application/json

{"monitor": {"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"functionId": 0,
"arguments": [{ }
],
"remediationHint": "string",
"intervalSeconds": 0
},
"errors": [{"error": "string",
"count": 0
}
],
"metrics": {"healthSyncServiceMetrics": {"bucketSizeSeconds": 0,
"latencySeconds": [{"value": 0
}
],
"messagePerSecond": [{"value": 0
}
],
"createsPerSecond": [{"value": 0
}
],
"updatesPerSecond": [{"value": 0
}
],
"deletesPerSecond": [{"value": 0
}
]
}
},
"monitorHealthStateStateCount": 0,
"topologyMatchResult": {"matchedCheckStates": 0,
"unmatchedCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string"
}
],
"multipleMatchesCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string",
"matchCount": 0
}
]
}
}

userProfile

Get current user profile

Get current user profile.

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
400
500

Content type

application/json

{"id": 0,
"lastUpdateTimestamp": 0,
"name": "string",
"description": "string",
"identifier": "string",
"starredViews": [0
],
"ownedBy": "string"
}

Save current user profile

Save current user profile.

Authorizations:

ApiTokenServiceToken

Request Body schema: application/json

name required	string
description	string
identifier	string
starredViews	Array of integers <int64> [ items <int64 > ]
ownedBy	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"identifier": "string",
"starredViews": [0
],
"ownedBy": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": 0,
"lastUpdateTimestamp": 0,
"name": "string",
"description": "string",
"identifier": "string",
"starredViews": [0
],
"ownedBy": "string"
}

apiToken

Get current user's API tokens

Get all API token of the logged-in user.

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 0,
"lastUpdateTimestamp": 0,
"name": "string",
"description": "string",
"token": "string"
}
]

event

Get events

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

Authorizations:

ApiTokenServiceToken

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

Payload

Content type

application/json

{"startTimestampMs": 0,
"endTimestampMs": 0,
"topologyQuery": "string",
"limit": 0,
"playHeadTimestampMs": 0,
"rootCauseMode": "no-cause",
"eventTypes": ["string"
],
"eventTags": ["string"
],
"eventCategories": ["Changes"
],
"eventSources": ["string"
],
"cursor": {"lastEventTimestampMs": 0,
"lastEventId": "string"
}
}

Response samples

200
400
500

Content type

application/json

{"items": [{"identifier": "string",
"sourceIdentifier": "string",
"elementIdentifiers": ["string"
],
"elements": [{"_type": "EventComponent",
"id": 0,
"componentTypeId": 0,
"name": "string"
}
],
"source": "string",
"category": "Changes",
"description": "string",
"name": "string",
"sourceLinks": [{"title": "string",
"url": "string"
}
],
"data": { },
"eventType": "string",
"eventTime": 0,
"processedTime": 0,
"tags": [{"key": "string",
"value": "string"
}
],
"causingEvents": [{"title": "string",
"eventId": "string",
"eventTimestamp": 0,
"eventType": "string"
}
]
}
],
"total": 0
}

Get single event

Retrieves a specific event by its identifier.

Authorizations:

ApiTokenServiceToken

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

200
400
404
500

Content type

application/json

{"identifier": "string",
"sourceIdentifier": "string",
"elementIdentifiers": ["string"
],
"elements": [{"_type": "EventComponent",
"id": 0,
"componentTypeId": 0,
"name": "string"
}
],
"source": "string",
"category": "Changes",
"description": "string",
"name": "string",
"sourceLinks": [{"title": "string",
"url": "string"
}
],
"data": { },
"eventType": "string",
"eventTime": 0,
"processedTime": 0,
"tags": [{"key": "string",
"value": "string"
}
],
"causingEvents": [{"title": "string",
"eventId": "string",
"eventTimestamp": 0,
"eventType": "string"
}
]
}

Get event types

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

Authorizations:

ApiTokenServiceToken

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

200
400
500

Content type

application/json

{"items": ["string"
],
"total": 0
}

Get event sources

Get a list of event sources.

Authorizations:

ApiTokenServiceToken

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

200
400
500

Content type

application/json

{"items": ["string"
],
"total": 0
}

Get event tags

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

Authorizations:

ApiTokenServiceToken

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

200
400
500

Content type

application/json

{"items": ["string"
],
"total": 0
}

healthSynchronization

List health sync streams

Status overview of the health synchronization streams.

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200

Content type

application/json

{"items": [{"urn": "string",
"consistencyModel": "string",
"subStreams": 0
}
]
}

Get health sync stream status

Status overview of a single health synchronization stream

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn

required

string

Urn of the health stream.

Responses

Response samples

200
400
404

Content type

application/json

{"partition": 0,
"consistencyModel": "string",
"recoverMessage": "string",
"globalErrors": [{"errorCode": "string",
"level": "string",
"error": "string",
"count": 0
}
],
"aggregateMetrics": {"bucketSizeSeconds": 0,
"latencySeconds": [{"value": 0
}
],
"messagePerSecond": [{"value": 0
}
],
"createsPerSecond": [{"value": 0
}
],
"updatesPerSecond": [{"value": 0
}
],
"deletesPerSecond": [{"value": 0
}
]
},
"mainStreamStatus": {"errors": [{"errorCode": "string",
"level": "string",
"error": "string",
"count": 0
}
],
"metrics": {"bucketSizeSeconds": 0,
"latencySeconds": [{"value": 0
}
],
"messagePerSecond": [{"value": 0
}
],
"createsPerSecond": [{"value": 0
}
],
"updatesPerSecond": [{"value": 0
}
],
"deletesPerSecond": [{"value": 0
}
]
},
"subStreamState": {"_type": "HealthSubStreamSnapshot",
"expiryIntervalMs": 0,
"repeatIntervalMs": 0
},
"checkStateCount": 0
}
}

Clear health sync stream errors

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

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn

required

string

Urn of the health stream.

Responses

Response samples

400
404

Content type

application/json

{"urn": "string",
"message": "string"
}

Delete health sync stream

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

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn

required

string

Urn of the health stream.

Responses

Response samples

400
404

Content type

application/json

{"urn": "string",
"message": "string"
}

List health sync sub-streams

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

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn

required

string

Urn of the health stream.

Responses

Response samples

200
400
404

Content type

application/json

{"subStreams": [{"subStreamId": "string",
"subStreamState": {"_type": "HealthSubStreamSnapshot",
"expiryIntervalMs": 0,
"repeatIntervalMs": 0
},
"checkStateCount": 0
}
]
}

List health sync stream check-states

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

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn

required

string

Urn of the health stream.

Responses

Response samples

200
400
404

Content type

application/json

{"matchedCheckStates": 0,
"unmatchedCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string"
}
],
"multipleMatchesCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string",
"matchCount": 0
}
]
}

Get health sync sub-stream status

Status overview of a single health synchronization sub stream

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn required	string Urn of the health stream.
healthSyncSubStreamId required	string Health synchronization sub stream id.

Responses

Response samples

200
400
404

Content type

application/json

{"errors": [{"errorCode": "string",
"level": "string",
"error": "string",
"count": 0
}
],
"metrics": {"bucketSizeSeconds": 0,
"latencySeconds": [{"value": 0
}
],
"messagePerSecond": [{"value": 0
}
],
"createsPerSecond": [{"value": 0
}
],
"updatesPerSecond": [{"value": 0
}
],
"deletesPerSecond": [{"value": 0
}
]
},
"subStreamState": {"_type": "HealthSubStreamSnapshot",
"expiryIntervalMs": 0,
"repeatIntervalMs": 0
},
"checkStateCount": 0
}

List health sync sub-stream check-states

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

Authorizations:

ApiTokenServiceToken

path Parameters

healthStreamUrn required	string Urn of the health stream.
healthSyncSubStreamId required	string Health synchronization sub stream id.

Responses

Response samples

200
400
404

Content type

application/json

{"matchedCheckStates": 0,
"unmatchedCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string"
}
],
"multipleMatchesCheckStates": [{"checkStateId": "string",
"topologyElementIdentifier": "string",
"matchCount": 0
}
]
}

topologySynchronization

Overview of the topology synchronization streams

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200

Content type

application/json

{"streams": [{"syncIdentifier": "string",
"nodeId": 0,
"name": "string",
"createdRelations": 0,
"deletedRelations": 0,
"createdComponents": 0,
"deletedComponents": 0,
"errors": 0,
"status": "Running"
}
]
}

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

Authorizations:

ApiTokenServiceToken

query Parameters

identifier required	string
identifierType required	string (IdentifierType) Enum: "NodeId" "Identifier"

Responses

Response samples

200
400
404

Content type

application/json

{"item": {"syncIdentifier": "string",
"nodeId": 0,
"name": "string",
"createdRelations": 0,
"deletedRelations": 0,
"createdComponents": 0,
"deletedComponents": 0,
"errors": 0,
"status": "Running"
},
"errorDetails": [{"level": "Warn",
"message": "string",
"externalId": "string"
}
]
}

Metrics of a specific Topology Stream, queried by node id

Authorizations:

ApiTokenServiceToken

query Parameters

identifier

required

string

Responses

Response samples

200
400
404

Content type

application/json

{"bucketSizeSeconds": 0,
"latencySeconds": [{"value": 0
}
]
}

Clear all the errors related to a specific sync

Authorizations:

ApiTokenServiceToken

query Parameters

identifier required	string
identifierType required	string (IdentifierType) Enum: "NodeId" "Identifier"

Responses

Response samples

400
404

Content type

application/json

{"message": "string"
}

scripting

Execute script

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

Authorizations:

ApiTokenServiceToken

Request Body schema: application/json

timeoutMs	integer
script required	string
argumentsScript	string

Responses

Request samples

Payload

Content type

application/json

{"timeoutMs": 0,
"script": "string",
"argumentsScript": "string"
}

Response samples

200
400
408
500

Content type

application/json

{"result": { }
}

server

Get server info

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

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
500

Content type

application/json

{"version": {"major": 0,
"minor": 0,
"patch": 0,
"diff": "string",
"commit": "string",
"isDev": true
},
"deploymentMode": "Saas"
}

serviceToken

Get service tokens

Get service tokens.

Authorizations:

ApiTokenServiceToken

Responses

Response samples

200
500

Content type

application/json

[{"id": 0,
"lastUpdateTimestamp": 0,
"name": "string",
"description": "string",
"expiration": 0,
"roles": ["string"
]
}
]

Create new service token

Create new service token.

Authorizations:

ApiTokenServiceToken

Request Body schema: application/json

name required	string
expiryDate	integer <int64>
roles required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"expiryDate": 0,
"roles": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"name": "string",
"token": "string",
"expiration": 0
}

Delete service token

Delete service token.

Authorizations:

ApiTokenServiceToken

path Parameters

serviceTokenId

required

integer <int64> (ServiceTokenId)

The identifier of a service token

Responses

Response samples

500

Content type

application/json

{"_type": "ErrorsResponse",
"trackingKey": "string",
"serverTimestamp": 0,
"errors": [{"_type": "InternalError",
"message": "string",
"errorCode": 0
}
]
}

exportAnomaly

Export anomalies with metric history and feedback

Authorizations:

ApiTokenServiceToken

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

200
413
500

Content type

application/json

[{"anomaly": {"id": "string",
"name": "string",
"reference": {"_type": "MetricStreamReference",
"streamNodeId": 0,
"elementIdentifiers": ["string"
]
},
"identifiers": ["string"
],
"description": "string",
"annotationType": "MetricStreamAnomaly",
"eventTimeInterval": {"start": 0,
"end": 0
},
"processedTime": 0,
"createdTime": 0,
"tags": ["string"
],
"data": {"_type": "MetricStreamAnomalyData",
"severity": "LOW",
"severityScore": 0,
"checkedInterval": {"start": 0,
"end": 0
},
"explanation": "string",
"modelInfo": { },
"elementName": "string",
"streamName": "string",
"query": {"dataSourceId": 0,
"conditions": [{"key": "string",
"value": "string"
}
],
"aggregationMethod": "MEAN",
"bucketSize": 0,
"metricField": "string",
"queryHash": "string"
}
}
},
"data": [{"ts": 0,
"v": 0
}
],
"feedback": {"_type": "FeedbackData",
"subject": "string",
"thumbsup": ["string"
],
"thumbsdown": ["string"
],
"comments": [{"author": "string",
"text": "string",
"timestamp": 0
}
],
"query": {"dataSourceId": 0,
"conditions": [{"key": "string",
"value": "string"
}
],
"aggregationMethod": "MEAN",
"bucketSize": 0,
"metricField": "string",
"queryHash": "string"
}
}
}
]

Get the latests metrics

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

Authorizations:

ApiTokenServiceToken

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) [ items <int64 > ] Ids of streams to query for

Responses

Response samples

200
404
500

Content type

application/json

No sample