After enabling and configuring an External API from within Compliance for Confluence, you can send a test payload to your API to verify its response. If you have not yet configured your API, please refer to Using an External API for Data Detection.
To send a test payload:
Click ⚙️ > Compliance Configuration.
Navigate to the Detection page using the toolbar on the left and click the External API tab.
Click the Test External API button at the bottom. This will open a dialog from which you can send a test request.
On the left side a test request is displayed that mimics those sent during a real Sensitive Data Scan.
content field can be modified. For instance, input "my-secret-key" if it's known sensitive data your API should detect. This helps ensure your API will appropriately detect and respond during actual scans. During a real sensitive data scan the
content field will contain the body of the page being scanned.
On the right side your API’s response is shown. For instance, if your API detects sensitive data,
isDetected will be true and
detectedText will list the detected items.
Running the Test
contentfield as necessary.
Click Send Test Payload to dispatch the request to your API.
Observe your API’s response.
Understanding the Response
You can check the
detectedText fields of your API’s response to verify it successfully detected any sensitive data you entered in the
content field of the request.
Similarly, you can verify that
false and the
detectedText list is empty when no sensitive data was entered.
Sending a test payload also verifies if your API is responding in the expected format. If Compliance fails to parse the response from your API, it will display a warning message.
For example, forgetting to include a required field in your response, such as the
status field, would look like:
Or, if your API does not return JSON:
If your API returns requests that evaluate to “Completed with problems” or “Failed” during a real sensitive data scan, then the page related to that response will fail to scan. As such, please ensure your API is consistently returning successful responses before running a scan.
Need support? We’re here to help 🧡
If you have any questions or would like to speak with us about Compliance, please don’t hesitate to reach out to our Customer Support team.