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

Nodes and Clusters API

  • reference
    +
    The REST API permits management of nodes and clusters.

    APIs in this Section

    The REST API provides extensive support of the management of nodes and clusters. Each operation is explained in this section. All endpoints are listed in the tables provided below.

    Cluster Initialization and Provisioning

    HTTP Method URI Documented at

    POST

    /clusterInit

    Initialize a Cluster

    POST

    /nodes/self/controller/settings

    Initializing a Node

    POST

    /settings/web

    Establishing Credentials

    POST

    /node/controller/rename

    Naming a Node

    POST

    /pools/default

    Configuring Memory

    POST

    /node/controller/setupServices

    Assigning Services

    POST

    /pools/default

    Naming a Cluster

    Node Addition and Removal

    HTTP Method URI Documented at

    POST

    /controller/addNode

    Adding Nodes to Clusters

    POST

    /node/controller/doJoinCluster

    Joining Nodes to Clusters

    POST

    /controller/ejectNode

    Removing Nodes from Clusters

    Rebalance

    HTTP Method URI Documented at

    POST

    /controller/rebalance

    Rebalancing the Cluster

    GET

    /pools/default/rebalanceProgress

    Getting Rebalance Progress

    GET

    /pools/default/retryRebalance

    Configuring Rebalance Retries

    POST

    /pools/default/retryRebalance

    Configuring Rebalance Retries

    GET

    /pools/default/pendingRetryRebalance

    Getting Rebalance-Retry Status

    POST

    /controller/cancelRebalanceRetry/<rebalance-id>

    Canceling Rebalance Retries

    GET

    /settings/rebalance

    Limiting Concurrent vBucket Moves

    POST

    /settings/rebalance

    Limiting Concurrent vBucket Moves

    POST

    /internalSettings

    Disabling Consistent View Query Results on Rebalance

    Manual-Failover

    HTTP Method URI Documented at

    POST

    /controller/failOver

    Performing Hard Failover

    POST

    /controller/startGracefulFailover

    Performing Graceful Failover

    POST

    /controller/setRecoveryType

    Setting Recovery Type

    Auto-Failover

    HTTP Method URI Documented at

    GET

    /settings/autoFailover

    Retrieving Auto-Failover Settings

    POST

    /settings/autoFailover

    Enabling and Disabling Auto-Failover

    POST

    /settings/autoFailover/resetCount

    Resetting Auto-Failover

    POST

    /controller/setRecoveryType

    Setting Recovery Type

    Settings and Connections

    HTTP Method URI Documented at

    GET

    /internalSettings

    Managing Internal Settings

    POST

    /internalSettings

    Managing Internal Settings

    GET

    /settings/maxParallelIndexers

    Managing Internal Settings

    POST

    /settings/maxParallelIndexers

    Managing Internal Settings

    GET

    /pools/default/settings/memcached/global

    Managing Cluster Connections

    POST

    /pools/default/settings/memcached/global

    Managing Cluster Connections

    PUT

    /node/controller/setupAlternateAddresses/external

    Managing Alternate Addresses

    DELETE

    /node/controller/setupAlternateAddresses/external

    Managing Alternate Addresses

    GET

    /settings/alerts

    Getting Alert Settings

    POST

    /settings/alerts

    Enabling and Disabling Email Notifications

    POST

    /settings/alerts/sendTestEmail

    Sending Test Emails

    Status and Events

    HTTP Method URI Documented at

    GET

    /pools/default/tasks

    Getting Cluster Tasks

    GET

    /logs/rebalanceReport?reportID=<report-id>

    Getting Cluster Tasks

    GET

    /pools

    Retrieving Cluster Information

    GET

    /pools/default

    Viewing Cluster Details

    GET

    /events

    Getting System Events

    GET

    /eventsStreaming

    Getting System Events

    GET

    /pools/default/terseClusterInfo

    Identifying the Orchestrator Node

    GET

    /pools/nodes

    Getting Information on Nodes

    GET

    /pools/default/nodeServices

    Listing Node Services

    Statistics

    HTTP Method URI Documented at

    GET

    /prometheus_sd_config

    Prometheus Discovery API

    GET

    /pools/default/stats/range/<metric_name>/[function-expression]

    Getting a Single Statistic

    POST

    /pools/default/stats/range

    Getting Multiple Statistics

    Logging

    HTTP Method URI Documented at

    POST

    /controller/startLogsCollection

    Collecting Logs

    POST

    /controller/cancelLogsCollection

    Collecting Logs

    GET

    /pools/default/tasks

    Getting Cluster Tasks

    GET

    /diag

    Retrieving Diagnostic and Log Information

    GET

    /sasl_logs

    Retrieving Diagnostic and Log Information

    POST

    /logClientError

    Logging Client-Side Errors