Governance API

Server Details

  • Host: (none specified)

  • BasePath: /api/governance/v1

Endpoints
To Models

Attachments
Bundles
Findings
Drafts
Evidence-templates
Policies
Results
Rpc
Approvals

Attachments
Top

List attachment overviews

Create new attachment

Delete attachment

Delete attachment and results

Bundles
Top

List bundles

Create new bundle

Get bundle by ID

Update bundle by ID

Delete bundle by ID

Get bundle approvals

Archive all monitored models for a bundle

Get bundle gates

Set monitored model as governed

Download a PDF report for a bundle

Update bundle stage by ID

Update monitored model entry

Bulk update bundles

Add a policy to govern a bundle

Update the policy of a bundle

Findings
Top

List Findings

Create new finding

Get finding by ID

Update the finding by ID

Bulk update finding severity or due date

Drafts
Top

Upsert drafts

Get latest draft for bundle ID

Evidence-templates
Top

List evidence template paginated

Get evidence template by ID

Upsert evidence template

Delete evidence template by ID

Get evidence template definition YAML by ID

Update evidence template definition by ID

Update evidence template status by ID

Policies
Top

Create a policy

Create or update a policy

Get policy by ID

Update the policy meta by ID

Delete policy by ID

Get the policy definition YAML by ID

Create or update a policy definition through yaml

Update the policy status by ID

List policy overviews

Results
Top

List results

Create new results

Get latest results for bundle ID

Rpc
Top

[BETA] Analyze model monitor metrics

compute a policy within the context of a bundle

Copy the transferable results from one bundle to another

Publish an approval event and get the computed approval

Submit a result and get computed policy

Approvals
Top

Update approval by ID

Models
Top

guardrails.Action

guardrails.AlertTracking

guardrails.Approval

guardrails.ApprovalEventRequest

guardrails.ApprovalEventType

guardrails.ApprovalStatus

guardrails.ApprovalTimelineInfo

guardrails.ApprovalTimelineStatus

guardrails.Approver

guardrails.ArtifactDraft

guardrails.ArtifactResult

guardrails.ArtifactType

guardrails.Attachment

guardrails.AttachmentOverview

guardrails.AttachmentType

guardrails.BulkUpdateFindingRequest

guardrails.BulkUpdateSingleFindingRequest

guardrails.Bundle

guardrails.BundlePolicy

guardrails.BundleStage

guardrails.BundleStageAssignee

guardrails.BundleState

guardrails.CommentsInfo

guardrails.ComputedApproval

guardrails.ComputedPolicy

guardrails.Content

guardrails.CreateAttachment

guardrails.CreateFindingRequest

guardrails.Evidence

guardrails.EvidenceArtifact

guardrails.EvidenceScope

guardrails.EvidenceStatus

guardrails.EvidenceTemplate

guardrails.Filter

guardrails.Finding

guardrails.FindingInfo

guardrails.FindingMeta

guardrails.FindingSeverity

guardrails.FindingStatus

guardrails.FindingUser

guardrails.FindingsInfo

guardrails.Gate

guardrails.Meta

guardrails.ModelMonitorTimeline

guardrails.MonitorChecksType

guardrails.MonitorModel

guardrails.Pagination

guardrails.Policy

guardrails.PolicyGate

guardrails.PolicyOverview

guardrails.PolicyStatus

guardrails.RegisterMonitorModelRequest

guardrails.ResourceType

guardrails.RuleAction

guardrails.RuleDefinition

guardrails.SelectedApprover

guardrails.Sorter

guardrails.Stage

guardrails.StageApproval

guardrails.UpdateBundlePolicyRequest

guardrails.UpdateFindingRequest

guardrails.UpdateMonitorModelRequest

server.APIError

server.AddPoliciesToBundle

server.AnalyzeModelRequest

server.AssigneeRequest

server.BulkUpdateRequest

server.BulkUpdateResponse

server.BulkUpdateValueRequest

server.ComputePolicy

server.ComputedFinding

server.CopyBundleRequest

server.CreateBundle

server.CreatePolicyRequest

server.CreateResultsRequest

server.DeleteAttachmentRequest

server.ErrorDetail

server.EvidenceTemplateDefinition

server.HTTPError

server.ListResults

server.OperationResult

server.PaginatedAttachmentOverviews

server.PaginatedBundles

server.PaginatedEvidenceTemplates

server.PaginatedFindings

server.PaginatedPolicyOverviews

server.PolicyDefinition

server.ResourceIDsRequest

server.ResourceRequest

server.StageRequest

server.StateRequest

server.SubmitResultToPolicy

server.UpdateApprovalReq

server.UpdateBundle

server.UpdateBundleStage

server.UpdateEvidenceTemplateStatus

server.UpdatePolicy

server.UpdatePolicyRequest

server.UpsertDraftsRequest

server.UpsertEvidenceTemplate

server.UpsertPolicyRequest