Couchbase

Couchbase Lifecycle API

Endpoints for deploying, undeploying, pausing, and resuming Eventing Functions.

Documentation GitHub OpenAPI

Operations 4

POST /api/v1/functions/{functionName}/deploy Deploy an Eventing Function #

POST /api/v1/functions/{functionName}/undeploy Undeploy an Eventing Function #

POST /api/v1/functions/{functionName}/pause Pause an Eventing Function #

POST /api/v1/functions/{functionName}/resume Resume an Eventing Function #

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-lifecycle-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 Eventing Service REST Lifecycle 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: Lifecycle
  description: Endpoints for deploying, undeploying, pausing, and resuming Eventing Functions.
paths:
  /api/v1/functions/{functionName}/deploy:
    post:
      operationId: deployEventingFunction
      summary: Deploy an Eventing Function
      description: Deploys an undeployed Eventing Function, starting it to process document mutations and execute its handler code.
      tags:
      - Lifecycle
      parameters:
      - $ref: '#/components/parameters/functionName'
      responses:
        '200':
          description: Function deployment initiated
        '401':
          description: Unauthorized access
        '404':
          description: Function not found
  /api/v1/functions/{functionName}/undeploy:
    post:
      operationId: undeployEventingFunction
      summary: Undeploy an Eventing Function
      description: Undeploys a deployed Eventing Function, stopping it from processing document mutations.
      tags:
      - Lifecycle
      parameters:
      - $ref: '#/components/parameters/functionName'
      responses:
        '200':
          description: Function undeployment initiated
        '401':
          description: Unauthorized access
        '404':
          description: Function not found
  /api/v1/functions/{functionName}/pause:
    post:
      operationId: pauseEventingFunction
      summary: Pause an Eventing Function
      description: Pauses a deployed Eventing Function and creates a DCP checkpoint so that on a subsequent resume no mutations will be lost.
      tags:
      - Lifecycle
      parameters:
      - $ref: '#/components/parameters/functionName'
      responses:
        '200':
          description: Function paused successfully
        '401':
          description: Unauthorized access
        '404':
          description: Function not found
  /api/v1/functions/{functionName}/resume:
    post:
      operationId: resumeEventingFunction
      summary: Resume an Eventing Function
      description: Resumes a paused Eventing Function from its DCP checkpoint, continuing to process mutations from where it left off.
      tags:
      - Lifecycle
      parameters:
      - $ref: '#/components/parameters/functionName'
      responses:
        '200':
          description: Function resumed successfully
        '401':
          description: Unauthorized access
        '404':
          description: Function not found
components:
  parameters:
    functionName:
      name: functionName
      in: path
      required: true
      description: The name of the Eventing Function
      schema:
        type: string
  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