API Reference

Auto-generated by scripts/generate_api_docs.py on 2026-10-08T01:21:49+00:00.

OpenAPI Endpoints

• Title: actsense - Workflow Security Auditor
• Version: 1.0.0
• OpenAPI JSON: GET /openapi.json
• Swagger UI: GET /docs
• ReDoc: GET /redoc

Endpoints

GET /api/analyses

Summary: List Analyses Operation ID: list_analyses_api_analyses_get

List all saved analyses.

Parameters

Responses

GET /api/analyses/{analysis_id}

Summary: Get Analysis Operation ID: get_analysis_api_analyses__analysis_id__get

Get a specific analysis by ID.

Parameters

Responses

DELETE /api/analyses/{analysis_id}

Summary: Delete Analysis Operation ID: delete_analysis_api_analyses__analysis_id__delete

Delete an analysis by ID.

Parameters

Responses

POST /api/analyses/{analysis_id}/dismissals

Summary: Dismiss Issue Operation ID: dismiss_issue_api_analyses__analysis_id__dismissals_post

Dismiss a finding for this analysis’s target; returns the updated analysis.

Parameters

Request Body

• Required: yes
• application/json: DismissRequest

Responses

DELETE /api/analyses/{analysis_id}/dismissals/{fingerprint}

Summary: Restore Issue Operation ID: restore_issue_api_analyses__analysis_id__dismissals__fingerprint__delete

Undo a dismissal; returns the updated analysis.

Parameters

Responses

POST /api/audit

Summary: Audit Operation ID: audit_api_audit_post

Audit a repository or action.

Request Body

• Required: yes
• application/json: AuditRequest

Responses

POST /api/audit/fix

Summary: Audit Fix Operation ID: audit_fix_api_audit_fix_post

Audit YAML and return issues with concrete auto-fix suggestions.

Request Body

• Required: yes
• application/json: AuditYAMLRequest

Responses

POST /api/audit/org

Summary: Audit Org Operation ID: audit_org_api_audit_org_post

Scan selected repositories of an organization.

Request Body

• Required: yes
• application/json: OrgScanRequest

Responses

POST /api/audit/org/stream

Summary: Audit Org Stream Operation ID: audit_org_stream_api_audit_org_stream_post

Scan selected repositories of an organization, streaming per-repository progress.

Request Body

• Required: yes
• application/json: OrgScanRequest

Responses

POST /api/audit/stream

Summary: Audit Stream Operation ID: audit_stream_api_audit_stream_post

Audit with Server-Sent Events for real-time progress.

Request Body

• Required: yes
• application/json: AuditRequest

Responses

POST /api/audit/yaml

Summary: Audit Yaml Operation ID: audit_yaml_api_audit_yaml_post

Audit a raw YAML workflow file.

Request Body

• Required: yes
• application/json: AuditYAMLRequest

Responses

GET /api/dismissals

Summary: List Dismissals Operation ID: list_dismissals_api_dismissals_get

Dismissed findings for a repository or action.

Parameters

Responses

GET /api/health

Summary: Health Operation ID: health_api_health_get

Health check endpoint.

Responses

GET /api/org-scans

Summary: List Org Scans Operation ID: list_org_scans_api_org_scans_get

List saved org scans.

Parameters

Responses

GET /api/org-scans/{scan_id}

Summary: Get Org Scan Operation ID: get_org_scan_api_org_scans__scan_id__get

An org scan, with each repository’s counts refreshed from its stored analysis.

Refreshing picks up findings dismissed after the scan ran.

Parameters

Responses

DELETE /api/org-scans/{scan_id}

Summary: Delete Org Scan Operation ID: delete_org_scan_api_org_scans__scan_id__delete

Delete an org scan summary (per-repository analyses are kept).

Parameters

Responses

GET /api/org-scans/{scan_id}/findings

Summary: Get Org Scan Findings Operation ID: get_org_scan_findings_api_org_scans__scan_id__findings_get

Every finding and workflow file across an org scan’s repositories, with links to where each lives.

Read from the stored per-repository analyses, so current dismissals apply.

Parameters

Responses

GET /api/orgs/{owner}/repos

Summary: List Org Repositories Operation ID: list_org_repositories_api_orgs__owner__repos_get

Repositories of an organization (or user) to choose from for an org scan.

The token travels in the X-GitHub-Token header so it never lands in URLs or logs.

Parameters

Responses

GET /{full_path}

Summary: Serve Frontend Operation ID: serve_frontend__full_path__get

Serve frontend for all non-API routes.

Parameters

Responses

Schemas

AuditRequest

• Type: object
• Description: No description.

AuditYAMLRequest

• Type: object
• Description: No description.

DismissRequest

• Type: object
• Description: No description.

HTTPValidationError

• Type: object
• Description: No description.

OrgScanRequest

• Type: object
• Description: No description.

ValidationError

• Type: object
• Description: No description.