Knowledge Tree
API reference
v1.0.0
Docs
knowledgetree.dev
API reference
Health
GET
Health check
GET
Readiness check
Auth
POST
Exchange credentials for a JWT
POST
Revoke the current session token
GET
Return the authenticated user
GET
List all available roles
Services
GET
List services in the catalog
GET
Get a service by name
GET
List upstream and downstream dependencies
GET
Compute blast-radius for a service
GET
Get the latest generated runbook
Graph
POST
Execute a Cypher query
GET
Export the graph in JSON or GraphML format
GET
Export topology filtered by scope
Discovery
GET
List discovery scopes
POST
Create a new scope
GET
Get a scope by ID
PUT
Update an existing scope
DELETE
Delete a scope
POST
Test a provider connection
POST
Trigger a discovery run
GET
List recent discovery runs
GET
Get run details and status
GET
Get current discovery pipeline status
Docs
GET
List all generated documents
POST
Regenerate documentation
POST
Full-text search across generated docs
GET
Fetch a generated document by path
GET
Get a context pack for AI consumption
Changes
GET
List detected changes
GET
Get change statistics aggregated by time window
POST
Report a policy violation (editor+)
Plugins
GET
List installed plugins
GET
Get plugin details
POST
Install a new plugin (admin)
Admin
GET
Get runtime configuration
PUT
Update runtime configuration
GET
Get aggregated admin statistics
GET
Get system diagnostics
GET
List credential bindings
POST
Create a credential binding
GET
Get a credential by ID
DELETE
Delete a credential binding
POST
Test a credential connection
GET
List users and roles
POST
Create a new user
PUT
Update a user
DELETE
Delete a user
GET
Read the audit log (enterprise)
POST
Trigger key rotation (enterprise)
Agents
POST
Enroll a new agent
POST
Record an agent heartbeat
POST
Submit agent discovery results
GET
List registered agents
GET
Get agent details
GET
Get agent configuration
DELETE
Deregister an agent
Chat
POST
Send a chat message (REST)
GET
WebSocket transport for streaming chat responses
Metrics
GET
Application metrics (Prometheus or JSON)
Assessment
POST
Trigger a new cloud assessment (editor+)
GET
Get assessment run details
GET
List assessments for a scope
GET
List assessment findings for a scope
GET
List cost records for a scope
Search
GET
Search resources across providers and types
GET
List all resources with pagination
Cost Intelligence
GET
Get cost intelligence dashboard data
GET
Get compliance report
Onboarding
GET
Get current onboarding progress
POST
Start or resume the onboarding flow
POST
Mark an onboarding step as complete
POST
Skip the onboarding wizard
Notifications
GET
List notifications for the current user
POST
Mark a notification as read
POST
Mark all notifications as read
GET
Get notification delivery preferences
PUT
Update notification delivery preferences
POST
Register a device push notification token
DELETE
Unregister a push notification token
Navigation
GET
Get the dynamic navigation tree
GET
Get recently accessed items
GET
Get favorite/bookmarked items
POST
Toggle an item as favorite
GET
Get global search autocomplete suggestions
Custom RBAC
GET
List all custom roles
POST
Create a custom role (admin)
PUT
Update a custom role (admin)
DELETE
Delete a custom role (admin)
GET
List all available permission definitions
GET
List role-to-user bindings (admin)
POST
Assign a role to a user (admin)
DELETE
Remove a role binding (admin)
API Keys
GET
List all API keys for the current account
POST
Generate a new API key
DELETE
Revoke an API key
POST
Rotate an API key (regenerate value)
Audit
GET
List audit log events
GET
Get a single audit event with full detail
GET
Export the audit log as CSV or JSON
GET
Get aggregated audit statistics
Backup & Restore
GET
List all backups
POST
Trigger an on-demand backup (admin)
GET
Get backup details and status
DELETE
Delete a backup (admin)
POST
Restore from a backup (admin)
GET
Get backup scheduling and retention config (admin)
PUT
Update backup scheduling and retention config (admin)
Dead Letter Queue
GET
List dead-letter queue messages
GET
Get a single dead-letter message with full detail
POST
Retry a single failed message
POST
Retry all failed messages matching a filter
DELETE
Discard a single DLQ message
GET
Get DLQ statistics per source and status
Tenants
GET
List all tenants (admin)
POST
Create a new tenant (admin)
GET
Get tenant details
PUT
Update tenant settings (admin)
DELETE
Delete a tenant (admin)
GET
Get tenant resource quota usage
Accounts
GET
Get the current user's account profile
PUT
Update the current user's account profile
POST
Invite a team member (admin)
GET
List team members
DELETE
Remove a team member (admin)
Billing
POST
Create a Stripe Checkout session
POST
Create a Stripe Customer Portal session
GET
Get the current subscription details
GET
List billing invoices
GET
List available pricing plans
POST
Stripe webhook receiver
Usage Metering
GET
Get usage dashboard data
GET
Get usage broken down by category
GET
Get monthly usage history
GET
Get usage threshold alerts
PUT
Set usage alert thresholds (admin)
Retention
GET
List all retention policies (admin)
PUT
Update a retention policy (admin)
POST
Trigger immediate retention enforcement (admin)
Domains
GET
List configured custom domains (admin)
POST
Add a custom domain (admin)
POST
Verify domain ownership (admin)
DELETE
Remove a custom domain (admin)
SLA
GET
Get SLA summary for the current period
GET
Get historical SLA records
GET
List SLA breach events
PUT
Configure SLA targets (admin)
Status Page
GET
Get the public status page summary
GET
List monitored components and their current status
GET
List historical and ongoing incidents
POST
Create a new status page incident (admin)
PUT
Update an incident (admin)
POST
Resolve an incident (admin)
POST
Subscribe to status page notifications
Integration Registry
GET
List all configured integrations
GET
Get integration details and status
PUT
Configure or reconfigure an integration (admin)
POST
Test an integration connection (admin)
DELETE
Disable and remove an integration (admin)
GET
List all available integration types in the catalog
ServiceNow
POST
Trigger a CMDB sync with ServiceNow
GET
Get the latest sync status
POST
Push an infrastructure incident to ServiceNow
GET
Get a Configuration Item from ServiceNow
PagerDuty
POST
Trigger a PagerDuty alert
POST
Acknowledge a PagerDuty alert
POST
Resolve a PagerDuty alert
GET
Get the current on-call schedule
POST
Sync PagerDuty services into the knowledge graph
Slack
POST
Post a message to a Slack channel
GET
List accessible Slack channels
POST
Slack event subscription receiver (slash commands, interactivity)
POST
Sync Slack user list for notification routing
Jira
POST
Create a Jira issue from an infrastructure event
POST
Link a knowledge graph resource to a Jira issue
GET
Search Jira issues linked to infrastructure
POST
Sync Jira project and issue data
Confluence
POST
Publish a generated document to Confluence
GET
List accessible Confluence spaces
POST
Sync Confluence page content to the graph
Terraform
POST
Ingest a Terraform state file or backend
POST
Detect drift between Terraform state and live resources
GET
List Terraform workspaces from state backends
GET
Get a drift detection report
GitHub
GET
List accessible GitHub repositories
POST
Ingest IaC files from a repository
POST
Create a GitHub issue from an infrastructure finding
POST
Register a GitHub webhook for push and PR events
GET
List drift-detection pull requests created by KT
GitLab
GET
List accessible GitLab projects
POST
Ingest IaC files from a GitLab project
POST
Create a GitLab issue from a finding
Grafana
GET
List accessible Grafana dashboards
POST
Create or update a Grafana dashboard from a template
POST
Add a Grafana annotation for an infrastructure event
GET
List Grafana alert rules and instances
Datadog
GET
Query Datadog metrics for graph enrichment
POST
Push an infrastructure event to Datadog
GET
List Datadog monitors linked to discovered resources
POST
Sync Datadog monitors into the knowledge graph
Open Policy Agent
POST
Evaluate a Rego policy against graph data
GET
List loaded Rego policies
POST
Load a new Rego policy
DELETE
Remove a Rego policy
Backstage
GET
Backstage Entity Provider API
POST
Sync knowledge graph resources as Backstage entities
Plugin Registry
GET
Search the plugin registry
GET
Get registry plugin details and versions
POST
Publish a plugin to the registry (admin)
DELETE
Unpublish a specific plugin version (admin)
GET
Get plugin README documentation
Plugin Signing
POST
Sign a plugin binary (admin)
POST
Verify a plugin's signature
GET
Get the registry's public signing key
POST
Rotate the signing key pair (admin)
Marketplace
GET
List marketplace items and add-ons
GET
Get marketplace item details
POST
Purchase or install a marketplace item (admin)
GET
List purchased marketplace items
GET
Get marketplace item license details
Plugin Sandbox
GET
List sandbox environments and their status
POST
Create a new sandbox environment for a plugin (admin)
GET
Get sandbox details and resource usage
POST
Stop a sandbox environment (admin)
GET
Get sandbox execution logs
Plugin Analytics
GET
Get aggregated plugin analytics
GET
Get analytics for a specific plugin
GET
Get plugin error rates and stack traces
GET
Get plugin execution time distribution
Plugin Reviews
GET
List reviews for a plugin
POST
Submit a review for a plugin
PUT
Update an existing review
DELETE
Delete a review
GET
Get review summary stats (average rating, count)
Anomaly Detection
GET
List detected anomalies
GET
Get anomaly details and evidence
POST
Acknowledge an anomaly
POST
Resolve an anomaly
GET
Get anomaly detection statistics
POST
Trigger model retraining (admin)
Impact Analysis
GET
Analyze impact of a resource failure
POST
Analyze impact of a proposed change
GET
Get a saved impact analysis report
GET
List recent impact analysis reports
Auto-Remediation
GET
List auto-remediation rules
POST
Create an auto-remediation rule (admin)
PUT
Update a remediation rule (admin)
DELETE
Delete a remediation rule (admin)
GET
Get remediation action history
POST
Dry-run a remediation rule (admin)
NL Queries
POST
Submit a natural language query
GET
Get natural language query suggestions
POST
Explain a resource or relationship in natural language
GET
List recent natural language queries and results
Compliance Reports
GET
List available compliance frameworks
POST
Generate a compliance report
GET
List generated compliance reports
GET
Get a compliance report
GET
Export a compliance report as PDF or CSV
GET
List collected evidence for compliance controls
Capacity Forecasting
GET
Get capacity forecast for a resource type
GET
Get historical utilization trends
GET
Get capacity optimization recommendations
POST
Run a what-if capacity scenario
Security Trends
GET
Get security posture overview
GET
List security findings
GET
Get a security finding detail
GET
Get security trends over time
POST
Mark a finding as remediated
POST
Suppress a false-positive finding
Incident Response
GET
List incidents
POST
Create a new incident
GET
Get incident details and timeline
PUT
Update incident status and details
POST
Add a timeline event to an incident
POST
Assign an incident to a responder
POST
Resolve an incident
GET
List available incident responders
Webhook Events
GET
List configured webhooks
POST
Create a webhook (editor+)
DELETE
Delete a webhook (editor+)
GET
List webhook delivery attempts
POST
Send a test webhook event (editor+)
GET
List available webhook event types
Dashboards
GET
List custom dashboards
POST
Create a new dashboard (editor+)
GET
Get a dashboard with panel data
PUT
Update a dashboard (editor+)
DELETE
Delete a dashboard (editor+)
POST
Duplicate a dashboard (editor+)
Data Lake Export
GET
List data lake export configurations (admin)
POST
Create a data lake export configuration (admin)
POST
Trigger an immediate data export (admin)
GET
List data export jobs
GET
Get export job details and download URL
Infrastructure Scoring
GET
Get infrastructure score overview
GET
Get scores by category (security, reliability, cost, performance)
GET
Get score history over time
GET
Get actionable improvement suggestions
Cross-Account
GET
List cross-account links (admin)
POST
Create a cross-account link (admin)
DELETE
Delete a cross-account link (admin)
POST
Test a cross-account link (admin)
Cost Optimization
GET
Get cost optimization overview
GET
List cost savings recommendations
GET
Get savings plan analysis and RI recommendations
GET
List cost budgets and alerts
POST
Create a cost budget (admin)
GET
Get cost forecast for the current period
Certificate Tracking
GET
List tracked certificates
GET
Get certificate details
POST
Manually add a certificate to track
POST
Trigger a certificate expiry check (admin)
GET
Get certificate summary statistics
Multi-Account
GET
Get multi-account aggregated overview
GET
List linked accounts across providers
POST
Link a new cloud account (admin)
DELETE
Unlink a cloud account (admin)
POST
Switch active account context
Time Machine
GET
List available graph snapshots
GET
View the graph at a point in time
POST
Compare two points in time
POST
Create an ad-hoc snapshot (admin)
POST
Restore the graph to a snapshot (admin)
Architecture Diagrams
GET
List generated architecture diagrams
POST
Generate an architecture diagram
GET
Get a diagram by ID
GET
Export a diagram as PNG or SVG
DELETE
Delete a diagram (editor+)
Dependency Walker
GET
Walk the dependency tree from a resource
GET
Find the dependency path between two resources
GET
Find critical dependency paths (circuit breakers)
GET
Detect circular dependencies in the graph
Simulator
POST
Create a simulation scenario
GET
List simulation scenarios
GET
Get a simulation scenario
POST
Execute a simulation
GET
Get simulation run results
GET
List simulation runs
Health Score
GET
Get health score for a resource
GET
Get health score for a service
GET
Get health score dashboard overview
GET
Get health score history
GET
List health score contributing factors
POST
Suppress a health score factor (admin)
Post-Incident Review
GET
List post-incident reviews
POST
Create a post-incident review (admin)
GET
Get a post-incident review
PUT
Update a post-incident review
POST
Add an action item to a PIR
PUT
Update an action item status
GET
Export a PIR as PDF or Markdown
Persona Views
GET
List available persona views
POST
Create a custom persona view (admin)
GET
Get persona view configuration and data
PUT
Update a persona view (admin)
DELETE
Delete a persona view (admin)
POST
Set the active persona for the current user
Airgap
GET
Get airgap mode status and health
GET
List available offline update bundles
POST
Upload an offline update bundle (admin)
POST
Apply an offline update bundle (admin)
GET
Get offline data sync status
POST
Trigger an offline data sync (admin)
SSO
GET
Initiate SSO login flow
GET
SSO provider callback endpoint
Stats
GET
Get aggregated dashboard stats
Settings
GET
Get current user settings
PUT
Update current user settings
License
GET
Get current license information
API reference
Stats
Stats
Aggregated platform statistics.
GET
/api/v1/stats
Get aggregated dashboard stats