Skip to main content

Documentation Index

Fetch the complete documentation index at: https://budecosystem-b7b14df4.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Core Entities

EntityPurposeKey Fields
ProviderSource of probe catalogname, type, availability
ProbeDetection capability unitid, tags, modality, guard types
RuleFine-grained detector in a probeid, status, threshold override
ProfileReusable guardrail policyname, probes, guard types, severity
DeploymentRuntime activation of profileproject, endpoint, status

Status Reference

StatusMeaning
activeCurrently enabled and protecting traffic
disabledConfigured but not enforcing
pending / deployingDeployment workflow in progress
deletedRemoved from active usage
unhealthy / failureRequires investigation and remediation

Guardrail Workflow Reference

Common Operations

Probe Discovery

  • List probes by provider and tag.
  • Inspect probe details and rule coverage.

Profile Management

  • Create profile with selected probes.
  • Configure guard types and severity.
  • Update profile over time with controlled rollout.

Deployment Management

  • Deploy profile to project/endpoint.
  • Monitor status.
  • Reconfigure or remove deployment as needed.

Configuration Guidance

ConfigurationRecommendation
Initial severityStart medium, tune with real traffic
Probe countStart minimal, then expand deliberately
Rollout strategyPilot first, then scale by project
DocumentationRecord owner, intent, and exceptions