This API enables you to monitor the status of a background job initiated by a user request. To use this API, provide the tracking ID obtained from the Create Namespace API.
The response includes details such as the requestor, the request timestamp, the job end time, the job status, the job type, and additional information based on the status:
-
SUCCESS: Includes the job response.
-
FAILED: Includes an error message describing the failure.
-
IN-PROGRESS or PENDING: Both the response and error message will be null.
The possible job statuses are SUCCESS, IN-PROGRESS, PENDING, or FAILED.
METHOD: GET
ROUTE: /super-admin/namespace/job-status
Headers:
{
“Authorization”: “Bearer <MASTER_API_KEY>”
}
Query params:
tracking_id : “c37c070e-ff34-4738-8c32-de54d4ae26d303122024041354“
Response structure:
{
"data": [
{
"tracking_id": "c37c070e-ff34-4738-8c32-de54d4ae26d303122024041354",
"requested_user": "super_admin",
"requested_timestamp": "2024-12-03 04:13:54",
"process_start_time": "2024-12-03 04:14:18",
"process_end_time": "2024-12-03 04:14:22",
"job_type": "namespace-creation",
"response": {
"message": "Namespace customer_ns_1 created successfully."
},
"error_message": null,
"status": "SUCCESS"
}
],
"success": true,
"error": {
"message": ""
}
}