Bulk Entity Finding Rules Download API (Early Access)
POST
https://app.balkan.id/api/rest/v0/entity-finding-rules/download-url
BalkanID Entity Finding Rules
Sample Entity Finding Rule
| brn | entity_filter | name | description | created_at | updated_at |
|---|---|---|---|---|---|
| brn:bid:balkanid:::010000000000000000:app:example | {"key1": "value1", "key2": ["value2", "value3"], "key3": {"nestedKey": "nestedValue"}} | Sample Entity | This is a sample description of the entity | 2024-10-23T10:00:00Z | 2024-10-23T11:00:00Z |
Column Definitions
| Column Name | Column Description |
|---|---|
| ID | Required - A unique identifier for the entity finding rule |
| entity_filter | Required - JSON filter applied to the entity |
| name | Required - Name of the entity |
| description | Optional - Description of the entity |
| created_at | Required - Timestamp when the entity was created |
| updated_at | Required - Timestamp when the entity was last 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
Request Code Samples
Responses
Modified at 2025-04-10 03:44:22