Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Analytics Settings REST API

    March 23, 2025
    + 12

    Overview

    The Analytics Settings REST API is provided by the Analytics service. This API enables you to view or set cluster-level Analytics settings.

    The API schemes and host URLs are as follows:

    where node is the host name or IP address of a node running the Analytics service. (Note that the port numbers for this REST API are different to the port numbers used by the other Analytics REST APIs.)

    Version information

    Version : 7.1

    Consumes

    • application/x-www-form-urlencoded

    Produces

    • application/json

    Paths

    This section describes the operations available with this REST API.

    View Analytics Settings

    GET /settings/analytics

    Description

    Retrieves cluster-level Analytics settings. Note that only one setting is available: numReplicas.

    You can also retrieve the number of Analytic replicas using the Couchbase Web Console or the CLI. For further details about Analytics replicas, refer to Rebalance and Hard Failover.

    Responses

    HTTP Code Description Schema

    200

    The operation was successful.

    Settings

    401

    Unauthorized. The user name or password may be incorrect.

    object

    Security

    Type Name

    basic

    Cluster Read / Pools Read

    Example HTTP request

    The example below retrieves the current number of Analytics replicas.

    Curl request
    sh
    Copy
    curl -X GET -u Administrator:password \
http://localhost:8091/settings/analytics

    Example HTTP response

    Response 200
    json
    Copy
    {"numReplicas": 1}

    Modify Analytics Settings

    POST /settings/analytics

    Description

    Sets cluster-level Analytics settings. Note that only one setting is available: numReplicas.

    You can also set the number of Analytic replicas using the Couchbase Web Console or the CLI. For further details about Analytics replicas, refer to Rebalance and Hard Failover.

    A rebalance is required for a new numReplicas value to take effect.

    Parameters

    Type Name Description Schema

    FormData

    numReplicas
    optional

    Specifies the number of replicas for Analytics.

    integer

    Responses

    HTTP Code Description Schema

    200

    The operation was successful.

    Settings

    400

    Bad request. A parameter has an incorrect value.

    object

    401

    Unauthorized. The user name or password may be incorrect.

    object

    Security

    Type Name

    basic

    Cluster Read / Pools Read

    Example HTTP request

    The example below changes the current number of Analytics replicas to 2.

    Curl request
    sh
    Copy
    curl -X POST -u Administrator:password \
http://localhost:8091/settings/analytics \
-d numReplicas=2

    Example HTTP response

    Response 200
    json
    Copy
    {"numReplicas": 2}

    Definitions

    This section describes the properties returned by this REST API.

    Settings

    Name Description Schema

    numReplicas
    required

    Specifies the number of replicas for Analytics.
    Minimum value : 0
    Maximum value : 3
    Example : 3

    integer

    Security

    Cluster Read / Pools Read

    The Analytics Settings REST API supports HTTP basic authentication. Credentials can be passed via HTTP headers.

    Users must have one of the following RBAC roles:

    • Full Admin

    • Cluster Admin

    • Read-Only Admin

    • Analytics Admin

    Refer to Roles for more details.

    Type : basic