Developer Hub
Request Demo
Request Demo
Support
  1. Integrations
  • 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)
      • Bulk Entity Finding Rules Download API (Early Access)
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
      • Bulk Filters Download API (Early Access)
      • Bulk Filters Upload API (Early Access)
      • Bulk Findings Download API (Early Access)
      • Bulk Findings Upload API (Early Access)
      • Bulk Labels Download API (Early Access)
      • Bulk Labels Upload API (Early Access)
      • Bulk Privileged Download API (Early Access)
      • Bulk Privileged Upload API (Early Access)
      • Bulk RBAC Download API (Early Access)
      • Bulk RBAC Upload API (Early Access)
      • Bulk RBAC2 Download API (Early Access)
      • Bulk RBAC2 Upload API (Early Access)
      • Bulk Rules Download API (Early Access)
      • Bulk Rules Upload API (Early Access)
    • 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)
        POST
      • Bulk Integrations Upload API (Early Access)
        POST
    • 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. Integrations

Bulk Integrations Download API (Early Access)

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

BalkanID Integrations Download CSV Format#

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

Sample CSV#

ID*Name*DescriptionLast RunStatus*Primary OwnerMessageMetadataReviewer PrecedenceProvisioning OptionsExtraction OptionsReviewer CountEntity Request Values TemplatesEntity Request Values Defaults
1Amazon Web Services2021-07-26T18:00:00Zactivejason.bond@balkan.idData Available[{"name": "Client ID", "key": "client_id", "type": "public", "value": "}, {"name": "Client Secret", "key": "client_secret", "type": "secret", "value": "}, {"name": "Enterprise ID", "key": "enterprise_id", "type": "public", "value": "}]manager, primaryowner, riskmanager{}1
2GoogleCloud computing platforminactive{}manager, primaryowner, riskmanager{}1
3Slack2021-07-26T18:00:00Zactivealec.benjamin@balkan.idData Available{}manager, primaryowner, riskmanager{}{ "scim": false, "upload": true, "direct_configuration": false }1
4Okta2021-07-26T18:00:00Zactive1 error occured{}manager, primaryowner, riskmanager{}1
NOTE: Columns with * are required always.
Column Definitions#
Column NameColumn Description
IDRequired - A unique identifier for the integration. This is the internal balkan id of the integration
NameRequired - The name of the integration. In the sample CSV, this is: Amazon Web Services, Google, etc.
DescriptionOptional - The description of the integration. In the sample CSV, this is: Cloud computing platform, etc.
Last RunOptional - The last time the integration was run. In the sample CSV, this is: 2021-07-26T18:00:00Z, etc.
StatusRequired - The status of the integration. In the sample CSV, this is: active, inactive
Primary OwnerOptional - The primary owner of the integration's email. In the sample CSV, this is: alec.benjamin@balkan.id, jason.bond@balkan.id, etc.
MessageOptional - The message log for the integration sync. In the sample CSV, this is: Data Available, 1 error occured, etc.
MetadataOptional - The metadata of the integration.
Reviewer PrecedenceOptional - The reviewer precedence of the integration.
Provisioning OptionsOptional - The provisioning options of the integration.
Extraction OptionsOptional - The extraction options of the integration.
Reviewer CountOptional - The reviewer count of the integration.
Entity Request Values TemplatesOptional - The entity request values templates of the integration.
Entity Request Values DefaultsOptional - The entity request values defaults of the integration.

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 Relations 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/integrations/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 Entity RBAC Upload API
Next
Bulk Integrations Upload API (Early Access)
Built with