DocsAPI ReferenceRelease Notes
API Reference
BigPanda AppRequest DemoBigPanda UniversityBigPanda Community

Retrieve Mapping Table Job Status

get https://api.bigpanda.io/resources/v2.1/alert-enrichments-jobs/

Retrieves the status of a previous enrichment change

🚧

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the User API Key type of Authorization token.

Sample Calls

curl --request GET \
     --url https://api.bigpanda.io/resources/v2.1/alert-enrichments-jobs/{job_id} \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'accept: application/json'

curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.1/alert-enrichments-jobs/{job_id} \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'accept: application/json'

Usage

When uploading or updating a mapping enrichment table, a job is created to track the potentially long-running process.

When performing actions that use jobs, follow these steps:

  1. Make a request (for example, upload a mapping enrichment table).
    The associated Job object is created and a URL for checking the status is returned.
  2. Use the URL to periodically check the job status until it is set to done or failed.
  3. If the job was not successful, you can retry the request.
    If necessary, debug any connectivity issues or data formatting issues that may have contributed to the failed upload. For example, ensure the CSV file follows the enrichment schema definition.
Language