Reference

Complete reference documentation for Stategraph configuration and APIs.

Reference Documentation

Document Description
API Reference REST API endpoints and usage
Environment Variables Configuration options
MQL Syntax Complete query language reference
Releases & Downloads Docker images and binary downloads

API Endpoints

  • GET /api/v1/whoami - Current user information
  • GET /api/v1/mql - Execute MQL query
  • GET /api/v1/tenants/{id}/states - List states
  • POST /api/v1/states/backend/{group_id} - Store state (Terraform)
  • GET /api/v1/states/{id}/instances - List resource instances

Full API Reference

Common Environment Variables

# Required
STATEGRAPH_UI_BASE=https://stategraph.example.com
DB_HOST=postgres
DB_USER=stategraph
DB_PASS=password
DB_NAME=stategraph

# Optional
STATEGRAPH_PORT=8180
STATEGRAPH_OAUTH_TYPE=google

Full Environment Variables Reference

MQL Quick Reference

-- Basic query
SELECT i.* FROM instances i
JOIN resources r ON i.resource_address = r.address AND i.state_id = r.state_id
WHERE r.type = 'aws_instance'

-- Aggregation
SELECT r.type, count(*) FROM resources r GROUP BY r.type ORDER BY r.type

-- JSON access
SELECT i.attributes->>'instance_type' FROM instances i

Full MQL Reference