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

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

Retrieve all access control policies and their permission rules

Request

Requires permissions::read permission.

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

Responses

OK

Bodyapplication/jsonArray [
descriptionstring

Policy description

Example: "My policy description"
namestring

Policy name

Example: "my-policy"
resourcesArray of strings
conditionsobject
statementsArray of objects
]
Response
application/json
[
  {
    "description": "My policy description",
    "name": "my-policy",
    "resources": [ … ],
    "conditions": { … },
    "statements": [ … ]
  }
]

Create a new access control policy with specified permissions and conditions

Request

Requires permissions::modify permission.

Security
JWTAuthorizer
Bodyapplication/json

Policy

descriptionstring

Policy description

Example: "My policy description"
namestring

Policy name

Example: "my-policy"
resourcesArray of strings
conditionsobject
statementsArray of objects
curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/v2/policy \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "My policy description",
    "name": "my-policy",
    "resources": [
      "string"
    ],
    "conditions": {
      "all": {
        "eq": {
          "tg:node:tags:environment": [
            "production"
          ],
          "tg:node:tags:another-tag": [
            "always-match"
          ]
        },
        "ne": {
          "tg:node:tags:environment": [
            "staging"
          ],
          "tg:node:tags:another-tag": [
            "dont-match"
          ]
        }
      },
      "any": {
        "eq": {
          "tg:node:tags:environment": [
            "production"
          ],
          "tg:node:tags:another-tag": [
            "always-match"
          ]
        },
        "ne": {
          "tg:node:tags:environment": [
            "staging"
          ],
          "tg:node:tags:another-tag": [
            "dont-match"
          ]
        }
      },
      "none": {
        "eq": {
          "tg:node:tags:environment": [
            "production"
          ],
          "tg:node:tags:another-tag": [
            "always-match"
          ]
        },
        "ne": {
          "tg:node:tags:environment": [
            "staging"
          ],
          "tg:node:tags:another-tag": [
            "dont-match"
          ]
        }
      }
    },
    "statements": [
      {
        "actions": [
          "string"
        ],
        "effect": "allow"
      }
    ]
  }'

Responses

OK

Response
No content

Remove an access control policy and revoke associated permissions

Request

Requires permissions::modify permission.

Security
JWTAuthorizer
Path
namestringrequired

Policy name

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

Responses

OK

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations