Trustgrid Management API (1.0.0)

Download OpenAPI description

Overview

License unlicensed

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

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

List node audits

Request

List node (appliance or agent) audits

Requires audits::read:node permission.

Query

timestampstring

Start time (unix timestamp) to query from

FQDNstring

Node FQDN

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/audit/tail/node?FQDN=string&timestamp=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

List authentication audits

Request

Requires audits::read:user permission.

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/audit/tail/user \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

List recent flow logs

Request

Requires audits::read:flows permission.

Query

sTimenumber

Unix timestamp for the start of the log window

eTimenumber

Unix timestamp for the end of the log window

eTimeOpstring

Comparison operator for the end of the log window

Enum"eq""ne""gt""gte""lt""lte"

protocolstring

IP protocol

srcIpstring

Source IP address

dstIpstring

Destination IP address

srcPortnumber

Source port

srcPortOpstring

Comparison operator for the source port

Enum"eq""ne""gt""gte""lt""lte"

dstPortnumber

Destination port

dstPortOpstring

Comparison operator for the dest port

Enum"eq""ne""gt""gte""lt""lte"

limitnumber

Maximum number of results to return

srcNodestring

Source node name

dstNodestring

Dest node name

nodestring

Flow logging node ID

pagestring

Page of results to return

sortstring

Sort results, like port:desc

reverseboolean

When true, newer flow logs will be listed first

tcpFlagsArray of numbers

If provided, a flow must match at least one of the TCP flags provided. Decimal encoded, see flow log TCP flag encoding.

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/audit/flow-logs?dstIp=string&dstNode=string&dstPort=0&dstPortOp=eq&eTime=0&eTimeOp=eq&limit=0&node=string&page=string&protocol=string&reverse=true&sTime=0&sort=string&srcIp=string&srcNode=string&srcPort=0&srcPortOp=eq&tcpFlags=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Headers

x-total-countnumber

Total number of flows matching query

Bodyapplication/jsonArray [

activityIDstring

Threat Intelligence activity ID

Example: "9aa2bbc3-4265-475b-b977-c94b1ee25a1f"

destBytesnumber

Destination bytes transferred

Example: 100

destIPstring

Destination IP address

Example: "1.1.1.1"

destNodestring

Destination node name

Example: "mynode"

destPortnumber

Destination port

Example: 1234

endTimestring

Start time of the flow

Example: "2022-11-01T22:46:02.730Z"

protocolstring

Protocol

Enum"TCP""UDP""ICMP""UNKNOWN"

Example: "TCP"

sourceBytesnumber

Source bytes transferred

Example: 100

sourceIPstring

Source IP address

Example: "2.2.2.2"

sourceNodestring

Source node name

Example: "mynode"

sourcePortnumber

Source port

Example: 1234

startTimestring

Start time of the flow

Example: "2022-11-01T22:46:01.765Z"

tcpFlagsstring

TCP Flags encoded in hex:

0x01 - FIN
0x02 - SYN
0x04 - RST
0x08 - PSH
0x10 - ACK
0x20 - URG

Example: "00100001"

ztnaAppIDstring

ZTNA application ID

Example: "9aa2bbc3-4265-475b-b977-c94b1ee25a1f"

ztnaSessionIDstring

ZTNA application ID

Example: "9aa2bbc3-4265-475b-b977-c94b1ee25a1f"

]

Response

application/json

[
  {
    "activityID": "9aa2bbc3-4265-475b-b977-c94b1ee25a1f",
    "destBytes": 100,
    "destIP": "1.1.1.1",
    "destNode": "mynode",
    "destPort": 1234,
    "endTime": "2022-11-01T22:46:02.730Z",
    "protocol": "TCP",
    "sourceBytes": 100,
    "sourceIP": "2.2.2.2",
    "sourceNode": "mynode",
    "sourcePort": 1234,
    "startTime": "2022-11-01T22:46:01.765Z",
    "tcpFlags": "00100001",
    "ztnaAppID": "9aa2bbc3-4265-475b-b977-c94b1ee25a1f",
    "ztnaSessionID": "9aa2bbc3-4265-475b-b977-c94b1ee25a1f"
  }
]

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