Bulk Findings Download API (Early Access)
POST
https://app.balkan.id/api/rest/v0/findings/download-url
Configuration
BalkanID Findings Download CSV Format
Sample CSV
| ID | Employee | Identity | Labels | Integration | Name | Description | Value | Metadata | Reason | Rule | Assigned To | Workflow Status | Created At | Updated At | Activity Log |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 01HQQV71BBDVVN5NVQ8Q7X1A3X | john.doe@balkan.id | john.doe@balkan.id | [[{"key": "entitlement/overentitled", "value": {"text": "Overentitled"}, "explanation": null}]] | google/01HQQTMRVQGT0M4ARWR9YN3BP6 | John is Overentitled | John is overentitled on Google, since they haves access to groups that are not usually found with people of their job title. | {} | [] | Test | rule_01ABCD123 | john.doe@balkan.id | started | 2024-02-28T12:32:16.235468Z | 2024-04-30T12:48:04.346933Z | [{"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "accept_risk", "comments": "Dummy comment", "action_type": "default"}]],"Previous Status":","Status":"created","Timestamp":"2024-02-28T12:48:06+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "review", "comments": ", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-02-28T12:44:37+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "playbook", "comments": "Global Request Playbook", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-04-08T17:43:57+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "webhook", "comments": "Global Review Webhook", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-04-08T17:48:49+00:00"}, {"Actor Email":null,"Actor Name":"System","Activity Metadata":null,"Previous Status":"started","Status":"started","Timestamp":"2024-04-30T12:48:04+00:00"}, {"Actor Email":null,"Actor Name":"System","Activity Metadata":null,"Previous Status":null,"Status":"created","Timestamp":"2024-02-28T12:32:16+00:00"}] |
Column Definitions
| Column Name | Column Description |
|---|---|
| ID | Required - A unique identifier for the finding. This is the internal balkan id of the finding |
| Employee | Required - The employee associated with the finding. |
| Identity | Optional - The identity associated with the finding. |
| Labels | Optional - The labels associated with the finding. It is an array of array of label object |
| Integration | Required - The integration associated with the finding. |
| Entity | Required - The entity associated with the finding. |
| Name | Optiona - The name of the finding. |
| Description | Optional - The description of the finding. |
| Value | Optional - The value of the finding. |
| Severity | Optional - The severity of the finding. |
| Rule | Required - The ID of the entity finding rule associated with the finding. |
| Metadata | Optional - The metadata of the finding. |
| Reason | Optional - The reason of the finding. |
| Assigned To | Required - The user to whom the finding is assigned. |
| Workflow Status | Required - The status of the finding. |
| Created At | Required - The timestamp when the finding was created. |
| Updated At | Required - The timestamp when the finding was updated. |
Download the CSV file via the pre-signed URL
To use the polling URL, first send an HTTP request with the method
HEAD to the pollingUrl.If the response status code is
404, the file is not ready, and you should retry this polling request after a delay.If the response status code is
200, the file is ready, and you may proceed to download the CSV from the received url.Request
Header Params
X-Api-Key-ID
string
optional
X-Api-Key-Secret
string
optional
Content-Type
string
optional
Default:
application/json
Body Params application/json