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

Appliance

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

Operations

Execute a remote operation or command on a specific node

Request

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

eventstringrequired
Query
waitstring

If present, the request will return the node's event output

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/{event}?wait=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Retrieve real-time network usage statistics and bandwidth metrics for nodes

Request

Returns an array of usage data buckets for specified nodes within the specified time range and interval.

Security
JWTAuthorizer
Query
relative_startstring

The relative start time for the data (e.g., "-7 days").

relative_endstring

The relative end time for the data (e.g., "now").

intervalInMinutesstring

The size of the time buckets in minutes.

startinteger(int64)

The start time for the data in Unix timestamp format (if not using relative_start).

endinteger(int64)

The end time for the data in Unix timestamp format (if not using relative_end).

filtersstring

The filters to apply when querying for nodes, like tags.

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/stats/realtime/usage?relative_start=string&relative_end=string&intervalInMinutes=string&start=0&end=0&filters=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

An array of usage data buckets.

Body*/*Array [
bytesinteger(int64)

The number of bytes in the bucket.

countinteger(int64)

The number of flows in the bucket.

tinteger(int64)

The time of the bucket in Unix timestamp format.

]

Delete a file or directory

Request

Requires nodes::service:datastore-manager permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

Bodyapplication/json

rm

filenamestringrequired

filename

curl -i -X DELETE \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/data-store' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filename": "string"
  }'

Responses

OK

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