Couchbase

Couchbase Query Settings API

Endpoints for configuring Query service settings at the node and cluster level.

Documentation GitHub OpenAPI

Operations 2

GET /admin/settings Get query service settings #

POST /admin/settings Update query service settings #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/couchbase-query-settings-api"

All apis

curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Couchbase Query Service REST Query Settings API
  description: The Couchbase Query Service REST API enables developers to execute SQL++ (formerly N1QL) queries against Couchbase Server and manage query service settings. It supports ad-hoc queries, prepared statements, and request-level parameter configuration. The API provides endpoints for query execution, monitoring active requests, and managing query service configuration across cluster nodes.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8093
  description: Query Service (default port)
- url: https://localhost:18093
  description: Query Service (SSL)
security:
- basicAuth: []
tags:
- name: Query Settings
  description: Endpoints for configuring Query service settings at the node and cluster level.
paths:
  /admin/settings:
    get:
      operationId: getQuerySettings
      summary: Get query service settings
      description: Returns the current settings for the Query service node, including timeout values, memory quotas, and logging configuration.
      tags:
      - Query Settings
      responses:
        '200':
          description: Successful retrieval of query settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySettings'
        '401':
          description: Unauthorized access
    post:
      operationId: updateQuerySettings
      summary: Update query service settings
      description: Updates the configuration settings for the Query service node.
      tags:
      - Query Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuerySettings'
      responses:
        '200':
          description: Query settings updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySettings'
        '400':
          description: Invalid settings
        '401':
          description: Unauthorized access
components:
  schemas:
    QuerySettings:
      type: object
      description: Query service configuration settings
      properties:
        queryTmpSpaceDir:
          type: string
          description: Directory for temporary query files
        queryTmpSpaceSize:
          type: integer
          description: Maximum temporary space size in megabytes
        queryPipelineBatch:
          type: integer
          description: Number of items in a batch for pipeline execution
        queryPipelineCap:
          type: integer
          description: Maximum number of items in the pipeline queue
        queryScanCap:
          type: integer
          description: Maximum buffer size for index scans
        queryTimeout:
          type: string
          description: Default timeout for queries (e.g., 0s for unlimited)
        queryPreparedLimit:
          type: integer
          description: Maximum number of prepared statements to cache
        queryCompletedLimit:
          type: integer
          description: Maximum number of completed requests to keep
        queryCompletedThreshold:
          type: integer
          description: Minimum execution time in milliseconds for a request to be added to the completed requests log
        queryLogLevel:
          type: string
          description: Log level for the Query service
          enum:
          - debug
          - trace
          - info
          - warn
          - error
          - severe
          - none
        queryMaxParallelism:
          type: integer
          description: Maximum parallelism for query execution
        queryN1QLFeatCtrl:
          type: integer
          description: Feature control flags for N1QL
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Couchbase Server credentials.
externalDocs:
  description: Couchbase Query Service REST API Documentation
  url: https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html