Skip to content

Trustgrid Management API (1.0.0)

The Trustgrid Management API provides programmatic access to manage the Trustgrid network infrastructure platform. Trustgrid connects distributed nodes (appliances and agents) into secure overlay networks with centralized management.

Key Concepts

  • Nodes: The core compute units — either Node (physical/VM appliance) or Agent (lightweight software agent on a device). Identified by UUID (uid) and FQDN.
  • Clusters: High-availability groups of nodes sharing configuration.
  • Domains: Logical groupings of nodes within an organization.
  • Virtual Networks: Layer-3 overlay networks (DomainNetwork) created within a domain, enabling zero-trust connectivity between nodes. Each network has access policies, DNS config, routes, and port forwarding rules.
  • Tags: Key-value metadata attached to nodes and clusters for grouping and permissions.
  • Shadow: Each node has an AWS IoT Device Shadow with desired (target config) and reported (current state) halves. The reported shadow contains telemetry using dot-notation keys (e.g. nic.eth0.mtu, node-core.version).

Authentication

All API requests require a JWT Bearer token in the Authorization header:

Authorization: Bearer <token>

Tokens are obtained via the Trustgrid portal or programmatically via service user credentials. See API Access docs.

Permissions

Most endpoints require specific permissions (noted in each endpoint's description). Permissions follow the pattern resource::action (e.g. nodes::read, virtual-networks::modify).

Download OpenAPI description
index.json
index.yaml
Overview
License
unlicensed
Languages
Servers
Mock server
https://apidocs.trustgrid.io/_mock
https://api.trustgrid.io