mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-23 20:42:02 +00:00
docs(api): use mintlify for API specs
This commit is contained in:
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "Check Integration Connection"
|
||||
api: "POST /api/v1/integrations/{id}/connection"
|
||||
description: "Try to verify integration connection."
|
||||
---
|
||||
|
||||
Test the connection to an integration to ensure it is configured correctly and can communicate with the external service.
|
||||
|
||||
## Path Parameters
|
||||
|
||||
- `id` (required) - UUID of the integration to test
|
||||
|
||||
## Example Request
|
||||
|
||||
```bash
|
||||
curl -X POST "https://api.prowler.com/api/v1/integrations/{id}/connection" \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/vnd.api+json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
Returns a task object. The connection test is performed asynchronously.
|
||||
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"type": "tasks",
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"attributes": {
|
||||
"inserted_at": "2019-08-24T14:15:22Z",
|
||||
"completed_at": "2019-08-24T14:15:22Z",
|
||||
"name": "string",
|
||||
"state": "available",
|
||||
"result": null,
|
||||
"task_args": null,
|
||||
"metadata": null
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Note>
|
||||
Use the returned task ID to check the connection test status via the Tasks API.
|
||||
</Note>
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Create Integration"
|
||||
api: "POST /api/v1/integrations"
|
||||
description: "Configure a new integration."
|
||||
---
|
||||
|
||||
Add integration with external systems.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Delete Integration"
|
||||
api: "DELETE /api/v1/integrations/{id}"
|
||||
description: "Remove an integration."
|
||||
---
|
||||
|
||||
Delete integration configuration.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Create Jira Dispatch"
|
||||
api: "POST /api/v1/integrations/{id}/jira/dispatches"
|
||||
description: "Send findings to Jira."
|
||||
---
|
||||
|
||||
Dispatch findings to Jira for tracking.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "List Integrations"
|
||||
api: "GET /api/v1/integrations"
|
||||
description: "Retrieve configured integrations."
|
||||
---
|
||||
|
||||
Get all configured integrations (S3, Security Hub, Jira, etc).
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Integration"
|
||||
api: "GET /api/v1/integrations/{id}"
|
||||
description: "Get integration details."
|
||||
---
|
||||
|
||||
Fetch specific integration configuration.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update Integration"
|
||||
api: "PATCH /api/v1/integrations/{id}"
|
||||
description: "Update integration settings."
|
||||
---
|
||||
|
||||
Modify integration configuration.
|
||||
Reference in New Issue
Block a user