indexKey is optional in v0.17: SDK-supplied indexes (provider: none) must pass the exact 32-byte key used at creation, while KMS-backed indexes omit it — the service resolves the KEK via the stored KMSBlob.
Parameters
In v0.17
indexKey is optional. KMS-backed indexes (created with KmsName) omit it — the server resolves the DEK via the persisted KMSBlob. SDK-supplied indexes must re-supply the same 32-byte key here.Returns
Exceptions
Error
Error
- Returns error if the index doesn’t exist on the server
- Returns error if the encryption key is incorrect or invalid
- Returns error from the server if a KMS-backed index’s slot is unavailable
- Returns error if the server returns an HTTP error status
- Returns error if authentication fails (invalid API key)
Service Errors
Service Errors
- Throws if the CyborgDB service is unavailable or unreachable.
- Throws if there are internal server errors on the CyborgDB service.