Outside the DarkShield GUI

 

Next Steps
DarkShield GUI Data Classification PII Discovery File Masking NoSQL DB Masking RDB Masking CLI & API Specs DarkShield Audit Logs

DarkShield PII searching and masking jobs configured in IRI Workbench can be run from outside IRI Workbench. You can use the new search/mask job wizards in the IRI Workbench GUI for DarkShield to export and leverage the same job specifications for execution on the command line or through the DarkShield API. Running DarkShield jobs configured in IRI Workbench externally allows those jobs to be scheduled and triggered automatically, with no need for Workbench to be open.

The DarkShield Command-Line Interface (CLI) facility can be used to run or automate DarkShield jobs from batch programs, job schedulers, CI/CD pipelines, and other applications that can make a system call. The CLI operates on the ".dsc" job configuration files produced in IRI Workbench, which are generated through the wizards in the DarkShield menu described in the three prior tabs (for File, NoSQL DB and RDB masking) in this section.



As of DarkShield V5, there are also four DarkShield RPC APIs for searching and masking data in various types of sources: base (for text), files (for documents and images), NoSQL (for NoSQL DBs), and RDB (for relational DBs). In V6, a restful single endpoint API is now also available.

And just as you can use IRI Workbench PII searching and masking wizards for DarkShield to produce CLI job specifications, you can also export the search and mask contexts defined in Workbench wizards for use in DarkShield API calls.

The ‘Export Job Specs to API Context Files’ wizard facilitates this by writing JSON files containing those contexts to a specified target folder. Custom programs (in any language) that make DarkShield API calls can use those contexts in bespoke applications that require PII discovery and/or de-identification services.



Frequently Asked Questions (FAQs)

1. What is the DarkShield CLI and API feature?
The DarkShield CLI and API feature allows you to run PII search and masking jobs created in IRI Workbench outside of the GUI. You can use the command line or make API calls to execute jobs, making it easier to automate and integrate DarkShield into your existing workflows.
2. How does the DarkShield CLI work?
The DarkShield Command-Line Interface runs jobs based on the .dsc job configuration files created in IRI Workbench. These files are generated using the job wizards in the DarkShield GUI and can be executed from batch programs, job schedulers, CI/CD pipelines, or any application capable of making system calls.
3. What kinds of jobs can I run through the CLI?
You can run the same jobs you configure in Workbench, including file masking, NoSQL DB masking, and relational database masking jobs. This ensures consistent job execution across your local and automated environments.
4. How can I use the DarkShield API?
DarkShield APIs allow you to programmatically trigger search and mask operations. You can export job specifications from IRI Workbench as JSON context files, which your custom programs can call through DarkShield’s RPC or REST APIs.
5. What types of APIs does DarkShield provide?
DarkShield includes four RPC APIs for searching and masking data in specific source types: base (for text), files (for documents and images), NoSQL (for NoSQL DBs), and RDB (for relational DBs). Version 6 has a RESTful single-endpoint API for even simpler integration.
6. Can I schedule jobs without opening Workbench?
Yes. Once you export the job specifications, you can schedule and run them automatically through CLI commands, CI/CD pipelines, or system schedulers. This allows you to enforce regular PII discovery and masking without manual intervention.
7. What are API context files and why are they important?
API context files are JSON files that store the search and mask configurations you created in IRI Workbench. They allow your custom programs to use the same rules and data classes, ensuring consistent and deterministic results across different environments.
8. How does this feature improve automation?
By enabling CLI and API execution, DarkShield makes it easy to integrate PII protection into enterprise workflows, DevOps processes, and compliance pipelines. This reduces manual effort and ensures ongoing data security.
9. Can I run CLI and API jobs on-premise or in the cloud?
Yes. DarkShield jobs can be executed in any environment where the DarkShield engine is deployed, whether on-premise, in a virtual machine, or within a cloud container that you control.
10. How do CLI and API jobs help with compliance?
Running jobs automatically ensures that sensitive data is discovered and masked on a regular basis, helping you maintain compliance with GDPR, CPRA, HIPAA, PIPEDA, POPI, and other data privacy regulations without manual delays.
Share this page

Request More Information

Live Chat

* indicates a required field.
IRI does NOT share your information.