Black Cat API reference (beta)

GET /access-reviews

List access-review campaigns

Requires permission: access_reviews:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.ReviewCampaign[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /access-reviews/{id}

Get an access-review campaign

Requires permission: access_reviews:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  closed_at	string	No
  created_at	string	No
  created_by	string	No
  created_by_email	string	No
  due_at	string	No
  id	string	No
  last_reminder_at	string	No
  launched_at	string	No
  name	string	No
  report_id	string	No
  scope_connector_ids	string[]	No
  scope_type	entity.ReviewScopeType	No
  status	entity.ReviewCampaignStatus	No
  tenant_id	string	No
  updated_at	string	No
  version	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /access-reviews/{id}/grants

List reviewer grants

Requires permission: access_reviews:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  campaign_id	string	No
  connector_id	string	No
  created_at	string	No
  expires_at	string	No
  id	string	No
  last_accessed_at	string	No
  reviewer_email	string	No
  revoked_at	string	No
  sign_off_statement	string	No
  signed_off_at	string	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /access-reviews/{id}/items

List access-review items

Requires permission: access_reviews:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.ReviewItem[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /access-reviews/{id}/progress

Get access-review campaign progress

Requires permission: access_reviews:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  decided_items	integer	No
  flagged_items	integer	No
  grants	entity.ReviewGrantProgress[]	No
  revoke_items	integer	No
  total_items	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /agent-governance-rules

List agent governance rules

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.AgentGovernanceRule[]	No
  total	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /agent-governance-rules

Create an agent governance rule

Requires permission: ai_governance:write

Request body (request.CreateAgentGovernanceRuleRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  cooldown_hours	integer	No
  created_at	string	No
  description	string	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_msg	string	No
  name	string	No
  playbook_id	string	No
  tenant_id	string	No
  updated_at	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agent-governance-rules/{id}

Get an agent governance rule

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  cooldown_hours	integer	No
  created_at	string	No
  description	string	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_msg	string	No
  name	string	No
  playbook_id	string	No
  tenant_id	string	No
  updated_at	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /agent-governance-rules/{id}

Update an agent governance rule

Requires permission: ai_governance:write

Parameters

Request body (request.UpdateAgentGovernanceRuleRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

DELETE /agent-governance-rules/{id}

Delete an agent governance rule

Requires permission: ai_governance:write

Parameters

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /agent-governance-rules/{id}/test

Test an agent governance rule

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  matched_agents	entity.AgentGovernanceRuleTestMatch[]	No
  total_matched	integer	No
  would_fire	integer	No
  would_skip	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agents

List AI agents

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.AIAgent[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /agents/batch-owner

Assign an owner to several AI agents

Requires permission: ai_governance:write

Request body (request.BatchUpdateAgentOwnerRequest)

Responses

• 200 — OK

  Name	Type	Required	Description
  updated	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /agents/batch-status

Update the status of several AI agents

Requires permission: ai_governance:write

Request body (request.BatchUpdateAgentStatusRequest)

Responses

• 200 — OK

  Name	Type	Required	Description
  updated	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agents/summary

Get AI agent summary

Requires permission: ai_governance:read

Responses

• 200 — OK

  Name	Type	Required	Description
  approved	integer	No
  blocked	integer	No
  critical	integer	No
  needs_review	integer	No
  orphaned	integer	No
  total	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agents/{id}

Get an AI agent

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  agent_created_at	string	No
  agent_type	entity.AIAgentType	No
  ai_review_item_id	string	No
  approval_status	entity.AIReviewStatus	No
  autonomy_level	entity.AutonomyLevel	No
  blast_radius	entity.BlastRadius	No
  capabilities	entity.AgentCapability[]	No
  connector_id	string	No
  created_at	string	No
  created_by	string	No
  data_scopes	entity.AgentDataScope[]	No
  description	string	No
  finding_ids	string[]	No
  first_seen_at	string	No
  id	string	No
  last_active_at	string	No
  last_remediated_at	string	No	LastRemediatedAt is a computed field populated when include=last_remediated is requested.
  last_seen_at	string	No
  name	string	No
  owner_active	boolean	No
  owner_email	string	No
  owner_id	string	No
  permissions	entity.AgentPermission[]	No
  platform	entity.AIAgentPlatform	No
  platform_id	string	No
  publisher	string	No
  resource_ids	string[]	No
  risk_confidence	entity.RiskConfidence	No
  risk_factors	entity.AgentRiskFactor[]	No
  risk_score	integer	No
  stale_at	string	No
  tenant_id	string	No
  third_party_app_id	string	No
  tool_bindings	entity.AgentToolBinding[]	No
  updated_at	string	No
  version	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /agents/{id}/owner

Assign an AI agent owner

Requires permission: ai_governance:write

Parameters

Request body (request.UpdateAgentOwnerRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agents/{id}/permissions

Get AI agent permissions

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  capabilities	entity.AgentCapability[]	No
  data_scopes	entity.AgentDataScope[]	No
  permissions	entity.AgentPermission[]	No
  tool_bindings	entity.AgentToolBinding[]	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /agents/{id}/revocation-guide

Get an AI agent revocation guide

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  actions	entity.RevocationAction[]	No
  admin_portal	string	No
  docs_url	string	No
  platform	entity.AIAgentPlatform	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /agents/{id}/status

Update an AI agent status

Requires permission: ai_governance:write

Parameters

Request body (request.UpdateAgentStatusRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /ai-governance/items

List AI review items

Requires permission: ai_governance:read

Parameters

Responses

• 200 — paged list of AI review items
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /ai-governance/items

Create an AI review item

Requires permission: ai_governance:write

Request body (request.CreateAIReviewItemRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  aging_days	integer	No
  archived_at	string	No
  changed_since_review	boolean	No
  created_at	string	No
  decision_reason	string	No
  evidence	object	No
  evidence_hash	string	No
  first_seen_at	string	No
  id	string	No
  last_seen_at	string	No
  object_type	entity.AIReviewObjectType	No
  owner_email	string	No
  owner_id	string	No
  priority_reasons	string[]	No
  priority_score	integer	No
  provider	string	No
  reviewed_at	string	No
  reviewed_by	string	No
  source_connector_id	string	No
  source_finding_id	string	No
  source_id	string	No
  source_type	entity.AIReviewSourceType	No
  stale_at	string	No
  status	entity.AIReviewStatus	No
  subtitle	string	No
  tenant_id	string	No
  title	string	No
  updated_at	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /ai-governance/items/batch-owner

Assign an owner to several AI review items

Requires permission: ai_governance:write

Request body (request.BatchUpdateAIReviewOwnerRequest)

Responses

• 200 — OK

  Name	Type	Required	Description
  errors	entity.BatchError[]	No
  skipped	integer	No
  updated	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /ai-governance/items/batch-status

Update the status of several AI review items

Requires permission: ai_governance:write

Request body (request.BatchUpdateAIReviewStatusRequest)

Responses

• 200 — OK

  Name	Type	Required	Description
  errors	entity.BatchError[]	No
  skipped	integer	No
  updated	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /ai-governance/items/{id}

Get an AI review item

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  aging_days	integer	No
  archived_at	string	No
  changed_since_review	boolean	No
  created_at	string	No
  decision_reason	string	No
  evidence	object	No
  evidence_hash	string	No
  first_seen_at	string	No
  id	string	No
  last_seen_at	string	No
  object_type	entity.AIReviewObjectType	No
  owner_email	string	No
  owner_id	string	No
  priority_reasons	string[]	No
  priority_score	integer	No
  provider	string	No
  reviewed_at	string	No
  reviewed_by	string	No
  source_connector_id	string	No
  source_finding_id	string	No
  source_id	string	No
  source_type	entity.AIReviewSourceType	No
  stale_at	string	No
  status	entity.AIReviewStatus	No
  subtitle	string	No
  tenant_id	string	No
  title	string	No
  updated_at	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /ai-governance/items/{id}/evidence

Get AI review evidence

Requires permission: ai_governance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  decisions	entity.AIReviewDecision[]	No
  item	entity.AIReviewItem	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /ai-governance/items/{id}/owner

Assign an AI review item owner

Requires permission: ai_governance:write

Parameters

Request body (request.UpdateAIReviewOwnerRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /ai-governance/items/{id}/restore

Restore an archived AI review item

Requires permission: ai_governance:write

Parameters

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /ai-governance/items/{id}/status

Update an AI review item status

Requires permission: ai_governance:write

Parameters

Request body (request.UpdateAIReviewStatusRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /ai-governance/summary

Get AI governance summary

Requires permission: ai_governance:read

Responses

• 200 — OK

  Name	Type	Required	Description
  approved	integer	No
  blocked	integer	No
  critical_high	integer	No
  needs_review	integer	No
  new_this_week	integer	No
  overdue	integer	No
  stale	integer	No
  unknown_owner	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /alert-rules

List alert rules

Requires permission: alert_rules:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  connector_ids	string[]	No
  created_at	string	No
  deliver_email	boolean	No
  deliver_slack	boolean	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  mode	entity.AlertRuleMode	No
  name	string	No
  policy_categories	string[]	No
  severity_threshold	entity.Severity	No
  tenant_id	string	No
  threshold_days	integer	No
  trigger_events	entity.ScanAlertEvent[]	No	TriggerEvents constrains which scan lifecycle events activate this rule. An empty slice fires on completion events only (scan_completed and scan_completed_with_warnings); non-completion events such as drift_detected require explicit opt-in by listing them here. Stored in alert_rules.trigger_events.
  updated_at	string	No
  version	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alert-rules

Create an alert rule

Requires permission: alert_rules:write

Request body (request.CreateAlertRuleRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  connector_ids	string[]	No
  created_at	string	No
  deliver_email	boolean	No
  deliver_slack	boolean	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  mode	entity.AlertRuleMode	No
  name	string	No
  policy_categories	string[]	No
  severity_threshold	entity.Severity	No
  tenant_id	string	No
  threshold_days	integer	No
  trigger_events	entity.ScanAlertEvent[]	No	TriggerEvents constrains which scan lifecycle events activate this rule. An empty slice fires on completion events only (scan_completed and scan_completed_with_warnings); non-completion events such as drift_detected require explicit opt-in by listing them here. Stored in alert_rules.trigger_events.
  updated_at	string	No
  version	integer	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /alert-rules/{id}

Get an alert rule

Requires permission: alert_rules:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  connector_ids	string[]	No
  created_at	string	No
  deliver_email	boolean	No
  deliver_slack	boolean	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  mode	entity.AlertRuleMode	No
  name	string	No
  policy_categories	string[]	No
  severity_threshold	entity.Severity	No
  tenant_id	string	No
  threshold_days	integer	No
  trigger_events	entity.ScanAlertEvent[]	No	TriggerEvents constrains which scan lifecycle events activate this rule. An empty slice fires on completion events only (scan_completed and scan_completed_with_warnings); non-completion events such as drift_detected require explicit opt-in by listing them here. Stored in alert_rules.trigger_events.
  updated_at	string	No
  version	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /alert-rules/{id}

Update an alert rule

Requires permission: alert_rules:write

Parameters

Request body (request.UpdateAlertRuleRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

DELETE /alert-rules/{id}

Delete an alert rule

Requires permission: alert_rules:write

Parameters

Responses

• 204 — No Content
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alert-rules/{id}/test

Test an alert rule

Requires permission: alert_rules:write

Parameters

Responses

• 204 — No Content
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /alerts

List alerts

Requires permission: alert_rules:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.Alert[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alerts/bulk-acknowledge

Bulk acknowledge alerts

Requires permission: alert_rules:write

Request body (request.BulkAlertRequest)

Responses

• 200 — OK
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alerts/bulk-resolve

Bulk resolve alerts

Requires permission: alert_rules:write

Request body (request.BulkAlertRequest)

Responses

• 200 — OK
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /alerts/count

Count alerts by status

Requires permission: alert_rules:read

Responses

• 200 — OK

  Name	Type	Required	Description
  acknowledged	integer	No
  open	integer	No
  resolved	integer	No
  snoozed	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /alerts/{id}

Get an alert

Requires permission: alert_rules:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  acknowledged_at	string	No
  acknowledged_by	string	No
  alert_rule_id	string	No
  connector_id	string	No
  connector_name	string	No
  connector_type	entity.ConnectorType	No
  created_at	string	No
  exception_id	string	No
  finding_count	integer	No
  id	string	No
  resolved_at	string	No
  resolved_by	string	No
  scan_id	string	No
  severity	entity.Severity	No
  severity_counts	entity.SeverityCounts	No
  snooze_mode	entity.SnoozeMode	No
  snoozed_until	string	No
  status	entity.AlertStatus	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alerts/{id}/acknowledge

Acknowledge an alert

Requires permission: alert_rules:write

Parameters

Responses

• 200 — OK
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alerts/{id}/resolve

Resolve an alert

Requires permission: alert_rules:write

Parameters

Responses

• 200 — OK
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /alerts/{id}/snooze

Snooze an alert

Requires permission: alert_rules:write

Parameters

Request body (request.SnoozeAlertRequest)

Responses

• 200 — OK
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /app-governance-rules

List app governance rules

Requires permission: third_party_apps:read

Responses

• 200 — OK

  Name	Type	Required	Description
  action	string	No
  auto_create_finding	boolean	No
  create_ai_review_item	boolean	No
  created_at	string	No
  created_by	string	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  match_type	string	No
  match_value	string	No
  name	string	No
  notify_channels	string[]	No
  notify_on_discovery	boolean	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /app-governance-rules

Create an app governance rule

Requires permission: third_party_apps:write

Request body (request.CreateAppGovernanceRuleRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  action	string	No
  auto_create_finding	boolean	No
  create_ai_review_item	boolean	No
  created_at	string	No
  created_by	string	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  match_type	string	No
  match_value	string	No
  name	string	No
  notify_channels	string[]	No
  notify_on_discovery	boolean	No
  tenant_id	string	No
  updated_at	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /app-governance-rules/{id}

Get an app governance rule

Requires permission: third_party_apps:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  action	string	No
  auto_create_finding	boolean	No
  create_ai_review_item	boolean	No
  created_at	string	No
  created_by	string	No
  enabled	boolean	No
  expression	string	No
  id	string	No
  last_error_at	string	No
  last_error_message	string	No
  match_type	string	No
  match_value	string	No
  name	string	No
  notify_channels	string[]	No
  notify_on_discovery	boolean	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

PUT /app-governance-rules/{id}

Update an app governance rule

Requires permission: third_party_apps:write

Parameters

Request body (request.UpdateAppGovernanceRuleRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

DELETE /app-governance-rules/{id}

Delete an app governance rule

Requires permission: third_party_apps:write

Parameters

Responses

• 204 — No Content
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /approval-chains

List approval chains

Requires permission: exceptions:read

Responses

• 200 — OK

  Name	Type	Required	Description
  created_at	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  priority	integer	No
  request_type	string	No
  severity_filter	string[]	No
  steps	entity.ApprovalStep[]	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /approval-chains/match

Match approval chain

Requires permission: exceptions:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  created_at	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  priority	integer	No
  request_type	string	No
  severity_filter	string[]	No
  steps	entity.ApprovalStep[]	No
  tenant_id	string	No
  updated_at	string	No

• 204 — No matching chain
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /approval-chains/{id}

Get an approval chain

Requires permission: exceptions:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  created_at	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  priority	integer	No
  request_type	string	No
  severity_filter	string[]	No
  steps	entity.ApprovalStep[]	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /audit-log

List audit events

Requires permission: audit_log:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.AuditEvent[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /audit-log/export

Create audit log export

Requires permission: audit_log:read

Request body (request.CreateAuditExport)

Responses

• 201 — Created

  Name	Type	Required	Description
  created_at	string	No
  error	string	No
  event_count	integer	No
  expires_at	string	No
  file_name	string	No
  file_size	integer	No
  filters	entity.AuditExportFilter	No
  id	string	No
  status	entity.AuditExportStatus	No
  tenant_id	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /audit-log/export/{id}

Get audit export status

Requires permission: audit_log:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  created_at	string	No
  error	string	No
  event_count	integer	No
  expires_at	string	No
  file_name	string	No
  file_size	integer	No
  filters	entity.AuditExportFilter	No
  id	string	No
  status	entity.AuditExportStatus	No
  tenant_id	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /audit-log/export/{id}/download

Download audit export

Requires permission: audit_log:read

Parameters

Responses

• 200 — OK
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /campaigns

List remediation campaigns

Requires permission: findings:read

Responses

• 200 — OK

  Name	Type	Required	Description
  affected_connectors	string[]	No
  aggregate_severity	entity.Severity	No
  category	string	No
  description	string	No
  drifted_count	integer	No
  estimated_minutes	integer	No
  finding_count	integer	No
  open_count	integer	No
  progress_pct	number	No
  recommended_steps	entity.CampaignStep[]	No
  regression_count	integer	No
  resolved_count	integer	No
  title	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /campaigns/{category}

Get a remediation campaign

Requires permission: findings:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  affected_connectors	string[]	No
  aggregate_severity	entity.Severity	No
  category	string	No
  description	string	No
  drifted_count	integer	No
  estimated_minutes	integer	No
  finding_count	integer	No
  open_count	integer	No
  progress_pct	number	No
  recommended_steps	entity.CampaignStep[]	No
  regression_count	integer	No
  resolved_count	integer	No
  title	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /canonical-apps

List canonical apps (Vendors)

Requires permission: third_party_apps:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  data	entity.CanonicalAppRollup[]	No
  pagination	entity.PaginationMeta	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /canonical-apps/merge-candidates

List pending merge candidates

Requires permission: third_party_apps:read

Responses

• 200 — OK

  Name	Type	Required	Description
  cluster_key	string	No
  confidence	string	No
  created_at	string	No
  id	string	No
  members	response.MergeCandidateMemberView[]	No
  signal	string	No
  status	string	No
  target_canonical_id	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /canonical-apps/{id}

Get a canonical app (Vendor detail)

Requires permission: third_party_apps:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  connectors	string[]	No	Connectors is the deduped union of member connector types.
  display_name	string	No
  id	string	No
  members	response.CanonicalAppDetailMember[]	No
  reach_unavailable_sources	integer	No	ReachUnavailableSources is the number of member connectors that do not report users (github, box, slack, teams, servicenow, ...). When > 0 the UI must render "reach unavailable for N source(s)" rather than "0 users".
  scopes	string[]	No	Scopes is the deduped union of OAuth scopes across all members.
  source	string	No
  user_reach	integer	No	UserReach is the deduped count of distinct users over members from user-reporting connectors only (workspace, m365, okta, dropbox).
  vendor_key	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /compliance/controls/{id}

Get a compliance control

Requires permission: compliance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  children	entity.ComplianceControl[]	No
  control_id	string	No
  description	string	No
  framework_id	string	No
  id	string	No
  mapping_overridden	boolean	No	MappingOverridden is true when the caller's tenant has overridden this built-in control's policy mapping (omitted otherwise).
  name	string	No
  parent_id	string	No
  policy_ids	string[]	No
  sort_order	integer	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

PUT /compliance/controls/{id}

Update a control in a custom framework

Requires permission: compliance:write

Parameters

Request body (request.UpdateControlRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

DELETE /compliance/controls/{id}

Delete a control from a custom framework

Requires permission: compliance:write

Parameters

Responses

• 204 — No Content
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /compliance/controls/{id}/attestation

Get a control attestation

Requires permission: compliance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  attested_at	string	No
  attested_by	string	No
  control_code	string	No
  control_db_id	string	No
  created_at	string	No
  evidence_file_name	string	No
  evidence_file_size	integer	No
  expires_at	string	No
  framework_id	string	No
  framework_name	string	No
  id	string	No
  last_reminder_at	string	No
  owner_email	string	No
  review_cadence_days	integer	No
  statement	string	No
  status	string	No
  tenant_id	string	No
  updated_at	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /compliance/controls/{id}/attestation/evidence

Download attestation evidence

Requires permission: compliance:read

Parameters

Responses

• 200 — OK
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

PUT /compliance/controls/{id}/policies

Set control policies

Requires permission: compliance:write

Parameters

Request body (request.SetControlPoliciesRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

DELETE /compliance/controls/{id}/policies

Reset control policies

Requires permission: compliance:write

Parameters

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /compliance/enriched-summary

Get enriched compliance summary

Requires permission: compliance:read

Responses

• 200 — OK

  Name	Type	Required	Description
  attested	integer	No
  audit_date	string	No
  blocking_controls	entity.ControlStub[]	No
  days_until_audit	integer	No
  domains	entity.ControlPosture[]	No
  failed_controls	integer	No
  framework_id	string	No
  framework_name	string	No
  not_assessed	integer	No
  overall_score	number	No	nil when no control is assessed (no-data ≠ 0)
  passed_controls	integer	No
  recent_wins	entity.ControlStub[]	No
  stale_evidence_count	integer	No
  total_controls	integer	No
  trend_direction	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

GET /compliance/frameworks

List compliance frameworks

Requires permission: compliance:read

Responses

• 200 — OK

  Name	Type	Required	Description
  audit_date	string	No	Target audit date; drives DaysUntilAudit on enriched summary
  created_at	string	No
  description	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  tenant_id	string	No	Owning tenant (nil = global/seeded)
  updated_at	string	No
  version	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.
• 500 — Internal Server Error

POST /compliance/frameworks

Create a custom compliance framework

Requires permission: compliance:write

Request body (request.CreateFrameworkRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  audit_date	string	No	Target audit date; drives DaysUntilAudit on enriched summary
  created_at	string	No
  description	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  tenant_id	string	No	Owning tenant (nil = global/seeded)
  updated_at	string	No
  version	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 409 — Conflict
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

GET /compliance/frameworks/{id}

Get a compliance framework

Requires permission: compliance:read

Parameters

Responses

• 200 — OK

  Name	Type	Required	Description
  audit_date	string	No	Target audit date; drives DaysUntilAudit on enriched summary
  created_at	string	No
  description	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  tenant_id	string	No	Owning tenant (nil = global/seeded)
  updated_at	string	No
  version	string	No

• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

PUT /compliance/frameworks/{id}

Update a custom compliance framework

Requires permission: compliance:write

Parameters

Request body (request.UpdateFrameworkRequest)

Responses

• 204 — No Content
• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

DELETE /compliance/frameworks/{id}

Delete a custom compliance framework

Requires permission: compliance:write

Parameters

Responses

• 204 — No Content
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

POST /compliance/frameworks/{id}/clone

Clone a compliance framework

Requires permission: compliance:write

Parameters

Request body (request.CloneFrameworkRequest)

Responses

• 201 — Created

  Name	Type	Required	Description
  audit_date	string	No	Target audit date; drives DaysUntilAudit on enriched summary
  created_at	string	No
  description	string	No
  enabled	boolean	No
  id	string	No
  name	string	No
  tenant_id	string	No	Owning tenant (nil = global/seeded)
  updated_at	string	No
  version	string	No

• 400 — Bad Request
• 401 — Authentication failed: the API key is missing, malformed, unknown, revoked or expired.
• 403 — Forbidden. The code field says why: insufficient_permissions (the key lacks the permission named in x-api-key-permission), api_key_not_allowed (API keys cannot call this endpoint), plan_limit (the tenant's plan does not include API keys, and the body has no limit_type; or the request hit a feature or usage limit of the plan, which limit_type names), tenant_suspended (the tenant is suspended), ip_not_allowed (the key is restricted to certain IP addresses and this request came from another one). An endpoint may name other codes in its description.
• 404 — Not Found
• 409 — Conflict
• 429 — Too many requests for this API key. Wait the number of seconds in the Retry-After header, then retry.

POST /compliance/frameworks/{id}/controls

Create a control in a custom framework

Requires permission: compliance:write

Parameters

Request body (request.CreateControlRequest)

Responses