Trustgrid Management API (1.0.0)

Download OpenAPI description

Overview

License

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

Alert

Operations

List events for a node

Request

List events for a node (appliance or agent), newest first

Requires alerts::read permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/alert/{nodeID}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [

alert_messagestring

More information about the alert

Example: "Node mynode abnormally disconnected"

nodestring

Node name that generated the alert

Example: "mynode"

node_idstring

Node ID that generated the alert

Example: "19084f81-5668-41ee-adbe-295e4c65531a"

timestampnumber

Unix timestamp of alert

Example: 1661440360

typestring

Type of alert

Example: "Data Plane Disruption"

uidstring

Unique ID of alert

Example: "2DqxLdknjWxEkGt474d2Cstsa1O"

]

Response

application/json

[
  {
    "alert_message": "Node mynode abnormally disconnected",
    "node": "mynode",
    "node_id": "19084f81-5668-41ee-adbe-295e4c65531a",
    "timestamp": 1661440360,
    "type": "Data Plane Disruption",
    "uid": "2DqxLdknjWxEkGt474d2Cstsa1O"
  }
]

List alerts, newest first

Request

Requires alerts::read permission.

Security

JWTAuthorizer

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

Responses

OK

Bodyapplication/jsonArray [

eventTypestring

Type of alert

Example: "Data Plane Disruption"

messagestring

More information about the alert

Example: "Node mynode abnormally disconnected"

nodeIdstring

Node ID that generated the alert

Example: "19084f81-5668-41ee-adbe-295e4c65531a"

nodeNamestring

Node name that generated the alert

Example: "mynode"

timestampnumber

Unix timestamp of alert

Example: 1661440360

uidstring

Unique ID of alert

Example: "2DqxLdknjWxEkGt474d2Cstsa1O"

]

Response

application/json

[
  {
    "eventType": "Data Plane Disruption",
    "message": "Node mynode abnormally disconnected",
    "nodeId": "19084f81-5668-41ee-adbe-295e4c65531a",
    "nodeName": "mynode",
    "timestamp": 1661440360,
    "uid": "2DqxLdknjWxEkGt474d2Cstsa1O"
  }
]

List alerts for a node (appliance or agent), newest first

Request

Requires alerts::read permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/alert/{nodeID}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [

eventTypestring

Type of alert

Example: "Data Plane Disruption"

messagestring

More information about the alert

Example: "Node mynode abnormally disconnected"

nodeIdstring

Node ID that generated the alert

Example: "19084f81-5668-41ee-adbe-295e4c65531a"

nodeNamestring

Node name that generated the alert

Example: "mynode"

timestampnumber

Unix timestamp of alert

Example: 1661440360

uidstring

Unique ID of alert

Example: "2DqxLdknjWxEkGt474d2Cstsa1O"

]

Response

application/json

[
  {
    "eventType": "Data Plane Disruption",
    "message": "Node mynode abnormally disconnected",
    "nodeId": "19084f81-5668-41ee-adbe-295e4c65531a",
    "nodeName": "mynode",
    "timestamp": 1661440360,
    "uid": "2DqxLdknjWxEkGt474d2Cstsa1O"
  }
]

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

TLS certificates

Operations

Cluster

Clusters allow shared config and HA

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

Nodes can be upgraded in bulk using the upgrade manager.

Operations

Virtual Network

Virtual network configuration

Operations

Compute

Edge compute configuration

Operations

KVM

Virtual machines

Operations

Repository

Container repository

Operations

Audit

Audits are logged to keep track of user and system changes. Trustgrid exposes authentication audits, configuration changes, and flow logs

Operations

Group

Groups allow exposing ZTNA applications to users.

Operations

IDP

Identity provider configuration

Operations

Org

Org-related APIs expose support requests, support settings, and shared documents.

Operations

Order

Provision process management

Operations

Permissions

Permissions management

Operations

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations