GET /v1/checks

List Available Checks

Summary

List all runnable DFM checks

Description

Returns a list of all available DFM checks with their descriptions and metadata. Useful for building UI and documentation.

Request Example

curl -X GET "http://127.0.0.1:8000/api/v1/checks" \
  -H "Authorization: Bearer asap_dev_change_me"

Response Example

[
  {
    "id": "min_trace_width",
    "name": "Minimum Trace Width",
    "description": "Checks if trace widths meet minimum manufacturing requirements",
    "severity": "error",
    "category": "fabrication"
  },
  {
    "id": "min_hole_size",
    "name": "Minimum Hole Size", 
    "description": "Validates that drilled holes meet minimum size requirements",
    "severity": "error",
    "category": "fabrication"
  }
]

Error Codes

This endpoint may return the following error codes:

Code Status Meaning
missing_auth 401 No Authorization header provided
invalid_api_key 403 API key is invalid or missing

Authentication

This endpoint requires Bearer token authentication:

Authorization: Bearer YOUR_API_KEY