Skip to content

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

Retrieve all network nodes including appliances and agents with filtering options

Request

List both appliances and agents.

Requires nodes::read permission.

Security
JWTAuthorizer
Query
clusterstring

When provided, limit the nodes to members of the cluster. Should be the full cluster FQDN, e.g., mycluster.trustgrid.io.

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?cluster=string&tags=string&projection%5B%5D=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"
  }
]

Permanently remove a node from the organization and revoke access

Request

Delete a node (appliance or agent)

Requires nodes::delete permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

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

Responses

OK

Retrieve detailed configuration and status information for a specific node

Request

Get a node (appliance or agent)

Requires nodes::read permission.

Security
JWTAuthorizer
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

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

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