API Name: Get Job Info (Onboard Status) API
Track and monitor the execution status of your bulk scheduled onboarding operations.
API support for GCP instances is currently undergoing maintenance. We expect full functionality to be restored shortly
Overview
This API is used to fetch the current status of a scheduled job created using the Create Bulk Schedule API. By providing the jobId received during schedule creation, you can monitor the progress of specific instances and their respective mount points.
What does this API do? Lucidity's Get Job Info API allows you to programmatically query the real-time execution state of your bulk onboarding requests. It provides granular visibility, breaking down the status not just by the overall job, but down to the individual instance and specific mount points involved in the operation.
Common Use Cases
Asynchronous Monitoring: Poll the API to check the progress of scheduled onboard jobs to trigger subsequent automation steps upon completion.
Granular Tracking: Track the exact migration percentage and status of specific mount points (e.g., drive "D" vs. drive "E").
Error Remediation: Quickly identify specific instances or mount points that failed to onboard by inspecting the failureReason.
Business Value
Visibility: Gain real-time, granular insights into your fleet-wide disk onboarding progress.
Reliability: Programmatically verify that all scheduled mount points successfully transitioned to a managed state.
Automation: Enable CI/CD pipelines to wait for definitive job confirmation before proceeding with other infrastructure tasks.
Multi-Cloud Support The Lucidity API provides a unified interface across AWS, Azure, and GCP. The status tracking relies on the unique jobId generated during the schedule request, completely abstracting the underlying cloud provider's specifics.
Lifecycle
Onboarding Scheduled: Job is queued and waiting for its start time/reboot window.
Queued for onboarding: The scheduled timet window has arrived, and the job or specific mount point is currently in the active queue waiting for compute resources to begin the onboarding process.
In Progress: Migration and onboarding are actively running (track migrationPercentageCompletion).
Onboarded : The initial setup and attachment to the management platform are finished, and the system is performing final validations before marking the mount point as fully "Completed."
Completed: Mount point successfully onboarded.
Failed: Onboarding encountered an error (Check failureReason).
Cancelled: The scheduled onboarding job or the operation for a specific mount point was manually cancelled by a user or an automated process before it could finish
Rescheduled: The original Scheduled timefor the job is modified.
1. Fetch Job Information Purpose: Retrieve the current execution status and granular details of a scheduled job.
ENDPOINT: GET /external/client/api/v1/job?jobId={jobId}
Best Practices
Security
Never log or commit API tokens to version control.
Use secure credential storage (vaults, secret managers)
Rotate access tokens regularly, as they are short-lived.
Use HTTPS only for all API communications.
Performance & Reliability
Implement exponential backoff: When polling for job status, avoid overwhelming the endpoint; use escalating delays between requests.
Parse granularly: Ensure your automation scripts iterate through both instanceInfoExternalResponseList and the nested mountPointInfoExternalResponseList to catch individual disk failures.
Cost Optimization
Stop polling upon completion: Terminate your polling loops immediately once all mount points reach a terminal state (Completed or Failed) to save resources.
Operational Excellence
Log failure reasons: Always capture and log the failureReason field if it is not null, ensuring your operations team has the context needed to troubleshoot.
Handle data types correctly: Ensure the jobId is passed as a Long data type to avoid 400 Bad Request errors.
FAQ
General Questions
Q: Where do I get the jobId? A: The jobId is returned in the success response of the Create Bulk Schedule API when you first initiate the job.
Q: Does this API show progress for each disk separately? A: Yes, the response includes a nested mountPointInfoExternalResponseList which provides the status, failure reason, and migration percentage for each individual mount point.
Technical Questions
Q: What HTTP method does this endpoint use? A: It uses a GET request, with the job identifier passed as a URL query parameter (e.g., ?jobId=12345).
Q: Will I get a 404 if the job is finished? A: No, you will receive a 200 OK with the final terminal status of the job and its respective mount points.