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

Returns all the VPN networks

Request

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Cluster FQDN

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

Responses

OK

Bodyapplication/jsonArray [
ipstring
namestring
routestring
fqdnstring
networkNamestring
]
Response
application/json
[
  {
    "ip": "string",
    "name": "string",
    "route": "string",
    "fqdn": "string",
    "networkName": "string"
  }
]

Attach a VPN network

Request

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Cluster FQDN

Bodyapplication/jsonrequired
ipstring
namestring
routestring
curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/v2/cluster/{clusterFQDN}/vpn' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ip": "string",
    "name": "string",
    "route": "string"
  }'

Responses

OK

Bodyapplication/json
dnsobject(VpnClusterDnsModel)
exportRoutesArray of objects(VpnNodeRouteModel)
importRoutesArray of objects(VpnNodeRouteModel)
interfacesArray of objects(VpnClusterInterfaceModel)
routestring
routesArray of objects(VpnClusterRouteModel)
servicesArray of objects(VpnClusterServiceModel)
wireguardobject(VpnClusterWireguardModel)
Response
application/json
{
  "dns": {
    "enabled": true,
    "upstream": [ … ],
    "fqdn": "string",
    "networkName": "string"
  },
  "exportRoutes": [
    { … }
  ],
  "importRoutes": [
    { … }
  ],
  "interfaces": [
    { … }
  ],
  "route": "string",
  "routes": [
    { … }
  ],
  "services": [
    { … }
  ],
  "wireguard": {
    "clients": [ … ],
    "enabled": true,
    "port": 0,
    "fqdn": "string",
    "networkName": "string"
  }
}

Delete a VPN network

Request

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Cluster FQDN

networkNamestringrequired

Network name

curl -i -X DELETE \
  'https://apidocs.trustgrid.io/_mock/v2/cluster/{clusterFQDN}/vpn/{networkName}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

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