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

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

Export configuration change audit logs as a downloadable file

Request

Requires audits::read:config permission.

Security
JWTAuthorizer
Query
itemIDstring

ID for the item to audit. If specified, must include itemType.

itemTypestring

Type of item to audit, e.g., Node or Cluster. If specified, must include itemID

timestampstring

Start time (unix timestamp) to query from

eTimestring

End time (unix timestamp) to query to

auditEventstring

Audit type to filter (create, delete, change, or action)

ipstring

IP address filter

userstring

User name filter

detailsstring

Details text filter

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/audit/download/config?itemID=string&itemType=string&timestamp=string&eTime=string&auditEvent=string&ip=string&user=string&details=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Export node activity and operational audit logs as a downloadable file

Request

Requires audits::read:node permission.

Security
JWTAuthorizer
Query
timestampstring

Start time (unix timestamp) to query from

FQDNstring

Node FQDN

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/audit/download/node?timestamp=string&FQDN=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Export user authentication and access audit logs as a downloadable file

Request

Requires audits::read:user permission.

Security
JWTAuthorizer
curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/audit/download/user \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

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