Couchbase · Schema

DatabaseConfig

Database configuration

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
name string Database name
bucket string Couchbase Server bucket name
sync string JavaScript sync function code
import_filter string JavaScript import filter function code
enable_shared_bucket_access boolean Whether to enable shared bucket access with SDKs
import_docs boolean Whether to auto-import documents from the bucket
num_index_replicas integer Number of GSI index replicas
delta_sync object Delta sync configuration
guest object Guest (unauthenticated) user configuration
View JSON Schema on GitHub

JSON Schema

couchbase-databaseconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DatabaseConfig",
  "title": "DatabaseConfig",
  "type": "object",
  "description": "Database configuration",
  "properties": {
    "name": {
      "type": "string",
      "description": "Database name"
    },
    "bucket": {
      "type": "string",
      "description": "Couchbase Server bucket name"
    },
    "sync": {
      "type": "string",
      "description": "JavaScript sync function code"
    },
    "import_filter": {
      "type": "string",
      "description": "JavaScript import filter function code"
    },
    "enable_shared_bucket_access": {
      "type": "boolean",
      "description": "Whether to enable shared bucket access with SDKs"
    },
    "import_docs": {
      "type": "boolean",
      "description": "Whether to auto-import documents from the bucket"
    },
    "num_index_replicas": {
      "type": "integer",
      "description": "Number of GSI index replicas"
    },
    "delta_sync": {
      "type": "object",
      "description": "Delta sync configuration",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether delta sync is enabled"
        },
        "rev_max_age_seconds": {
          "type": "integer",
          "description": "Maximum age for revision deltas in seconds"
        }
      }
    },
    "guest": {
      "type": "object",
      "description": "Guest (unauthenticated) user configuration",
      "properties": {
        "disabled": {
          "type": "boolean",
          "description": "Whether the guest user is disabled"
        },
        "admin_channels": {
          "type": "array",
          "description": "Admin channels for the guest user",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/couchbase-databaseconfig"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.