Developer Hub
Request Demo
Request Demo
Support
  1. Configuration
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
        POST
      • Bulk Entity Finding Rules Download API (Early Access)
        POST
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
        POST
      • Bulk Filters Download API (Early Access)
        POST
      • Bulk Filters Upload API (Early Access)
        POST
      • Bulk Findings Download API (Early Access)
        POST
      • Bulk Findings Upload API (Early Access)
        POST
      • Bulk Labels Download API (Early Access)
        POST
      • Bulk Labels Upload API (Early Access)
        POST
      • Bulk Privileged Download API (Early Access)
        POST
      • Bulk Privileged Upload API (Early Access)
        POST
      • Bulk RBAC Download API (Early Access)
        POST
      • Bulk RBAC Upload API (Early Access)
        POST
      • Bulk RBAC2 Download API (Early Access)
        POST
      • Bulk RBAC2 Upload API (Early Access)
        POST
      • Bulk Rules Download API (Early Access)
        POST
      • Bulk Rules Upload API (Early Access)
        POST
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Configuration

Bulk Labels Download API (Early Access)

POST
https://app.balkan.id/api/rest/v0/labels/download-url

BalkanID Labels Download CSV Format#

In this section, we will explain the BalkanID Labels CSV format.

Sample CSV#

IDName*ColorIconBackground ColorText ColorType*Light Background ColorLight Text ColorDark Background ColorDark Text Color
entitlement/privilegedPrivilegedsecondaryhttps://example.com/icons/privileged.svg#FFFFFF#000000entitlement#FFFFFF#000000#FFFFFF#000000
employee/sodSoD#FFFFFF#000000employee#FFFFFF#000000#FFFFFF#000000
NOTE: Columns with * are required always.
Column Definitions#
Column NameColumn Description
IDRequired - ID of the label.
NameRequired - The name of the label. It appears in the applications.
TypeRequired - The type of the label, used to identify the type of
IconOptional - The icon of the label. It appears in the applications.
ColorOptional - The color of the label. It appears in the applications.
Background ColorOptional - The background color of the label. It appears in the applications.
Text ColorOptional - The text color of the label. It appears in the applications.
Light Background ColorOptional - The light background color of the label. It appears in the applications.
Light Text ColorOptional - The light text color of the label. It appears in the applications.
Dark Background ColorOptional - The dark background color of the label. It appears in the applications.
Dark Text ColorOptional - The dark text color of the label. It appears in the applications.
Required Columns#
Name and Type is always required.
All other columns are optional.

Download the CSV file via the pre-signed URL#

After retrieving the pre-signed URL in the previous step, all that remains
is to download the CSV in BalkanID Labels CSV
format from 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

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/labels/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
download url response
Body

Example
{
    "pollingUrl": "string",
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Findings Upload API (Early Access)
Next
Bulk Labels Upload API (Early Access)
Built with