mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-30 07:14:20 +00:00
docs(api): use mintlify for API specs
This commit is contained in:
1 parent
f831171a21
commit
77089eba57
136 files changed
+23969
No files matched your search
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Compliance Attributes"
|
||||
api: "GET /api/v1/compliance-overviews/attributes"
|
||||
description: "Get compliance framework attributes."
|
||||
---
|
||||
|
||||
Retrieve detailed attributes for compliance frameworks.
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: "List Compliance Overviews"
|
||||
api: "GET /api/v1/compliance-overviews"
|
||||
description: "Retrieve compliance framework coverage for scans."
|
||||
---
|
||||
|
||||
Get compliance status across frameworks like CIS, PCI-DSS, HIPAA, etc.
|
||||
|
||||
## Query Parameters
|
||||
- `filter[scan]` - Filter by scan UUID (required)
|
||||
- `filter[framework]` - Filter by framework name
|
||||
|
||||
## Example
|
||||
\`\`\`bash
|
||||
curl "https://api.prowler.com/api/v1/compliance-overviews?filter[scan]=scan-uuid" \\
|
||||
-H "Authorization: Bearer YOUR_API_KEY"
|
||||
\`\`\`
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Compliance Metadata"
|
||||
api: "GET /api/v1/compliance-overviews/metadata"
|
||||
description: "Get available compliance frameworks and metadata."
|
||||
---
|
||||
|
||||
Fetch list of available compliance frameworks and their details.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Compliance Requirements"
|
||||
api: "GET /api/v1/compliance-overviews/requirements"
|
||||
description: "Get compliance requirements details."
|
||||
---
|
||||
|
||||
Fetch specific requirements for compliance frameworks.
|
||||
Reference in new issue
Block a user