Skip to main content

Policies API

Governance policy engine — create, evaluate, and enforce data policies across products.

Endpoints Overview

MethodEndpointDescription
POST/spaces/{slug}/policiesCreate policy
GET/spaces/{slug}/policiesList policies
GET/spaces/{slug}/policies/compliance-summaryCompliance dashboard
GET/spaces/{slug}/policies/templatesList templates
GET/spaces/{slug}/policies/{id}Get policy
PATCH/spaces/{slug}/policies/{id}Update policy
DELETE/spaces/{slug}/policies/{id}Delete policy
POST/spaces/{slug}/policies/{id}/archiveArchive policy
POST/spaces/{slug}/policies/{id}/unarchiveUnarchive policy
POST/spaces/{slug}/policies/{id}/evaluateEvaluate policy
GET/spaces/{slug}/policies/{id}/evaluationsList evaluations
POST/spaces/{slug}/policies/evaluate-allEvaluate all policies
GET/spaces/{slug}/products/{pid}/violationsProduct violations

Create Policy

POST /spaces/{slug}/policies
{
"name": "Documentation Required",
"description": "All products must have a description",
"policy_type": "documentation",
"rule_expression": "product.description IS NOT NULL",
"severity": "high",
"is_enabled": true
}

List Policies

GET /spaces/{slug}/policies

Query Parameters

ParameterTypeDescription
include_archivedbooleanInclude archived policies
policy_typestringFilter by type
is_enabledbooleanFilter by enabled status
skipintegerPagination offset
limitintegerPage size (max 200)

Compliance Summary

GET /spaces/{slug}/policies/compliance-summary

Returns aggregated compliance dashboard data for the space.


Evaluate Policy

POST /spaces/{slug}/policies/{policy_id}/evaluate

Manually triggers evaluation of a policy against all products in the space.


Evaluate All Policies

POST /spaces/{slug}/policies/evaluate-all

Re-evaluates all enabled policies against all products. Returns a summary with total products evaluated and violations found.


List Evaluations

GET /spaces/{slug}/policies/{policy_id}/evaluations

Returns evaluation results with product names and compliance status.


Product Violations

GET /spaces/{slug}/products/{product_id}/violations

Returns active policy violations for a specific product (used for violation banners in the UI).


Error Responses

StatusDescription
404Policy not found
409Policy name already exists