Governance API

Table of Contents

Service responsible for managing Domino Governance feature v1.0

API Information

General Info

Swagger Version 2.0
Title: Domino Governance API
Description: Service responsible for managing Domino Governance feature
Version: 1.0

Contact Information

Name: Domino Data Lab
URL: https://tickets.dominodatalab.com/hc/en-us
Email: support@dominodatalab.com

License

Name: Apache 2.0
URL: http://www.apache.org/licenses/LICENSE-2.0.html

Server Details

Host: (none specified)
BasePath: /api/governance/v1

Endpoints

Below is a summary of the available endpoints grouped by resource.

/bundles

GET /bundles

Description: List bundles
Consumes: application/json
Produces: application/json
Tags: bundles
Summary: List bundles

Parameters
NameLocationTypeDescription

limit

query

integer

Limit

offset

query

integer

Offset

project_id

query

array (string, multi)

Project ID

state

query

array (string, multi)

State

order_by

query

string

Order by

search

query

string

Search

policy_id

query

array (string, multi)

Policy ID

Responses

  • 200 - OK (Schema: #/definitions/server.PaginatedBundles)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

POST /bundles

Description: Create new bundle
Consumes: application/json
Produces: application/json
Tags: bundles
Summary: Create new bundle

Parameters
NameLocationTypeDescription

request

body (required)

object

Bundle to create (Schema: #/definitions/server.CreateBundle)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Bundle)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 409 - Conflict (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/bundles/{id}

GET /bundles/{id}

Description: Get bundle by ID
Consumes: application/json
Produces: application/json
Tags: bundles
Summary: Get bundle by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of bundle to retrieve

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Bundle)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

DELETE /bundles/{id}

Description: Delete bundle by ID
Consumes: application/json
Produces: application/json
Tags: bundles
Summary: Delete bundle by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of bundle to delete

Responses

  • 204 - No Content

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PATCH /bundles/{id}

Description: Update bundle by ID
Consumes: application/json
Produces: application/json
Tags: bundles
Summary: Update bundle by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of bundle to update

request

body (required)

object

Bundle to update (Schema: #/definitions/server.UpdateBundle)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Bundle)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/bundles/{id}/attachments

POST /bundles/{id}/attachments

Description: Create new attachment
Consumes: application/json
Produces: application/json
Tags: attachments
Summary: Create new attachment

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of the bundle to which the attachment belongs

request

body (required)

object

Attachment to create (Schema: #/definitions/guardrails.CreateAttachment)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Attachment)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/bundles/{id}/attachments/{attachmentID}

DELETE /bundles/{id}/attachments/{attachmentID}

Description: Delete attachment
Note: This endpoint is deprecated
Consumes: application/json
Produces: application/json
Tags: attachments
Summary: Delete attachment

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of the bundle to which the attachment belongs

attachmentID

path (required)

string

ID of the attachment to delete

Responses

  • 204 - No Content

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/bundles/{id}/findings

GET /bundles/{id}/findings

Description: List findings for a given bundle
Consumes: application/json
Produces: application/json
Tags: findings
Summary: List Findings

Parameters
NameLocationTypeDescription

limit

query

integer

Limit

offset

query

integer

Offset

id

path (required)

string

ID of bundle of the findings to retrieve

order_by

query

string

Order by

search

query

string

Search

status

query

string

Status

Responses

  • 200 - OK (Schema: #/definitions/server.PaginatedFindings)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/bundles/{id}/report

GET /bundles/{id}/report

Description: Download a PDF report for a bundle. Includes all stages, evidence, and results
Consumes: application/json
Produces: application/pdf
Tags: bundles
Summary: Download a PDF report for a bundle

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of bundle for which to create a report

Responses

  • 200 - OK (Schema: file)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/drafts

PUT /drafts

Description: Upsert drafts
Consumes: application/json
Produces: application/json
Tags: drafts
Summary: Upsert drafts

Parameters
NameLocationTypeDescription

request

body (required)

object

Drafts to upsert (Schema: #/definitions/server.UpsertDraftsRequest)

Responses

  • 200 - OK (Schema: array of #/definitions/guardrails.ArtifactDraft)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/drafts/latest

GET /drafts/latest

Description: Get latest draft for bundle ID
Consumes: application/json
Produces: application/json
Tags: drafts
Summary: Get latest draft for bundle ID

Parameters
NameLocationTypeDescription

bundleId

query (required)

string

Bundle ID

Responses

  • 200 - OK (Schema: array of #/definitions/guardrails.ArtifactDraft)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/evidence-templates

GET /evidence-templates

Description: List evidence template paginated
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: List evidence template paginated

Parameters
NameLocationTypeDescription

limit

query

integer

Limit

offset

query

integer

Offset

status

query

array (string, multi)

Status

order_by

query

string

Order by

search

query

string

Search

Responses

  • 200 - OK (Schema: #/definitions/server.PaginatedEvidenceTemplates)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/evidence-templates/{id}

GET /evidence-templates/{id}

Description: Get evidence template by ID
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Get evidence template by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template to retrieve

Responses

  • 200 - OK (Schema: #/definitions/guardrails.EvidenceTemplate)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PUT /evidence-templates/{id}

Description: Upsert evidence template
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Upsert evidence template

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template to upsert

request

body (required)

object

Evidence template to upsert (Schema: #/definitions/server.UpsertEvidenceTemplate)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.EvidenceTemplate)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

DELETE /evidence-templates/{id}

Description: Delete evidence template by ID
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Delete evidence template by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template to delete

Responses

  • 204 - No Content

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/evidence-templates/{id}/definition

GET /evidence-templates/{id}/definition

Description: Get evidence template definition YAML by ID
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Get evidence template definition YAML by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template definition YAML to retrieve

Responses

  • 200 - OK – The evidence template definition (Schema: #/definitions/server.EvidenceTemplateDefinition)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PUT /evidence-templates/{id}/definition

Description: Update evidence template definition by ID
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Update evidence template definition by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template definition YAML to update

request

body (required)

object

Evidence template definition to update (Schema: #/definitions/server.EvidenceTemplateDefinition)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.EvidenceTemplate)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/evidence-templates/{id}/status

PUT /evidence-templates/{id}/status

Description: Update evidence template status by ID
Consumes: application/json
Produces: application/json
Tags: evidence-templates
Summary: Update evidence template status by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of evidence template status to update

request

body (required)

object

Evidence template status to update (Schema: #/definitions/server.UpdateEvidenceTemplateStatus)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.EvidenceTemplate)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/findings

POST /findings

Description: Create new finding
Consumes: application/json
Produces: application/json
Tags: findings
Summary: Create new finding

Parameters
NameLocationTypeDescription

request

body (required)

object

Finding to create (Schema: #/definitions/server.CreateFindingRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Finding)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/findings/{id}

GET /findings/{id}

Description: Get finding by ID
Consumes: application/json
Produces: application/json
Tags: findings
Summary: Get finding by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of finding to retrieve

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Finding)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PUT /findings/{id}

Description: Update the finding by ID
Consumes: application/json
Produces: application/json
Tags: findings
Summary: Update the finding by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of finding to update

request

body (required)

object

Finding to update (Schema: #/definitions/guardrails.UpdateFindingRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Finding)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/policies

PUT /policies

Description: Create or update a policy
Note: This endpoint is deprecated
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Create or update a policy

Parameters
NameLocationTypeDescription

request

body (required)

object

Policy to create or update (Schema: #/definitions/server.UpsertPolicyRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

POST /policies

Description: Create a policy
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Create a policy

Parameters
NameLocationTypeDescription

request

body (required)

object

Policy to create (Schema: #/definitions/server.CreatePolicyRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 409 - Conflict (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/policies/{id}

GET /policies/{id}

Description: Get policy by ID
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Get policy by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of policy to retrieve

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PUT /policies/{id}

Description: Update the policy meta by ID
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Update the policy meta by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of policy to update

request

body (required)

object

Policy to update (Schema: #/definitions/server.UpdatePolicyRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

DELETE /policies/{id}

Description: Delete policy by ID
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Delete policy by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of policy to delete

Responses

  • 204 - No Content (Schema: #/definitions/server.HTTPError)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/policies/{id}/definition

GET /policies/{id}/definition

Description: Get the policy definition YAML by ID
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Get the policy definition YAML by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of the definition of the policy to retrieve

Responses

  • 200 - OK (Schema: #/definitions/server.PolicyDefinition)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

PUT /policies/{id}/definition

Description: Create or update a policy definition through YAML
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Create or update a policy definition through YAML

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of the definition of the policy to update

request

body (required)

object

Policy definition to create or update (Schema: #/definitions/server.PolicyDefinition)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/policies/{id}/status

PUT /policies/{id}/status

Description: Update the policy status by ID
Consumes: application/json
Produces: application/json
Tags: policies
Summary: Update the policy status by ID

Parameters
NameLocationTypeDescription

id

path (required)

string

ID of policy to update

request

body (required)

object

Policy status to update (Schema: #/definitions/server.UpdatePolicy)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Policy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/policy-overviews

GET /policy-overviews

Description: List policy overviews
Consumes: application/json
Produces: application/json
Tags: policies
Summary: List policy overviews

Parameters
NameLocationTypeDescription

limit

query

integer

Limit

offset

query

integer

Offset

status

query

array (string, multi)

Status

order_by

query

string

Order by

search

query

string

Search

Responses

  • 200 - OK (Schema: #/definitions/server.PaginatedPolicyOverviews)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/results

POST /results

Description: Create new results
Consumes: application/json
Produces: application/json
Tags: results
Summary: Create new results

Parameters
NameLocationTypeDescription

request

body (required)

object

Results to create (Schema: #/definitions/server.CreateResultsRequest)

Responses

  • 200 - OK (Schema: array of #/definitions/guardrails.ArtifactResult)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/results/latest

GET /results/latest

Description: Get latest results for bundle ID
Consumes: application/json
Produces: application/json
Tags: results
Summary: Get latest results for bundle ID

Parameters
NameLocationTypeDescription

bundleID

query (required)

string

Bundle ID

artifactID

query

array (string, multi)

Artifact ID

Responses

  • 200 - OK (Schema: array of #/definitions/guardrails.ArtifactResult)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

/rpc/bulk-edit-findings

PUT /rpc/bulk-edit-findings

Description: Bulk update finding severity or due date given a list of finding IDs
Consumes: application/json
Produces: application/json
Tags: findings
Summary: Bulk update finding severity or due date

Parameters
NameLocationTypeDescription

request

body (required)

object

Findings to bulk update (Schema: #/definitions/guardrails.BulkUpdateFindingRequest)

Responses

  • 200 - OK (Schema: array of #/definitions/guardrails.Finding)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/rpc/compute-policy

POST /rpc/compute-policy

Description: Compute a policy within the context of a bundle
Consumes: application/json
Produces: application/json
Tags: rpc
Summary: Compute a policy within the context of a bundle

Parameters
NameLocationTypeDescription

request

body (required)

object

Bundle ID and Policy ID used to compute (Schema: #/definitions/server.ComputePolicy)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.ComputedPolicy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/rpc/copy-bundle

POST /rpc/copy-bundle

Description: Copy the transferable results from one bundle to another
Consumes: application/json
Produces: application/json
Tags: rpc
Summary: Copy the transferable results from one bundle to another

Parameters
NameLocationTypeDescription

request

body (required)

object

Request for copying a bundle (Schema: #/definitions/server.CopyBundleRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Bundle)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/rpc/delete-attachment-and-results

POST /rpc/delete-attachment-and-results

Description: Delete attachment and results
Consumes: application/json
Produces: application/json
Tags: attachments
Summary: Delete attachment and results

Parameters
NameLocationTypeDescription

request

body (required)

object

Request for deleting attachment and results (Schema: #/definitions/server.DeleteAttachmentRequest)

Responses

  • 204 - No Content

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/rpc/publish-approval-event

POST /rpc/publish-approval-event

Description: Publish an approval event and get the computed approval
Consumes: application/json
Produces: application/json
Tags: rpc
Summary: Publish an approval event and get the computed approval

Parameters
NameLocationTypeDescription

request

body (required)

object

Request for publishing an approval event (Schema: #/definitions/server.ApprovalEventRequest)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.Approval)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

/rpc/submit-result-to-policy

POST /rpc/submit-result-to-policy

Description: Submit a result and get computed policy
Consumes: application/json
Produces: application/json
Tags: rpc
Summary: Submit a result and get computed policy

Parameters
NameLocationTypeDescription

request

body (required)

object

Request for submitting result and computing policy (Schema: #/definitions/server.SubmitResultToPolicy)

Responses

  • 200 - OK (Schema: #/definitions/guardrails.ComputedPolicy)

  • 400 - Bad Request (Schema: #/definitions/server.HTTPError)

  • 403 - Forbidden (Schema: #/definitions/server.HTTPError)

  • 404 - Not Found (Schema: #/definitions/server.HTTPError)

  • 423 - Locked (Schema: #/definitions/server.HTTPError)

  • 500 - Internal Server Error (Schema: #/definitions/server.HTTPError)

Definitions

Below is an overview of the models (definitions) used by the API. Each definition lists its main properties and, when relevant, the type or reference to another model.

guardrails.Approval

Type: object
Properties:
- approvers: array of guardrails.Approver
- bundleId: string
- id: string
- name: string
- stageApproval: guardrails.StageApproval
- stageApprovalId: string
- status: guardrails.ApprovalStatus
- taskId: string
- updatedAt: string
- updatedBy: object (additional properties allowed)

guardrails.ApprovalEventType

Type: string
Enum: RequestSubmitted, RequestCancelled, RequestApproved, RequestRejected

guardrails.ApprovalStatus

Type: string
Enum: PendingSubmission, PendingReview, Approved

guardrails.ApprovalTimelineInfo

Type: object
Properties:
- approvalStatus: guardrails.ApprovalStatus
- timelineStatus: guardrails.ApprovalTimelineStatus
- updatedAt: string

guardrails.ApprovalTimelineStatus

Type: string
Enum: Valid, Invalid

guardrails.Approver

Type: object
Required: id, name
Properties:
- id: string
- isOrganizationUser: boolean
- name: string

guardrails.ArtifactDraft

Type: object
Properties:
- artifactContent: (unspecified)
- artifactId: string
- bundleId: string
- evidenceId: string
- id: string
- updatedAt: string
- userId: string

guardrails.ArtifactResult

Type: object
Properties:
- artifactContent: (unspecified)
- artifactId: string
- bundleId: string
- createdAt: string
- createdBy: object (additional properties allowed)
- evidenceId: string
- id: string
- isLatest: boolean

guardrails.ArtifactType

Type: string
Enum: input, guidance, policyScriptedCheck, metadata

guardrails.Attachment

Type: object
Properties:
- approvalTimelineMap: object (values are guardrails.ApprovalTimelineInfo)
- createdAt: string
- createdBy: object (additional properties allowed)
- id: string
- identifier: object
- type: guardrails.AttachmentType

guardrails.AttachmentType

Type: string
Enum: ModelVersion, Report

Note
 For brevity, not all definitions are expanded here. In your complete AsciiDoc document, you would include each definition (such as guardrails.BulkUpdateFindingRequest, guardrails.Bundle, guardrails.BundleState, guardrails.CommentsInfo, guardrails.ComputedPolicy, and so on) following the same format.

Security Definitions

ApiKeyAuth

Type: apiKey
Name: X-Domino-Api-Key
In: header

BearerAuthentication

Type: apiKey
Name: Authorization
In: header