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

List certificates

Request

Requires certificates::read permission.

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

Responses

OK

Bodyapplication/jsonArray [
expiresAtnumber

Unix timestamp when certificate expires

fqdnstring

FQDN of certificate

Example: "mynode.trustgrid.io"
warningstring

Warning message

]
Response
application/json
[
  {
    "expiresAt": 0,
    "fqdn": "mynode.trustgrid.io",
    "warning": "string"
  }
]

Create a certificate

Request

Requires certificates::modify permission.

Security
JWTAuthorizer
Bodyapplication/jsonrequired

Certificate parts

chainstringrequired

Certificate chain in PEM format

private_keystringrequired

Private key for the certificate in PEM format

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/v2/certificates \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "chain": "string",
    "private_key": "string"
  }'

Responses

OK

Response
No content

Delete a certificate

Request

Requires certificates::modify permission.

Security
JWTAuthorizer
Path
fqdnstringrequired

FQDN of certificate

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

Responses

OK

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

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