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

List upgrades

Request

Requires upgrade-manager::read permission.

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/upgrade-manager/api/v1/upgrades \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
clusterUpgradesArray of objects(ClusterUpgrade)
completedAtstring

Upgrade completion time

dryRunboolean

Whether this was a dry-run

excludeTagsobject

Exclude devices with these tags

failoverApprovedboolean

True once a user has approved cluster failovers

includeTagsobject

Include devices with these tags

manualFailoverboolean

Whether to require approval to failover clusters

namestring

Name of upgrade

Example: "Sep27"
nodeUpgradesArray of objects(NodeUpgrade)
offlineTimeoutnumber

Minutes to wait before failing (timing out) a workflow for a node in the offline state

startedAtstring

Upgrade start time

statusstring

Status of upgrade

Enum"active""planning""complete"
uidstring

Unique ID of upgrade

Example: "2DqxLdknjWxEkGt474d2Cstsa1O"
upgradeTimeoutnumber

Minutes to wait before failing (timing out) a workflow

]
Response
application/json
[
  {
    "clusterUpgrades": [ … ],
    "completedAt": "string",
    "dryRun": true,
    "excludeTags": { … },
    "failoverApproved": true,
    "includeTags": { … },
    "manualFailover": true,
    "name": "Sep27",
    "nodeUpgrades": [ … ],
    "offlineTimeout": 0,
    "startedAt": "string",
    "status": "active",
    "uid": "2DqxLdknjWxEkGt474d2Cstsa1O",
    "upgradeTimeout": 0
  }
]

Create a new upgrade

Request

Requires upgrade-manager::modify permission.

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/upgrade-manager/api/v1/upgrades \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
uidstring

Unique ID

Example: "a9f7cfec-da06-4822-b4ab-389e4ad51931"
Response
application/json
{
  "uid": "a9f7cfec-da06-4822-b4ab-389e4ad51931"
}

Get the active upgrade

Request

Requires upgrade-manager::read permission.

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/upgrade-manager/api/v1/upgrades/active \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
clusterUpgradesArray of objects(ClusterUpgrade)
completedAtstring

Upgrade completion time

dryRunboolean

Whether this was a dry-run

excludeTagsobject

Exclude devices with these tags

failoverApprovedboolean

True once a user has approved cluster failovers

includeTagsobject

Include devices with these tags

manualFailoverboolean

Whether to require approval to failover clusters

namestring

Name of upgrade

Example: "Sep27"
nodeUpgradesArray of objects(NodeUpgrade)
offlineTimeoutnumber

Minutes to wait before failing (timing out) a workflow for a node in the offline state

startedAtstring

Upgrade start time

statusstring

Status of upgrade

Enum"active""planning""complete"
uidstring

Unique ID of upgrade

Example: "2DqxLdknjWxEkGt474d2Cstsa1O"
upgradeTimeoutnumber

Minutes to wait before failing (timing out) a workflow

Response
application/json
{
  "clusterUpgrades": [
    { … }
  ],
  "completedAt": "string",
  "dryRun": true,
  "excludeTags": {
    "property1": "string",
    "property2": "string"
  },
  "failoverApproved": true,
  "includeTags": {
    "property1": "string",
    "property2": "string"
  },
  "manualFailover": true,
  "name": "Sep27",
  "nodeUpgrades": [
    { … }
  ],
  "offlineTimeout": 0,
  "startedAt": "string",
  "status": "active",
  "uid": "2DqxLdknjWxEkGt474d2Cstsa1O",
  "upgradeTimeout": 0
}

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

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations