A newer version of this documentation is available.

View Latest

Retrieve GSI Settings

  • reference
    +
    To retrieve the global secondary index settings use GET /settings/indexes.

    Description

    This endpoint returns the current index settings for the cluster.

    HTTP Method and URI

    GET http://<host>:8091/settings/indexes

    Response Codes

    Response Code Description

    200

    Success.

    401

    Unauthorized.

    Sample Curl Command

    The following example retrieves the global secondary index settings of the cluster that the node localhost is a part of.

    curl -X GET -u 'Administrator:password' 'http://localhost:8091/settings/indexes'

    Sample Response

    200
    {
        "indexerThreads": 0,
        "logLevel": "info",
        "maxRollbackPoints": 5,
        "memorySnapshotInterval": 200,
        "stableSnapshotInterval": 5000,
        "storageMode": "forestdb"
    }
    401

    This response code returns an empty body.