Documentation Index

Fetch the complete documentation index at: https://docs.lucidity.cloud/llms.txt

Use this file to discover all available pages before exploring further.

API Guide for Partition Status External

  • Updated on Apr 15, 2026
  • Published on Apr 13, 2026
  • 2 minute(s) read
Prev Next

Partition Status External API

This API fetches the current status of a partition onboarding request for a given instance and mount point.

Note: API support for GCP instances is currently undergoing maintenance. We expect full functionality to be restored shortly.

Overview

This API fetches the current status of a partition onboarding request for a given instance and mount point. It validates cloud identifiers from the request body and authorizes access using the token-derived request context (RequestContext). Clients do not send tenantId.

What does this API do?

It allows clients to programmatically check the lifecycle state of partition creation and onboarding process on a specific cloud instance. By providing the instance details and the mount point, users can track whether the partition is pending, in progress, successfully onboarded, or failed.

Common Use Cases

  • Tracking Onboarding Progress: Monitoring the status of a newly requested partition until it is fully active and onboarded.

  • Automated Error Handling: Identifying if a partition creation failed (PARTITION_STATUS_FAILED) to trigger automated fallback mechanisms or alert operations teams.

Business Value

  • Operational Visibility: Provides clear, real-time programmatic visibility into the storage provisioning lifecycle.

  • Workflow Automation: Enables seamless integration into CI/CD pipelines, automated infrastructure scaling workflows, and custom dashboarding.

Multi-Cloud Support

The Lucidity API provides a unified interface across AWS, Azure, and GCP.

  • AWS: Requires the AWS Account ID (cloudProviderAccountId) and instanceId.

  • Azure: Requires the Subscription ID (cloudProviderAccountId), VM name (instanceId), and the specific resourceGroup.

  • GCP: Requires the GCP Project ID (cloudProviderAccountId) and instanceId.

Lifecycle

  • PARTITION_STATUS_PENDING: Partition creation has been initiated and is waiting to be processed.

  • PARTITION_STATUS_IN_PROGRESS: Partition creation is currently in progress.

  • PARTITION_STATUS_ON_BOARDED: Partition has been successfully created and onboarded.

  • PARTITION_STATUS_FAILED_ONBOARDING: Partition creation or onboarding has failed.

  • PARTITION_STATUS_FAILED: Partition creation has failed.

  • PARTITION_STATUS_UNKNOWN: Partition status is UNKNOWN.

1. Fetch Partition Status

Purpose: Retrieve the current status of a partition onboarding request for a specific instance and mount point.

ENDPOINT: POST /external/client/api/v1/partition/create/status

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

  • Polling Strategy: Implement exponential backoff when polling for the status of a partition (especially when it is in PARTITION_STATUS_PENDING or PARTITION_STATUS_IN_PROGRESS states) to avoid rate-limiting and unnecessary server load.

Cost Optimization

  • Response Caching: Cache status responses temporarily within your application if multiple internal services need to check the status of the same partition simultaneously.

Operational Excellence

  • Failure Logging: Always log the instanceId, mountPoint, and the specific timestamp alongside any PARTITION_STATUS_FAILED or PARTITION_STATUS_FAILED_ONBOARDING responses to accelerate troubleshooting and support requests.

FAQ

General Questions

Q: Do I need to provide a tenant ID in the request? A: No, clients do not send a tenantId. The API authorizes access and derives the tenant context automatically using the short-lived bearer token provided in the headers.

Q: Can I check the status of multiple partitions in a single request? A: Currently, this API endpoint is designed to fetch the status of a single partition per request, identified by its specific mount point (e.g., /dev/sdf or D).

Technical Questions

Q: What HTTP method does this endpoint use? A: This endpoint uses the POST HTTP method, as it requires a JSON request body containing the instance identifiers and partition details.

Q: What happens if my access token is expired or invalid? A: The API will return a 401 Unauthorized HTTP status code. You will need to fetch a new short-lived bearer token and retry the request.

Related articles