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

Retrieve all hardware provisioning orders and their current status

Request

The responses for orders from this API request are not fully hydrated (eg, no nodes).

Security
JWTAuthorizer
curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/provisioning/api/v1/orders \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
address1string
address2string
applianceTypestring
attnstring
citystring
clusterIpstring
commentsArray of objects
companyNamestring
contactEmailstring
contactNamestring
contactPhonestring
customerRefNumstring
domainstring
dueDatestring
endUserAccountNumstring
flaggedboolean
haboolean

True when this order is for an HA pair

interfacesCountnumber[ 1 .. 2 ]

Number of interfaces to configure per node

locationNamestring
natsArray of objects
nodeCountnumber[ 1 .. 2 ]

Number of nodes needed to fulfill order

nodeNamestring
nodesArray of objects
notesstring
orderNumnumber

System-wide unique order number

routedNetworksstring
siteTypestring

Site deployment type

Enum"primary""secondary""test"
statestring
statusstring

Order status. API-side holistic validations apply to orders whose status is in provisioning, qa, shipped, delivered, installed, and in production.

Enum"new""gathering info""pending feedback""info received""provisioning""qa""shipped""delivered""installed""in production"
technicalContactEmailstring
technicalContactNamestring
technicalContactPhonestring
uidstring
zipstring
]
Response
application/json
[
  {
    "address1": "string",
    "address2": "string",
    "applianceType": "string",
    "attn": "string",
    "city": "string",
    "clusterIp": "string",
    "comments": [ … ],
    "companyName": "string",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "customerRefNum": "string",
    "domain": "string",
    "dueDate": "string",
    "endUserAccountNum": "string",
    "flagged": true,
    "ha": true,
    "interfacesCount": 1,
    "locationName": "string",
    "nats": [ … ],
    "nodeCount": 1,
    "nodeName": "string",
    "nodes": [ … ],
    "notes": "string",
    "orderNum": 0,
    "routedNetworks": "string",
    "siteType": "primary",
    "state": "string",
    "status": "new",
    "technicalContactEmail": "string",
    "technicalContactName": "string",
    "technicalContactPhone": "string",
    "uid": "string",
    "zip": "string"
  }
]

Submit a new hardware provisioning order for appliances or agents

Request

Security
JWTAuthorizer
Bodyapplication/json
address1string
address2string
applianceTypestring
attnstring
citystring
clusterIpstring
commentsArray of objects
companyNamestring
contactEmailstring
contactNamestring
contactPhonestring
customerRefNumstring
domainstring
dueDatestring
endUserAccountNumstring
flaggedboolean
haboolean

True when this order is for an HA pair

interfacesCountnumber[ 1 .. 2 ]

Number of interfaces to configure per node

locationNamestring
natsArray of objects
nodeCountnumber[ 1 .. 2 ]

Number of nodes needed to fulfill order

nodeNamestring
nodesArray of objects
notesstring
orderNumnumber

System-wide unique order number

routedNetworksstring
siteTypestring

Site deployment type

Enum"primary""secondary""test"
statestring
statusstring

Order status. API-side holistic validations apply to orders whose status is in provisioning, qa, shipped, delivered, installed, and in production.

Enum"new""gathering info""pending feedback""info received""provisioning""qa""shipped""delivered""installed""in production"
technicalContactEmailstring
technicalContactNamestring
technicalContactPhonestring
uidstring
zipstring
curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/provisioning/api/v1/orders \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "address1": "string",
    "address2": "string",
    "applianceType": "string",
    "attn": "string",
    "city": "string",
    "clusterIp": "string",
    "comments": [
      {}
    ],
    "companyName": "string",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "customerRefNum": "string",
    "domain": "string",
    "dueDate": "string",
    "endUserAccountNum": "string",
    "flagged": true,
    "ha": true,
    "interfacesCount": 1,
    "locationName": "string",
    "nats": [
      {
        "description": "string",
        "localCidr": "string",
        "networkCidr": "string"
      }
    ],
    "nodeCount": 1,
    "nodeName": "string",
    "nodes": [
      {
        "dns1": "string",
        "dns2": "string",
        "interfaces": [
          {
            "dhcp": true,
            "gateway": "string",
            "ip": "string",
            "subnet": "string"
          }
        ],
        "name": "string"
      }
    ],
    "notes": "string",
    "orderNum": 0,
    "routedNetworks": "string",
    "siteType": "primary",
    "state": "string",
    "status": "new",
    "technicalContactEmail": "string",
    "technicalContactName": "string",
    "technicalContactPhone": "string",
    "uid": "string",
    "zip": "string"
  }'

Responses

OK

Response
No content

Retrieve detailed information about a specific provisioning order

Request

Security
JWTAuthorizer
Path
uidstringrequired
curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/provisioning/api/v1/orders/{uid}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
address1string
address2string
applianceTypestring
attnstring
citystring
clusterIpstring
commentsArray of objects
companyNamestring
contactEmailstring
contactNamestring
contactPhonestring
customerRefNumstring
domainstring
dueDatestring
endUserAccountNumstring
flaggedboolean
haboolean

True when this order is for an HA pair

interfacesCountnumber[ 1 .. 2 ]

Number of interfaces to configure per node

locationNamestring
natsArray of objects
nodeCountnumber[ 1 .. 2 ]

Number of nodes needed to fulfill order

nodeNamestring
nodesArray of objects
notesstring
orderNumnumber

System-wide unique order number

routedNetworksstring
siteTypestring

Site deployment type

Enum"primary""secondary""test"
statestring
statusstring

Order status. API-side holistic validations apply to orders whose status is in provisioning, qa, shipped, delivered, installed, and in production.

Enum"new""gathering info""pending feedback""info received""provisioning""qa""shipped""delivered""installed""in production"
technicalContactEmailstring
technicalContactNamestring
technicalContactPhonestring
uidstring
zipstring
Response
application/json
{
  "address1": "string",
  "address2": "string",
  "applianceType": "string",
  "attn": "string",
  "city": "string",
  "clusterIp": "string",
  "comments": [
    {}
  ],
  "companyName": "string",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "customerRefNum": "string",
  "domain": "string",
  "dueDate": "string",
  "endUserAccountNum": "string",
  "flagged": true,
  "ha": true,
  "interfacesCount": 1,
  "locationName": "string",
  "nats": [
    { … }
  ],
  "nodeCount": 1,
  "nodeName": "string",
  "nodes": [
    { … }
  ],
  "notes": "string",
  "orderNum": 0,
  "routedNetworks": "string",
  "siteType": "primary",
  "state": "string",
  "status": "new",
  "technicalContactEmail": "string",
  "technicalContactName": "string",
  "technicalContactPhone": "string",
  "uid": "string",
  "zip": "string"
}

Permissions

Permissions management

Operations

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations