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

Retrieve all edge computing containers running on a cluster

Request

Requires node-exec::read permission.

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Node FQDN

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

Responses

OK

Bodyapplication/jsonArray [
commandstring

Command to run in the container

descriptionstring

Container description

Example: "my container"
enabledboolean
execTypestring

Execution type

Enum"onDemand""service""recurring"
hostnamestring

Container hostname

Example: "mycontainer"
idstring

Container ID

Example: "b4011aa3-d0d5-4c5c-9c0b-19095ba515d5"
imageobject(Image)

Image

namestring

Container name

Example: "mycontainer"
privilegedboolean

Run the container as a privileged user

requireConnectivityboolean

Only start the container if the node has connectivity to the control plane. Needed for encrypted volumes.

stopTimestring

Grace period for container to stop when requested, in seconds

Example: "60"
useInitboolean

Indicates that an init process should be used as PID 1 in the container. Ensures responsibilities of an init system are performed inside the container (e.g., handling exit signals).

userstring

User name (or UID) and optionally the group (or GID) to use when starting the container. This will override the USER specified in the image

]
Response
application/json
[
  {
    "command": "string",
    "description": "my container",
    "enabled": true,
    "execType": "onDemand",
    "hostname": "mycontainer",
    "id": "b4011aa3-d0d5-4c5c-9c0b-19095ba515d5",
    "image": { … },
    "name": "mycontainer",
    "privileged": true,
    "requireConnectivity": true,
    "stopTime": "60",
    "useInit": true,
    "user": "string"
  }
]

Deploy a new containerized application to run on the cluster

Request

Requires node-exec::modify permission.

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Node FQDN

Bodyapplication/json

Container

commandstring

Command to run in the container

descriptionstring

Container description

Example: "my container"
enabledboolean
execTypestring

Execution type

Enum"onDemand""service""recurring"
hostnamestring

Container hostname

Example: "mycontainer"
idstring

Container ID

Example: "b4011aa3-d0d5-4c5c-9c0b-19095ba515d5"
imageobject(Image)

Image

namestring

Container name

Example: "mycontainer"
privilegedboolean

Run the container as a privileged user

requireConnectivityboolean

Only start the container if the node has connectivity to the control plane. Needed for encrypted volumes.

stopTimestring

Grace period for container to stop when requested, in seconds

Example: "60"
useInitboolean

Indicates that an init process should be used as PID 1 in the container. Ensures responsibilities of an init system are performed inside the container (e.g., handling exit signals).

userstring

User name (or UID) and optionally the group (or GID) to use when starting the container. This will override the USER specified in the image

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/v2/cluster/{clusterFQDN}/exec/container' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "command": "string",
    "description": "my container",
    "enabled": true,
    "execType": "onDemand",
    "hostname": "mycontainer",
    "id": "b4011aa3-d0d5-4c5c-9c0b-19095ba515d5",
    "image": {
      "repository": "mycompany.trustgrid.io/myimage",
      "tag": "latest"
    },
    "name": "mycontainer",
    "privileged": true,
    "requireConnectivity": true,
    "stopTime": "60",
    "useInit": true,
    "user": "string"
  }'

Responses

OK

Response
No content

Remove a containerized application from the cluster and stop execution

Request

Requires node-exec::modify permission.

Security
JWTAuthorizer
Path
containerIDstringrequired

Container ID

clusterFQDNstringrequired

Node FQDN

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

Responses

OK

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