StackState API (0.0.1)

Download OpenAPI specification:Download

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:
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:
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

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

node

Node API

list all node types

Authorizations:

Responses

Response samples

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

Node type API

list all nodes of that type

Authorizations:
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:
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:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Provision API

Provision details

Authorizations:
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:
path Parameters
stackName
required
string
stackId
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

Upgrade API

Upgrade stackpack

Authorizations:
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:
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:

Responses

Response samples

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

Get a monitor

Returns a monitor full representation

Authorizations:
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
}

Delete a monitor

Deletes existing monitor

Authorizations:
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": "InvalidMonitorIdentifier"
}

Run a monitor

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

Authorizations:
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:
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": {