BigID API/Scan Payload Tutorial: Difference between revisions
From BigID Developer Portal
No edit summary |
|||
| Line 6: | Line 6: | ||
{{Box/end}} | {{Box/end}} | ||
BigID can connect to hundreds of different data sources. Writing your own [[:connectors]] opens your system to scan anything. However, if you want to just scan a single piece of information, writing your own connector could be time intensive. The scan payload | BigID can connect to hundreds of different data sources. Writing your own [[:connectors]] opens your system to scan anything. However, if you want to just scan a single piece of information, writing your own connector could be time intensive. The scan payload API allows you to scan single payloads of data into your system without a connector. | ||
== Enabling the Scan Payload API == | == Enabling the Scan Payload API == | ||
Because the scan payload API allows your BigID system to scan arbitrary pieces of data, it requires an environment variable to be set. | Because the scan payload API allows your BigID system to scan arbitrary pieces of data, it requires an environment variable to be set. | ||
Revision as of 15:29, 10 March 2022
In this article, you'll learn:
- When the scan payload API can be helpful
- How to send data to the payload API
- Where to view the results from a scan payload
BigID can connect to hundreds of different data sources. Writing your own connectors opens your system to scan anything. However, if you want to just scan a single piece of information, writing your own connector could be time intensive. The scan payload API allows you to scan single payloads of data into your system without a connector.
Enabling the Scan Payload API
Because the scan payload API allows your BigID system to scan arbitrary pieces of data, it requires an environment variable to be set.