Collections
Nebula collections SDK operations.
GET /v2/collections/{collection_id}
/v2/collections/{collection_id}Public Nebula SDK contract for collections.get.
PATCH /v2/collections/{collection_id}
/v2/collections/{collection_id}Public Nebula SDK contract for collections.update.
DELETE /v2/collections/{collection_id}
/v2/collections/{collection_id}Public Nebula SDK contract for collections.delete.
GET /v2/collections/{collection_id}/warm
/v2/collections/{collection_id}/warmPOST prepares the receiving replica when no serving pool is configured, returning scope=replica and omitting generation, expires_at_ms and status_url. This local work is request-bound and provides no replica affinity or retention lease; GET and DELETE return 404. With a serving pool, POST establishes durable intent, returning scope=pool and optionally waiting up to wait_ms; caller cancellation does not revoke accepted intent. Both POST modes return 202; only prepared sets ready=true. Pool preparation covers all live serving process incarnations at the observation point. Joining readers must prepare active current-placement leases; failed or obsolete leases report ready=false without blocking admission. Expiry releases warm retention. Publication freshness and search authority remain enforced. Preparation readiness alone does not guarantee a query latency or completeness result.
Path Parameters
Responses
booleanPreparation is complete for the reported scope at observation time. Replica scope carries no fleet or retention guarantee.
POST /v2/collections/{collection_id}/warm
/v2/collections/{collection_id}/warmPOST prepares the receiving replica when no serving pool is configured, returning scope=replica and omitting generation, expires_at_ms and status_url. This local work is request-bound and provides no replica affinity or retention lease; GET and DELETE return 404. With a serving pool, POST establishes durable intent, returning scope=pool and optionally waiting up to wait_ms; caller cancellation does not revoke accepted intent. Both POST modes return 202; only prepared sets ready=true. Pool preparation covers all live serving process incarnations at the observation point. Joining readers must prepare active current-placement leases; failed or obsolete leases report ready=false without blocking admission. Expiry releases warm retention. Publication freshness and search authority remain enforced. Preparation readiness alone does not guarantee a query latency or completeness result.
Path Parameters
Query Parameters
Responses
booleanPreparation is complete for the reported scope at observation time. Replica scope carries no fleet or retention guarantee.
DELETE /v2/collections/{collection_id}/warm
/v2/collections/{collection_id}/warmPOST prepares the receiving replica when no serving pool is configured, returning scope=replica and omitting generation, expires_at_ms and status_url. This local work is request-bound and provides no replica affinity or retention lease; GET and DELETE return 404. With a serving pool, POST establishes durable intent, returning scope=pool and optionally waiting up to wait_ms; caller cancellation does not revoke accepted intent. Both POST modes return 202; only prepared sets ready=true. Pool preparation covers all live serving process incarnations at the observation point. Joining readers must prepare active current-placement leases; failed or obsolete leases report ready=false without blocking admission. Expiry releases warm retention. Publication freshness and search authority remain enforced. Preparation readiness alone does not guarantee a query latency or completeness result.
Path Parameters
Responses
booleanPreparation is complete for the reported scope at observation time. Replica scope carries no fleet or retention guarantee.
GET /v2/workspaces/{workspace_id}/collections
/v2/workspaces/{workspace_id}/collectionsList accessible collections. A bounded scan can return a short or empty page with a next_cursor. Continue until next_cursor is null; page length is not a total count. Each page reevaluates current access.
Path Parameters
Query Parameters
string·min 1·max 512Opaque encrypted continuation cursor, bound to the principal, workspace and group filter. Expires after 15 minutes. A short or empty page may have a next_cursor; only a null cursor means exhaustion. Changing limit is safe.
Responses
POST /v2/workspaces/{workspace_id}/collections
/v2/workspaces/{workspace_id}/collectionsPublic Nebula SDK contract for collections.create.