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

Operations

Cluster

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

Operations

Virtual Network

Operations

Compute

Operations

KVM

Virtual machines

Operations

Repository

Container repository

Operations

Audit

Operations

Group

Groups allow exposing ZTNA applications to users.

Operations

IDP

Operations

Org

Operations

Order

Provision process management

Operations

Permissions

Operations

List policies

Request

Requires permissions::read permission.

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 policy

Request

Requires permissions::modify permission.

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

Delete a policy

Request

Requires permissions::modify permission.

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