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: "Create Daily Schedule"
|
||||
api: "POST /api/v1/schedules/daily"
|
||||
description: "Schedule daily scans."
|
||||
---
|
||||
|
||||
Configure recurring daily scan schedule.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Configure Daily Scan Schedule"
|
||||
api: "POST /api/v1/schedules/daily"
|
||||
description: "Configure automated daily scanning for providers."
|
||||
---
|
||||
|
||||
Set up automated daily scans for your cloud providers.
|
||||
|
||||
## Request Body
|
||||
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"type": "schedules",
|
||||
"attributes": {
|
||||
"enabled": true,
|
||||
"time": "02:00",
|
||||
"timezone": "UTC",
|
||||
"providers": ["provider-uuid-1", "provider-uuid-2"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example Request
|
||||
|
||||
```bash
|
||||
curl -X POST "https://api.prowler.com/api/v1/schedules/daily" \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/vnd.api+json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
Returns the configured schedule.
|
||||
|
||||
<Note>
|
||||
Scans will run automatically at the specified time in the configured timezone.
|
||||
</Note>
|
||||
Reference in new issue
Block a user