BLACKSHIELD

Public Guide

Troubleshooting and Platform Limits

Resolve common ingestion, authentication, and throughput issues quickly with a repeatable troubleshooting flow. Audience: Tenant admins, DevOps teams, and scanner operators. Typical setup time: 10-15 minutes.

Before You Begin

  • Collect failing job IDs, timestamps, scanner type, and target context.
  • Confirm API key status and environment variable values used by the scanner.
  • Validate scanner output format before re-running ingestion.

Step-by-step

Step 1

Check authentication and access first

Most ingestion failures are credential or permission issues, so validate those first.

  • Confirm the API key is active, correctly scoped, and not expired.
  • Verify API URL, workspace context, and environment variable values.
  • Confirm user permissions for any UI-triggered actions.

Step 2

Validate payload format and metadata

Malformed payloads and missing metadata often cause ingestion delays or skipped records.

  • Validate scanner output format before submission.
  • Include stable deduplication keys for recurring scans.
  • Use job status details to identify parse, validation, or processing errors.

Step 3

Tune throughput and escalation

Operate within known limits and escalate with complete context when issues persist.

  • Spread large scans over time to avoid ingestion spikes.
  • Use retry with exponential backoff for transient network failures.
  • Escalate recurring failures with workspace ID, job IDs, and timestamps.

Success Checks

  • Root cause category is identified (auth, payload, or throughput).
  • Escalation ticket includes all required diagnostics for fast support triage.
Troubleshooting and Platform Limits | BlackShield Docs