Couchbase

Couchbase Logging API

Endpoints for retrieving Eventing Function application logs.

Documentation GitHub OpenAPI

Documentation

https://docs.couchbase.com/server/current/rest-api/rest-intro.html

https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html

https://docs.couchbase.com/server/current/analytics/rest-analytics.html

https://docs.couchbase.com/server/current/rest-api/rest-fts.html

https://docs.couchbase.com/server/current/eventing/eventing-api.html

https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html

https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html

https://docs.couchbase.com/cloud/management-api-reference/index.html

https://docs.couchbase.com/cloud/app-services/references/rest_api_public.html

https://docs.couchbase.com/cloud/app-services/references/rest_api_admin.html

https://docs.couchbase.com/sync-gateway/current/rest-api.html

https://docs.couchbase.com/sync-gateway/current/rest-api-admin.html

Specifications

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/openapi/couchbase-logging-api-openapi.yml

Other Resources

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/rules/couchbase-server-rules.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/capabilities/couchbase-server-capabilities.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/rules/couchbase-query-rules.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/capabilities/couchbase-query-capabilities.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/rules/couchbase-search-rules.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/capabilities/couchbase-search-capabilities.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/rules/couchbase-capella-management-rules.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/capabilities/couchbase-capella-management-capabilities.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/rules/couchbase-sync-gateway-rules.yml

https://raw.githubusercontent.com/api-evangelist/couchbase/refs/heads/main/capabilities/couchbase-sync-gateway-capabilities.yml

OpenAPI Specification

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Logging API
  description: The Couchbase Analytics Service REST API provides access to the Analytics service for running complex analytical queries on operational data without impacting performance of key-value operations. It supports SQL++ queries for analytics, management of links to external data sources, and configuration of user-defined libraries. The service enables real-time analytics on JSON data alongside transactional workloads.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8095
  description: Analytics Service (default port)
- url: https://localhost:18095
  description: Analytics Service (SSL)
security:
- basicAuth: []
tags:
- name: Logging
  description: Endpoints for retrieving Eventing Function application logs.
paths:
  /api/v1/functions/{functionName}/applog:
    get:
      operationId: getEventingFunctionLog
      summary: Get Eventing Function application log
      description: Returns the most recent application log messages generated by the specified Eventing Function via the log() function in handler code.
      tags:
      - Logging
      parameters:
      - $ref: '#/components/parameters/functionName'
      - name: aggregate
        in: query
        required: false
        description: Whether to aggregate logs from all nodes
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Successful retrieval of application log
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '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 Analytics Service REST API Documentation
  url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html