Vaults

Update vault settings

Changed on

Update vault settings including name, description, and group membership.

patch/vault/{id}

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/vault/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Vault ID to update

Request body

namestring

New name for the vault

descriptionstring nullable

New description for the vault. Set to null to remove.

groupIdstring nullable

Move the vault to a different group, or set to null to remove from its current group.

Response

Vault updated successfully

idstring

Vault identifier

namestring

Vault name

descriptionstring nullable

Vault description

filesBucketstring

S3 bucket for document storage

vectorBucketstring nullable

S3 bucket for vector embeddings

indexNamestring

Search index name

regionstring

AWS region

kmsKeyIdstring

KMS key for encryption

chunkStrategyobject

Document chunking strategy configuration

totalObjectsinteger

Number of stored documents

totalBytesinteger

Total storage size in bytes

totalVectorsinteger

Number of vector embeddings

metadataobject

Additional vault metadata

createdAtstring date-time

Vault creation timestamp

updatedAtstring date-time

Last update timestamp

Changes

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status