Couchbase Configuration API

Endpoints for configuring Eventing Service settings.

Operations 2

GET /api/v1/config Get Eventing Service configuration #
POST /api/v1/config Update Eventing Service configuration #

Documentation

Specifications

Other Resources

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-configuration-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.

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

OpenAPI Specification

couchbase-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Couchbase Eventing Service REST Configuration API
  description: The Couchbase Eventing Service REST API provides methods for deploying and managing Eventing Functions that respond to data changes in real time. Eventing Functions allow developers to write server-side JavaScript logic triggered by document mutations, timers, or external events. The API supports creating, deploying, pausing, and undeploying functions, as well as monitoring their execution status and statistics.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8096
  description: Eventing Service (default port)
- url: https://localhost:18096
  description: Eventing Service (SSL)
security:
- basicAuth: []
tags:
- name: Configuration
  description: Endpoints for configuring Eventing Service settings.
paths:
  /api/v1/config:
    get:
      operationId: getEventingConfig
      summary: Get Eventing Service configuration
      description: Returns the current configuration settings for the Eventing Service.
      tags:
      - Configuration
      responses:
        '200':
          description: Successful retrieval of Eventing configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventingConfig'
        '401':
          description: Unauthorized access
    post:
      operationId: updateEventingConfig
      summary: Update Eventing Service configuration
      description: Updates the configuration settings for the Eventing Service.
      tags:
      - Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventingConfig'
      responses:
        '200':
          description: Configuration updated successfully
        '400':
          description: Invalid configuration
        '401':
          description: Unauthorized access
components:
  schemas:
    EventingConfig:
      type: object
      description: Eventing Service configuration
      properties:
        enable_debugger:
          type: boolean
          description: Whether the debugger is enabled
        ram_quota:
          type: integer
          description: RAM quota for the Eventing service in megabytes
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Couchbase Server credentials.
externalDocs:
  description: Couchbase Eventing Service REST API Documentation
  url: https://docs.couchbase.com/server/current/eventing/eventing-api.html