StorageConfigRead

Fields

Data & storage configuration returned to the client. Infrastructure connection details are masked to prevent credential/topology disclosure.

13 fields

active_collection_prefix: string or null
chroma_collection · required: string
chroma_host · required: string
chroma_port · required: integer
collection_prefix: string
collection_prefix_note: string or null
minio_bucket_name · required: string
minio_endpoint · required: string
minio_use_ssl · required: boolean
mongo_connected · required: boolean
postgres_connected · required: boolean
redis_connected · required: boolean
storage_backend · required: string

Raw schema (JSON)

{
  "description": "Data & storage configuration returned to the client.\nInfrastructure connection details are masked to prevent credential/topology disclosure.",
  "properties": {
    "active_collection_prefix": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Active Collection Prefix"
    },
    "chroma_collection": {
      "title": "Chroma Collection",
      "type": "string"
    },
    "chroma_host": {
      "title": "Chroma Host",
      "type": "string"
    },
    "chroma_port": {
      "title": "Chroma Port",
      "type": "integer"
    },
    "collection_prefix": {
      "default": "",
      "title": "Collection Prefix",
      "type": "string"
    },
    "collection_prefix_note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Collection Prefix Note"
    },
    "minio_bucket_name": {
      "title": "Minio Bucket Name",
      "type": "string"
    },
    "minio_endpoint": {
      "title": "Minio Endpoint",
      "type": "string"
    },
    "minio_use_ssl": {
      "title": "Minio Use Ssl",
      "type": "boolean"
    },
    "mongo_connected": {
      "title": "Mongo Connected",
      "type": "boolean"
    },
    "postgres_connected": {
      "title": "Postgres Connected",
      "type": "boolean"
    },
    "redis_connected": {
      "title": "Redis Connected",
      "type": "boolean"
    },
    "storage_backend": {
      "title": "Storage Backend",
      "type": "string"
    }
  },
  "required": [
    "storage_backend",
    "postgres_connected",
    "mongo_connected",
    "redis_connected",
    "minio_endpoint",
    "minio_bucket_name",
    "minio_use_ssl",
    "chroma_host",
    "chroma_port",
    "chroma_collection"
  ],
  "title": "StorageConfigRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/settings/storage — Get Storage Config
PUT /api/v1/settings/storage — Update Storage Config

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON