docs(api): use mintlify for API specs

This commit is contained in:
pedrooot
2025-10-30 18:58:05 +01:00
parent f831171a21
commit 77089eba57
136 changed files with 23969 additions and 0 deletions
@@ -0,0 +1,7 @@
---
title: "Add Providers to Group"
api: "POST /api/v1/provider-groups/{id}/relationships/providers"
description: "Add providers to a group."
---
Associate providers with a provider group.
@@ -0,0 +1,20 @@
---
title: "Create Provider Group"
api: "POST /api/v1/provider-groups"
description: "Create a new provider group."
---
Create a group to organize multiple providers together.
## Request Body
\`\`\`json
{
"data": {
"type": "provider-groups",
"attributes": {
"name": "Production Providers",
"description": "All production cloud accounts"
}
}
}
\`\`\`
@@ -0,0 +1,7 @@
---
title: "Delete Provider Group"
api: "DELETE /api/v1/provider-groups/{id}"
description: "Remove a provider group."
---
Delete a provider group. Providers in the group are not deleted.
@@ -0,0 +1,17 @@
---
title: "List Provider Groups"
api: "GET /api/v1/provider-groups"
description: "Retrieve provider groups for organizing providers."
---
Get all provider groups used to organize and manage multiple providers.
## Query Parameters
- `filter[name]` - Filter by group name
- `page[number]`, `page[size]` - Pagination
## Example
\`\`\`bash
curl "https://api.prowler.com/api/v1/provider-groups" \\
-H "Authorization: Bearer YOUR_API_KEY"
\`\`\`
@@ -0,0 +1,7 @@
---
title: "Remove Providers from Group"
api: "DELETE /api/v1/provider-groups/{id}/relationships/providers"
description: "Remove providers from group."
---
Disassociate providers from a provider group.
@@ -0,0 +1,7 @@
---
title: "Retrieve Provider Group"
api: "GET /api/v1/provider-groups/{id}"
description: "Get provider group details."
---
Fetch information about a specific provider group.
@@ -0,0 +1,7 @@
---
title: "Update Group Providers"
api: "PATCH /api/v1/provider-groups/{id}/relationships/providers"
description: "Update providers in group."
---
Modify the list of providers in a group.
@@ -0,0 +1,7 @@
---
title: "Update Provider Group"
api: "PATCH /api/v1/provider-groups/{id}"
description: "Update provider group."
---
Modify provider group name or description.