BalkanID API CLI

BalkanID API CLI is a command line interface that can be installed on any system and provides commands to interact with the BalkanID APIs, both downloading and uploading data.

BalkanID API CLI is NOT publicly available, but can be requested on demand. Please work with your customer support representative to get access to the BalkanID API CLI. The BalkanID API CLI will require BalkanID API key and API Secret that can be downloaded from your BalkanID Web Application tenant. The data format supported by the CLI for upload and download are the same data formats as supported by the BalkanID API and can be found here.

bulk-download-cli --help
Usage:
  bulk-download-cli [command]

Available Commands:
  campaigns           Download campaigns data
  completion          Generate the autocompletion script for the specified shell
  employees           Download employees data
  employees-relations Download employees relations data
  entitlements        Download entitlements data for an integration
  filters             Download filters data
  help                Help about any command
  integrations        Download integrations data
  labels              Download labels data
  requests            Download access requests data
  reviews             Download all reviews
  reviews-by-campaign Download reviews for a campaign
  rules               Download rules data
  findings            Download findings data
  webhook-templates   Download webhook-templates data
  playbook-templates  Download playbook-templates data

Flags:
  -h, --help   help for bulk-download-cli

Use "bulk-download-cli [command] --help" for more information about a command.

bulk-upload-cli --help
Usage:
  bulk-upload-cli [command]

Available Commands:
  campaigns           Upload campaigns data
  completion          Generate the autocompletion script for the specified shell
  employees           Upload employees data
  employees-relations Upload employees relations data
  entitlements        Upload entitlements data for an integration
  filters             Upload filters data
  help                Help about any command
  integrations        Upload integrations data
  labels              Upload labels data
  requests            Upload access requests data
  reviews             Upload all reviews
  reviews-by-campaign Upload reviews for a campaign
  rules               Upload rules data
  findings            Upload findings data
  webhook-templates   Upload webhook-templates data
  playbook-templates  Upload playbook-templates data

Flags:
  -h, --help   help for bulk-upload-cli

Use "bulk-upload-cli [command] --help" for more information about a command.

Example (Campaigns)

Info

> bulk-download-cli campaigns --help
Download campaigns data

Usage:
  bulk-download-cli campaigns [flags]

Flags:
      --api-key string             API Key
  -h, --help                       help for campaigns
      --include-completed string   Include completed campaigns? (y/n)
      --include-draft string       Include draft campaigns? (y/n)
      --secret string              API Key Secret

Running the command

bulk-download-cli campaigns --secret <SECRET> --api-key <API_KEY>
Include completed campaigns? (y/n): y
Include draft campaigns? (y/n): y
Downloading campaigns data...
Download URL: https://<url>

Example (Reviews for Campaign)

> bulk-download-cli reviews --secret <SECRET> --api-key <API_KEY>
Campaign ID: 01HBKKYMCTG5YBCF2F1FXC9YWV
Downloading reviews data...
File is not ready yet. Retrying in 5 seconds...
File is not ready yet. Retrying in 5 seconds...
...
File is not ready yet. Retrying in 5 seconds...
Download URL: