Skip to content
Shoehorn
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Architecture
Ecosystem and Tools
Platform Overview
Quick Start
Changelog
Deployment
Deploying Shoehorn with ArgoCD
Backup & Restore
Deploying Shoehorn with FluxCD
K8s Agent
Deploying Shoehorn with Helm
Enable TLS with cert-manager
Upgrading Shoehorn
Kubernetes
Agent Health and Readiness
Kubernetes Annotations Reference
Entity Enrichment Modes
GitOps Integration
K8s Agent Reference
Kyverno Policy Examples
Network Observer
Registering Kubernetes Clusters
Service Catalog
Addon Manifests
Entities
Manifest Model
Manifest Validation
Manifests
Scorecards
Organization
GitHub Topics for Team Identification
Group Mappings
Org Chart
Roles and RBAC
Team Mapping and Sync
Teams
Integrations
CI/CD Integration
Cloud Provider Integration
GitHub Integration
GitHub App Permissions
Identity Providers
Okta Integration
Integrations Overview
Repository Ownership
Secrets Management
Terraform Provider
UpCloud Resources
Zitadel Integration
Forge
Forge Overview
Developing Molds
actions
Forge Actions
Catalog Registration
Catalog-Backed Selectors
Expressions and Context
GitHub Repository Access
GitHub Files and Templates
GitHub Repositories
Approval Workflows
Creating Molds
Scaffolder Actions
Features
Announcements
Docs Frontmatter
Documentation
Feature Flags
Forge
Governance
Engineering Insights
Marketplace and Addons
MCP: Connect your IDE to Shoehorn
Notifications
Operations
Search
Security
API Keys
Multi-Tenant Security
Security Overview
Security Findings
Monitoring
Grafana Dashboards
Distributed Tracing
Monitoring Overview
Prometheus Metrics
Operations
Search Backfill (Meilisearch Re-indexing)
License and Limits
Recrawl (Force Fresh GitHub Fetch)
CLI
CLI Getting Started
CLI Validator
API Reference
API Overview
Pagination
Admin
Overview
Settings
Get tenant settings
Update tenant settings
API Keys
List API keys
Generate API key
Revoke API key
Policies
List platform policies
Update platform policy
Features
List feature flags
Create feature flag
Update feature flag
Delete feature flag
Set tenant feature override
Remove tenant feature override
Scorecards
List scorecard categories
Create scorecard category
Update scorecard category
Delete scorecard category
List scorecard rules
Create scorecard rule
Update scorecard rule
Delete scorecard rule
Get grading configuration
Update grading configuration
Role Bundles
List role bundles
Create role bundle
Get role bundle
Update role bundle
Delete role bundle
Roles
List all roles
Assign role to user
Remove role from user
Database
Get database info
Get database connections
List database backups
Create database backup
System
Get system services info
License
Get license status
Activate license
Deactivate license
List pending cluster registrations
Approve a pending cluster registration
Reject a pending cluster registration
Catalog
Overview
Search
Search entities
Statistics
Get catalog statistics
Get entity type breakdown
Get programming language distribution
Get lifecycle stage distribution
Get team ownership statistics
Get unowned entities
Metrics
Get DORA metrics
Get bus factor analysis
Manifests
List manifests
Create manifest
Get manifest
Update manifest
Delete manifest
Validate manifest
Analyze manifest quality
Convert Backstage catalog-info.yaml
Documentation
List documentation entries
Get documentation content
Analytics
Get search analytics
Get search analytics by period
Indexing
Get search indexing status
Entities
Overview
Entities
List entities
Get entity by ID
Update entity
Delete entity
Get entity README
Get entity manifest
Get entity changelog
Get entity status
Get entity deployments
Get entity resources
Get entity K8s workloads
Get entity quick actions
Get entity scorecard
Get governance actions for entity
Get zombie workloads for entity
Get entity activity feed
Get entity incidents
Get entity on-call schedule
Get entity relations
Get entity service topology
Get entity documentation
Get entities summary statistics
Forge
Overview
Molds
List molds
Create mold
Get mold by slug
Update mold
Delete mold
Publish mold
Unpublish mold
Runs
List workflow runs
Execute a workflow
Get run details
Cancel a running workflow
Approve a pending workflow
Reject a pending workflow
Get run execution logs
Forge Stats
Get forge statistics
Governance
Overview
Governance
Get governance dashboard
Get documentation health
Governance Actions
List governance actions
Create governance action
Get governance action
Delete governance action (soft delete)
Update governance action
Integrations
Overview
Integrations
List integrations
Create integration
List integration configurations
Get integration details
Update integration
Delete integration
Trigger manual sync
Webhooks
List webhooks for integration
Create webhook
Update webhook
Delete webhook
GitHub webhook receiver
Kubernetes
Overview
K8s Agents
List registered K8s agents
Register a new K8s agent
Get agent details
Delete agent and all associated data
Rotate agent token
Revoke agent token
K8s Agent Push
Push workload data from agent
Agent heartbeat
Push network flow data
Marketplace
Overview
Marketplace
List marketplace catalog
List installed addons
Install addon
Uninstall addon
Enable addon
Disable addon
Import addon manifest
Upload addon bundle
Addon Runtime
Get addon runtime status
Get addon logs
Call addon route (GET)
Call addon route (POST)
Metrics
Overview
Metrics
Get current platform metrics
Get a time-series for a named metric
Notifications
Overview
Notifications
List notifications
Mark notification as read
Mark all notifications as read
Get notification preferences
Update notification preferences
Operations
Overview
Workloads
List all workloads
Get workload statistics
Get image usage statistics
Get replica health statistics
Get network policy coverage statistics
Get workload details
Get workload pods
Get workload events
List zombie workloads
GitOps
List GitOps resources
Get GitOps statistics
Get GitOps resource details
Trigger GitOps sync
Trigger GitOps refresh
NetworkFlows
List aggregated network flows for a cluster
Get the network topology graph for a cluster
Get summary statistics for a cluster's network flows
GitOps Agent
Push GitOps resources from agent
Get pending GitOps commands for agent
Update command status
Organization
Overview
OrgChart
Get the org chart
Bulk-update team parent relationships
Security
Overview
Security
Get security overview
List security findings
Get security finding details
Teams
Overview
Teams
List teams (public)
Get team by ID or slug (public)
Admin Teams
List all teams (admin)
Create team
Get team (admin)
Update team
Delete team
List team members
Add team member
Remove team member
List group mappings
Add group mapping
Remove group mapping
Get team role assignments
Assign role to team
Remove role from team
Users
Overview
Authentication
Get authentication status
Users
Get current user profile
List users
Get user by ID
Groups
List IdP groups
Get group role mappings
Assign role to group
Remove role from group
GitHub
Select theme
Dark
Light
Auto
Overview
Shoehorn Governance API
1.0.0
Section titled “Shoehorn Governance API 1.0.0”
Governance actions, dashboard metrics, and documentation health.
Informations
OpenAPI version:
3.0.3
Operations
Section titled “ Operations ”
GET
/governance/dashboard
GET
/governance/documentation
GET
/governance/actions
POST
/governance/actions
GET
/governance/actions/{id}
DELETE
/governance/actions/{id}
PATCH
/governance/actions/{id}