Trustgrid Management API (1.0.0)

Download OpenAPI description
index.json
index.yaml
Overview
License unlicensed
Languages
Servers
Mock server
https://apidocs.trustgrid.io/_mock/
https://api.trustgrid.io/

Alarm

Alarm filters manage criteria and thresholds for what events generate alerts.

Operations

Get alarms

Request

Requires alarms::read permission.

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/v2/alarm \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
channelsArray of strings

Channel IDs to broadcast alerts to

descriptionstring
freetextstring

text to match

namestringrequired
nodesArray of strings

Node names to match

operatorstring

Logical operator for criteria matching

Enum"any""all""none"
tagsArray of strings

Tags expressed as key=value to match

tagsOperatorstring

How tag criteria should match

Enum"any""all"
thresholdstring

Event threshold to match

Enum"INFO""WARNING""ERROR""CRITICAL"
exprstring

CEL expression to match

typesArray of strings

Event types to match

uidstring
]
Response
application/json
[
  {
    "channels": [ … ],
    "description": "string",
    "freetext": "string",
    "name": "string",
    "nodes": [ … ],
    "operator": "any",
    "tags": [ … ],
    "tagsOperator": "any",
    "threshold": "INFO",
    "expr": "string",
    "types": [ … ],
    "uid": "string"
  }
]

Create an alarm

Request

Requires alarms::modify permission.

Bodyapplication/jsonrequired

Alarm body

channelsArray of strings

Channel IDs to broadcast alerts to

descriptionstring
freetextstring

text to match

namestringrequired
nodesArray of strings

Node names to match

operatorstring

Logical operator for criteria matching

Enum"any""all""none"
tagsArray of strings

Tags expressed as key=value to match

tagsOperatorstring

How tag criteria should match

Enum"any""all"
thresholdstring

Event threshold to match

Enum"INFO""WARNING""ERROR""CRITICAL"
exprstring

CEL expression to match

typesArray of strings

Event types to match

uidstring
curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/v2/alarm \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "channels": [
      "string"
    ],
    "description": "string",
    "freetext": "string",
    "name": "string",
    "nodes": [
      "string"
    ],
    "operator": "any",
    "tags": [
      "string"
    ],
    "tagsOperator": "any",
    "threshold": "INFO",
    "expr": "string",
    "types": [
      "string"
    ],
    "uid": "string"
  }'

Responses

OK

Response
No content

Returns available alarm channels

Request

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/v2/alarm-channel \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
emailsstring
genericWebhookstring
msTeamsstring
namestringrequired
opsGeniestring
pagerdutystring
slackChannelstring
slackWebhookstring
uidstring
]
Response
application/json
[
  {
    "emails": "string",
    "genericWebhook": "string",
    "msTeams": "string",
    "name": "string",
    "opsGenie": "string",
    "pagerduty": "string",
    "slackChannel": "string",
    "slackWebhook": "string",
    "uid": "string"
  }
]

Alert

Operations

Agent

Agents run on consumer devices and have a subset of appliance functionality

Operations

Appliance

Appliances are Trustgrid nodes deployed either physically or as a virtual machine.

Operations

Certificate

Operations

Cluster

Operations

Domain

A domain provides a logical grouping of nodes inside an organization.

Operations

Tag

Tags allow grouping clusters and nodes for permissions and reporting.

Operations

Upgrade Manager

Operations

Virtual Network

Operations

Compute

Operations

KVM

Virtual machines

Operations

Repository

Container repository

Operations

Audit

Operations

Group

Groups allow exposing ZTNA applications to users.

Operations

IDP

Operations

Org

Operations

Order

Provision process management

Operations

Permissions

Operations

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations