GET
/attachment-overviews
Description
Retrieve a list of attachment overviews with optional filters, search, and pagination
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
offset | Pagination offset | integer | query | |
limit | Pagination limit | integer | query | |
order_by | Sorting order (e.g., 'created_at asc') | string | query | |
search | Search term | string | query | |
type | Filter by type of attachment (e.g., 'model_version') | string | query | |
identifier.filename | Filter by identifier filename | string | query | |
identifier.datasetId | Filter by identifier datasetId | string | query | |
identifier.snapshotId | Filter by identifier snapshotId | string | query | |
identifier.commit | Filter by identifier commit | string | query | |
identifier.branch | Filter by identifier branch | string | query | |
identifier.source | Filter by identifier source | string | query | |
identifier.name | Filter by identifier name | string | query | |
identifier.version | Filter by identifier version | string | query | |
identifier.volumeId | Filter by identifier volumeId | string | query | |
identifier.artifactId | Filter by identifier artifactId | string | query | |
identifier.executionName | Filter by identifier executionName | string | query | |
identifier.executionWorkflowName | Filter by identifier executionWorkflowName | string | query | |
identifier.executionWorkflowVersion | Filter by identifier executionWorkflowVersion | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 500 | Internal Server Error |
POST
/bundles/{id}/attachments
Description
Create new attachment
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the bundle to which the attachment belongs | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.CreateAttachment | Attachment to create guardrails.CreateAttachment |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
DELETE
/bundles/{id}/attachments/{attachmentID}
Description
Delete attachment
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the bundle to which the attachment belongs | string | path | |
attachmentID | ID of the attachment to delete | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | No Content | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
POST
/rpc/delete-attachment-and-results
Description
Delete attachment and results
Body Parameter
| Name | Description | Required |
|---|---|---|
server.DeleteAttachmentRequest | Request for deleting attachment and results server.DeleteAttachmentRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 204 | No Content | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
GET
/bundles
Description
List bundles
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
limit | Limit | integer | query | |
offset | Offset | integer | query | |
project_id | Project ID | List of string | query | |
state | State | List of string | query | |
order_by | Order by | string | query | |
search | Search | string | query | |
policy_id | Policy ID | List of string | query | |
id | ID | List of string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 500 | Internal Server Error |
POST
/bundles
Description
Create new bundle
Body Parameter
| Name | Description | Required |
|---|---|---|
server.CreateBundle | Bundle to create server.CreateBundle |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 423 | Locked | |
| 500 | Internal Server Error |
GET
/bundles/{id}
Description
Get bundle by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of bundle to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PATCH
/bundles/{id}
Description
Update bundle by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of bundle to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdateBundle | Bundle to update server.UpdateBundle |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
POST
/bundles/{id}/archive-endpoints
Description
Archive all monitored models for a bundle. This is typically done when a bundle is archived.
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the bundle whose monitored models are to be archived | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
POST
/bundles/{id}/register-endpoint
Description
Add monitor model entry and set it as governed
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the bundle to which the monitored endpoint belongs | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.RegisterMonitorModelRequest | Endpoint to govern guardrails.RegisterMonitorModelRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/bundles/{id}/report
Description
Download a PDF report for a bundle. Includes all stages, evidence, and results
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of bundle for which to create a report | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
PATCH
/bundles/{id}/stages/{stageID}
Description
Update bundle stage by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of bundle to update | string | path | |
stageID | ID of stage to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdateBundleStage | Bundle stage to update server.UpdateBundleStage |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/bundles/{id}/update-endpoint/{endpointID}
Description
Update monitored model entry
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the bundle to which the monitored endpoint belongs | string | path | |
endpointID | ID of the monitored endpoint | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.UpdateMonitorModelRequest | Changes to the monitored model guardrails.UpdateMonitorModelRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
POST
/rpc/add-policies-to-bundle
Description
Add a policy to govern a bundle
Body Parameter
| Name | Description | Required |
|---|---|---|
server.AddPoliciesToBundle | Request to add policies to a bundle server.AddPoliciesToBundle |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 500 | Internal Server Error |
PATCH
/rpc/update-bundle-policy
Description
Update the policy of a bundle
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.UpdateBundlePolicyRequest | request to update a bundle policy guardrails.UpdateBundlePolicyRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
GET
/bundles/{id}/findings
Description
List Findings
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
limit | Limit | integer | query | |
offset | Offset | integer | query | |
id | ID of bundle of the findings to retrieve | string | path | |
order_by | Order by | string | query | |
search | Search | string | query | |
status | Status | string | query | |
policy_id | Policy ID | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 500 | Internal Server Error |
POST
/findings
Description
Create new finding
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.CreateFindingRequest | Finding to create guardrails.CreateFindingRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 423 | Locked | |
| 500 | Internal Server Error |
GET
/findings/{id}
Description
Get finding by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of finding to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/findings/{id}
Description
Update the finding by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of finding to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.UpdateFindingRequest | Finding to update guardrails.UpdateFindingRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 423 | Locked | |
| 500 | Internal Server Error |
PUT
/rpc/bulk-edit-findings
Description
Bulk update finding severity or due date given a list of finding IDs
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.BulkUpdateFindingRequest | Findings to bulk update guardrails.BulkUpdateFindingRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
PUT
/drafts
Description
Upsert drafts
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpsertDraftsRequest | Drafts to upsert server.UpsertDraftsRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/drafts/latest
Description
Get latest draft for bundle ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
bundleId | Bundle ID | string | query | |
policyId | Policy ID | string | query | |
policyVersionId | Policy Version ID | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/evidence-templates
Description
List evidence template paginated
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
limit | Limit | integer | query | |
offset | Offset | integer | query | |
status | Status | List of string | query | |
order_by | Order by | string | query | |
search | Search | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/evidence-templates/{id}
Description
Get evidence template by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of evidence template to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/evidence-templates/{id}
Description
Upsert evidence template
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of evidence template to upsert | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpsertEvidenceTemplate | Evidence template to upsert server.UpsertEvidenceTemplate |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/evidence-templates/{id}/definition
Description
Get evidence template definition YAML by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of evidence template definition YAML to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The evidence template definition | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/evidence-templates/{id}/definition
Description
Update evidence template definition by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of evidence template definition YAML to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.EvidenceTemplateDefinition | Evidence template definition to update server.EvidenceTemplateDefinition |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/evidence-templates/{id}/status
Description
Update evidence template status by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of evidence template status to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdateEvidenceTemplateStatus | Evidence template status to update server.UpdateEvidenceTemplateStatus |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
POST
/policies
Description
Create a policy
Body Parameter
| Name | Description | Required |
|---|---|---|
server.CreatePolicyRequest | Policy to create server.CreatePolicyRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 409 | Conflict | |
| 423 | Locked | |
| 500 | Internal Server Error |
PUT
/policies
Description
Create or update a policy
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpsertPolicyRequest | Policy to create or update server.UpsertPolicyRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
GET
/policies/{id}
Description
Get policy by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of policy to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/policies/{id}
Description
Update the policy meta by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of policy to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdatePolicyRequest | Policy to update server.UpdatePolicyRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/policies/{id}/definition
Description
Get the policy definition YAML by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the definition of the policy to retrieve | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Definition of the policy | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
PUT
/policies/{id}/definition
Description
Create or update a policy definition through yaml
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of the definition of the policy to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.PolicyDefinition | Policy definition to create or update server.PolicyDefinition |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
PUT
/policies/{id}/status
Description
Update the policy status by ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
id | ID of policy to update | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdatePolicy | Policy status to update server.UpdatePolicy |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
GET
/policy-overviews
Description
List policy overviews
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
limit | Limit | integer | query | |
offset | Offset | integer | query | |
status | Status | List of string | query | |
order_by | Order by | string | query | |
search | Search | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 500 | Internal Server Error |
GET
/results
Description
List results
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
bundleID | Bundle ID | string | query | |
policyID | Policy ID | string | query | |
policyVersionID | Policy Version ID | string | query | |
artifactID | Artifact IDs | List of string | query | |
createdBy.id | Created By IDs | List of string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 500 | Internal Server Error |
POST
/results
Description
Create new results. If the results have impact on classification, please use the api /rpc/submit-result-to-policy.
Body Parameter
| Name | Description | Required |
|---|---|---|
server.CreateResultsRequest | Results to create server.CreateResultsRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
GET
/results/latest
Description
Get latest results for bundle ID
Parameters
| Name | Description | Required | Type | In |
|---|---|---|---|---|
bundleID | Bundle ID | string | query | |
artifactID | Artifact ID | List of string | query | |
policyID | Policy ID | string | query | |
policyVersionID | Policy Version ID | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found |
POST
/rpc/analyze-monitor-model
Description
[BETA] Analyze model monitor metrics. Endpoint is subject to change, should only be used internally.
Body Parameter
| Name | Description | Required |
|---|---|---|
server.AnalyzeModelRequest | The monitor model request for monitor metric field server.AnalyzeModelRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
POST
/rpc/compute-policy
Description
compute a policy within the context of a bundle
Body Parameter
| Name | Description | Required |
|---|---|---|
server.ComputePolicy | Bundle ID and Policy ID used to compute server.ComputePolicy |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | Internal Server Error |
POST
/rpc/copy-bundle
Description
Copy the transferable results from one bundle to another
Body Parameter
| Name | Description | Required |
|---|---|---|
server.CopyBundleRequest | Request for copying a bundle server.CopyBundleRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
POST
/rpc/publish-approval-event
Description
Publish an approval event and get the computed approval
Body Parameter
| Name | Description | Required |
|---|---|---|
guardrails.ApprovalEventRequest | Request for publishing an approval event guardrails.ApprovalEventRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
POST
/rpc/submit-result-to-policy
Description
Submit a result and get computed policy
Body Parameter
| Name | Description | Required |
|---|---|---|
server.SubmitResultToPolicy | Request for submitting result and computing policy server.SubmitResultToPolicy |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 423 | Locked | |
| 500 | Internal Server Error |
POST
/rpc/update-approval
Description
Update approval by ID
Body Parameter
| Name | Description | Required |
|---|---|---|
server.UpdateApprovalReq | The update approval request server.UpdateApprovalReq |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 409 | Conflict | |
| 500 | Internal Server Error |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| approver | guardrails.FindingUser | |
| artifactId | String | |
| assignee | guardrails.FindingUser | |
| evidenceId | String | |
| meta | guardrails.FindingMeta |
| Field Name | Required | Type |
|---|---|---|
| approvers | List of guardrails.Approver | |
| bundleId | String | |
| id | String | |
| name | String | |
| policyId | String | |
| policyVersionId | String | |
| stageApprovalId | String | |
| status | guardrails.ApprovalStatus | |
| taskId | String | |
| updatedAt | String | |
| updatedBy | Object |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| bundleId | String | |
| eventType | guardrails.ApprovalEventType | |
| meta | Object | |
| policyId | String | |
| projectId | String | |
| stageApprovalId | String |
| Field Name | Required | Type |
|---|---|---|
| approvalStatus | guardrails.ApprovalStatus | |
| timelineStatus | guardrails.ApprovalTimelineStatus | |
| updatedAt | String |
| Field Name | Required | Type |
|---|---|---|
| approvalTimelineMap | guardrails.ApprovalTimelineInfo | |
| createdAt | String | |
| createdBy | Object | |
| id | String | |
| identifier | Object | |
| type | guardrails.AttachmentType |
| Field Name | Required | Type |
|---|---|---|
| approvalTimelineMap | guardrails.ApprovalTimelineInfo | |
| bundle | guardrails.Bundle | |
| createdAt | String | |
| createdBy | Object | |
| id | String | |
| identifier | Object | |
| type | guardrails.AttachmentType |
| Field Name | Required | Type |
|---|---|---|
| findings |
| Field Name | Required | Type |
|---|---|---|
| dueDate | String | |
| id | String | |
| severity | guardrails.FindingSeverity |
| Field Name | Required | Type | Description |
|---|---|---|---|
| attachments | List of guardrails.Attachment | ||
| classificationValue | String | The classification value of the primary policy | |
| commentsCount | Integer | ||
| createdAt | String | ||
| createdBy | Object | ||
| gates | List of guardrails.Gate | ||
| id | String | ||
| name | String | ||
| policies | List of guardrails.BundlePolicy | ||
| policyId | String | The ID of the primary policy | |
| policyName | String | ||
| policyVersionId | String | The version of the primary policy | |
| projectId | String | ||
| projectName | String | ||
| projectOwner | String | ||
| stage | String | The stage of the primary policy | |
| stageApprovals | List of guardrails.StageApproval | ||
| stageAssignee | The assignee to the stage of the primary policy | ||
| stages | List of guardrails.BundleStage | ||
| state | guardrails.BundleState |
| Field Name | Required | Type |
|---|---|---|
| assignedAt | String | |
| assignee | guardrails.BundleStageAssignee | |
| bundleId | String | |
| stage | guardrails.Stage | |
| stageId | String |
| Field Name | Required | Type |
|---|---|---|
| approvers | List of guardrails.Approver | |
| bundleId | String | |
| id | String | |
| isUserApprover | Boolean | |
| name | String | |
| policyId | String | |
| policyVersionId | String | |
| stageApprovalId | String | |
| status | guardrails.ApprovalStatus | |
| taskId | String | |
| updatedAt | String | |
| updatedBy | Object |
| Field Name | Required | Type | Description |
|---|---|---|---|
| approvals | List of guardrails.ComputedApproval | ||
| bundle | guardrails.Bundle | ||
| bundleStages | List of guardrails.BundleStage | ||
| commentsInfo | guardrails.CommentsInfo | ||
| drafts | List of guardrails.ArtifactDraft | ||
| findingsInfo | guardrails.FindingsInfo | ||
| isUserApprover | Boolean | Indicates if the current user is an approver for any of the approvals in this bundle policy | |
| policy | guardrails.Policy | ||
| results | List of guardrails.ArtifactResult |
| Field Name | Required | Type |
|---|---|---|
| identifier | Object | |
| type | guardrails.AttachmentType |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| approver | guardrails.FindingUser | |
| artifactId | String | |
| assignee | guardrails.FindingUser | |
| bundleId | String | |
| description | String | |
| dueDate | String | |
| evidenceId | String | |
| meta | guardrails.FindingMeta | |
| name | String | |
| severity | guardrails.FindingSeverity |
| Field Name | Required | Type | Description |
|---|---|---|---|
| artifacts | List of guardrails.EvidenceArtifact | ||
| createdAt | String | ||
| description | String | ||
| externalId | String | ||
| id | String | ||
| name | String | ||
| policyId | String | ||
| policyVersionId | String | ||
| scope | guardrails.EvidenceScope | ||
| visible | Boolean | allows true, false or nil values (if nil, FE can decide to show everything) |
| Field Name | Required | Type | Description |
|---|---|---|---|
| artifactType | guardrails.ArtifactType | ||
| details | Object | ||
| id | String | ||
| required | Boolean | ||
| visibilityRule | String | ||
| visible | Boolean | allows true, false or nil values (if nil, FE can decide to show everything) |
| Field Name | Required | Type |
|---|---|---|
| artifacts | List of guardrails.EvidenceArtifact | |
| createdAt | String | |
| description | String | |
| externalId | String | |
| id | String | |
| name | String | |
| scope | guardrails.EvidenceScope | |
| status | guardrails.EvidenceStatus |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| approvalName | String | |
| approver | guardrails.FindingUser | |
| artifactId | String | |
| assignee | guardrails.FindingUser | |
| bundleId | String | |
| createdAt | String | |
| createdBy | Object | |
| description | String | |
| dueDate | String | |
| evidenceId | String | |
| id | String | |
| name | String | |
| policyId | String | |
| required | Boolean | |
| severity | guardrails.FindingSeverity | |
| status | guardrails.FindingStatus | |
| taskId | String | |
| updatedAt | String | |
| updatedBy | Object |
| Field Name | Required | Type |
|---|---|---|
| id | String | |
| status | guardrails.FindingStatus |
| Field Name | Required | Type |
|---|---|---|
| approvalFindingsCountMap | Object<Integer> | |
| approvalFindingsMap | Object<guardrails.FindingInfo[]> | |
| artifactFindingsCountMap | Object<Integer> | |
| bundleFindingsCount | Integer |
| Field Name | Required | Type |
|---|---|---|
| bundleId | String | |
| id | String | |
| isOpen | Boolean | |
| name | String | |
| policyGateId | String | |
| reason | String | |
| resources | List of guardrails.RuleDefinition |
| Field Name | Required | Type |
|---|---|---|
| filters | List of guardrails.Filter | |
| pagination | guardrails.Pagination | |
| search | String | |
| sort | List of guardrails.Sorter |
| Field Name | Required | Type |
|---|---|---|
| artifactId | String | |
| endTime | String | |
| endpointVersionId | String | |
| evidenceId | String | |
| metricTimeline | List of guardrails.ModelMonitorTimeline | |
| name | String | |
| startTime | String |
| Field Name | Required | Type |
|---|---|---|
| bundleId | String | |
| createdAt | String | |
| endpointVersionId | String | |
| id | String | |
| isGoverned | Boolean | |
| lastFailedAt | String | |
| modelId | String | |
| name | String | |
| tracking | guardrails.AlertTracking | |
| updatedAt | String |
| Field Name | Required | Type |
|---|---|---|
| approvers | List of guardrails.Approver | |
| archived | Boolean | |
| classificationArtifactMap | Object<String> | |
| classificationRule | String | |
| createdAt | String | |
| createdBy | Object | |
| description | String | |
| enforceSequentialOrder | Boolean | |
| gates | List of guardrails.PolicyGate | |
| id | String | |
| labels | Object | |
| name | String | |
| parentId | String | |
| simpleClassificationQuestionId | String | |
| stages | List of guardrails.Stage | |
| status | guardrails.PolicyStatus | |
| updatedAt | String | |
| updatedBy | Object |
| Field Name | Required | Type |
|---|---|---|
| id | String | |
| name | String | |
| policyId | String | |
| policyVersionId | String | |
| resources | List of guardrails.RuleDefinition |
| Field Name | Required | Type |
|---|---|---|
| archived | Boolean | |
| createdBy | Object | |
| description | String | |
| id | String | |
| labels | Object | |
| name | String | |
| status | guardrails.PolicyStatus | |
| updatedAt | String | |
| usage | Object<Integer> |
| Field Name | Required | Type |
|---|---|---|
| approvalID | String | |
| approver | guardrails.FindingUser | |
| artifactID | String | |
| assignee | guardrails.FindingUser | |
| endpointVersionID | String | |
| evidenceID | String | |
| isGoverned | Boolean | |
| meta | guardrails.FindingMeta |
| Field Name | Required | Type |
|---|---|---|
| action | guardrails.RuleAction | |
| failOpen | Boolean | |
| parameters | Object |
| Field Name | Required | Type |
|---|---|---|
| approvals | List of guardrails.StageApproval | |
| evidenceSet | List of guardrails.Evidence | |
| id | String | |
| name | String | |
| policyVersionId | String |
| Field Name | Required | Type |
|---|---|---|
| approvers | List of guardrails.Approver | |
| evidence | guardrails.Evidence | |
| id | String | |
| name | String | |
| required | Boolean |
| Field Name | Required | Type |
|---|---|---|
| approver | guardrails.FindingUser | |
| artifactId | String | |
| assignee | guardrails.FindingUser | |
| description | String | |
| dueDate | String | |
| evidenceId | String | |
| name | String | |
| required | Boolean | |
| severity | guardrails.FindingSeverity | |
| status | guardrails.FindingStatus |
| Field Name | Required | Type |
|---|---|---|
| action | guardrails.Action | |
| code | String | |
| details | server.ErrorDetail | |
| message | String | |
| resource | server.ResourceRequest | |
| status | Integer |
| Field Name | Required | Type |
|---|---|---|
| action | guardrails.Action | |
| resource | server.ResourceRequest | |
| value | server.BulkUpdateValueRequest |
| Field Name | Required | Type |
|---|---|---|
| error | server.APIError | |
| results | List of server.OperationResult |
| Field Name | Required | Type |
|---|---|---|
| assignee | server.AssigneeRequest | |
| stage | server.StageRequest | |
| state | server.StateRequest |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| approvalName | String | |
| approver | guardrails.FindingUser | |
| artifactId | String | |
| assignee | guardrails.FindingUser | |
| bundleId | String | |
| createdAt | String | |
| createdBy | Object | |
| description | String | |
| dueDate | String | |
| evidenceId | String | |
| id | String | |
| name | String | |
| policyId | String | |
| policyName | String | |
| required | Boolean | |
| severity | guardrails.FindingSeverity | |
| status | guardrails.FindingStatus | |
| taskId | String | |
| updatedAt | String | |
| updatedBy | Object |
| Field Name | Required | Type | Description |
|---|---|---|---|
| additionalPolicyIds | List of string | Optional, for additional policies to be included in the bundle | |
| attachments | List of guardrails.CreateAttachment | ||
| name | String | ||
| policyId | String | Primary policy ID for the bundle | |
| projectId | String |
| Field Name | Required | Type |
|---|---|---|
| bundleId | String | |
| content | guardrails.Content | |
| evidenceId | String | |
| policyId | String |
| Field Name | Required | Type |
|---|---|---|
| data | List of guardrails.ArtifactResult | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| action | guardrails.Action | |
| data | ||
| error | server.APIError | |
| resource | server.ResourceRequest | |
| status | Integer |
| Field Name | Required | Type |
|---|---|---|
| data | List of guardrails.AttachmentOverview | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| data | List of guardrails.Bundle | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| data | List of guardrails.EvidenceTemplate | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| data | List of server.ComputedFinding | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| data | List of guardrails.PolicyOverview | |
| meta | guardrails.Meta |
| Field Name | Required | Type |
|---|---|---|
| ids | server.ResourceIDsRequest | |
| type | guardrails.ResourceType |
| Field Name | Required | Type |
|---|---|---|
| name | guardrails.BundleState |
| Field Name | Required | Type |
|---|---|---|
| approvalId | String | |
| approvers | List of guardrails.SelectedApprover | |
| policyId | String |
| Field Name | Required | Type |
|---|---|---|
| assignee | guardrails.BundleStageAssignee |
| Field Name | Required | Type |
|---|---|---|
| status | guardrails.EvidenceStatus |
| Field Name | Required | Type |
|---|---|---|
| status | guardrails.PolicyStatus |