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

Alert

Operations

Agent

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

Operations

List nodes

Request

List both appliances and agents.

Requires nodes::read permission.

Query
tagsstring

Comma-separated key:value pairs for tag filtering, e.g., location:Austin,device:Trustgrid.

projection[]Array of strings

List of fields to return from the API. Supports nested fields and anything in the Node schema. Each field should be listed individually, e.g., projection[]=online&projection[]=uid.

If using curl, the -g flag will automatically escape the brackets for you.

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/node?projection%5B%5D=string&tags=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
clusterstring

Cluster FQDN

Example: "mycluster.trustgrid.io"
configobject

Node config

namestring

Node name

Example: "mynode"
onlineboolean

True when the node is connected to the control plane

shadowobject

Node shadow

statestring

Node state

Enum"ACTIVE""INACTIVE"
tagsobject

Node tags

typestring

Device type

Enum"Agent""Appliance"
uidstring

Node ID

Example: "19084f81-5668-41ee-adbe-295e4c65531a"
]
Response
application/json
[
  {
    "cluster": "mycluster.trustgrid.io",
    "config": {},
    "name": "mynode",
    "online": true,
    "shadow": {},
    "state": "ACTIVE",
    "tags": {},
    "type": "Agent",
    "uid": "19084f81-5668-41ee-adbe-295e4c65531a"
  }
]

Delete a node

Request

Delete a node (appliance or agent)

Requires nodes::delete permission.

Path
nodeIDstringrequired

Node ID

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

Responses

OK

Get a node

Request

Get a node (appliance or agent)

Requires nodes::read permission.

Path
nodeIDstringrequired

Node ID

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

Responses

OK

Bodyapplication/json
clusterstring

Cluster FQDN

Example: "mycluster.trustgrid.io"
configobject

Node config

namestring

Node name

Example: "mynode"
onlineboolean

True when the node is connected to the control plane

shadowobject

Node shadow

statestring

Node state

Enum"ACTIVE""INACTIVE"
tagsobject

Node tags

typestring

Device type

Enum"Agent""Appliance"
uidstring

Node ID

Example: "19084f81-5668-41ee-adbe-295e4c65531a"
Response
application/json
{
  "cluster": "mycluster.trustgrid.io",
  "config": {},
  "name": "mynode",
  "online": true,
  "shadow": {},
  "state": "ACTIVE",
  "tags": {},
  "type": "Agent",
  "uid": "19084f81-5668-41ee-adbe-295e4c65531a"
}

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