HTTP method and URI

To retrieve information for a single bucket associated with a cluster, provide the name of a specific bucket.

GET /pools/default/buckets/[bucket-name]

The main REST API bucket endpoint, /pools/default/buckets/[bucket-name], ends with the bucket name. Clients MUST use the server list from the bucket, not the pool to indicate the appropriate servers to connect to.

Syntax

Curl request syntax:

curl -u [admin]:[password] 
    http://[localhost]:8091/pools/default/buckets/[bucket-name]

To get information about the default bucket, replace [bucket-name] with default:

curl -u [admin]:[password] 
    http://[localhost]:8091/pools/default/buckets/default

Example

Curl request example:

curl -u Administrator:password 
    http://10.5.2.117:8091/pools/default/buckets/test2

Response

Couchbase Server returns a large JSON document with bucket information.

{
    "authType": "sasl", 
    "autoCompactionSettings": {
        "allowedTimePeriod": {
            "abortOutside": true, 
            "fromHour": 1, 
            "fromMinute": 0, 
            "toHour": 2, 
            "toMinute": 0
        }, 
        "databaseFragmentationThreshold": {
            "percentage": 30, 
            "size": "undefined"
        }, 
        "parallelDBAndViewCompaction": true, 
        "viewFragmentationThreshold": {
            "percentage": 30, 
            "size": "undefined"
        }
    }, 
    "basicStats": {
        "dataUsed": 16824320, 
        "diskFetches": 0, 
        "diskUsed": 18068198, 
        "itemCount": 0, 
        "memUsed": 33948168, 
        "opsPerSec": 0, 
        "quotaPercentUsed": 12.64667809009552
    }, 
    "bucketCapabilities": [
        "cbhello", 
        "touch", 
        "couchapi", 
        "cccp", 
        "xdcrCheckpointing", 
        "nodesExt"
    ], 
    "bucketCapabilitiesVer": "", 
    "bucketType": "membase", 
    "controllers": {
        "compactAll": "/pools/default/buckets/test2/controller/compactBucket", 
        "compactDB": "/pools/default/buckets/default/controller/compactDatabases", 
        "purgeDeletes": "/pools/default/buckets/test2/controller/unsafePurgeBucket", 
        "startRecovery": "/pools/default/buckets/test2/controller/startRecovery"
    }, 
    "ddocs": {
        "uri": "/pools/default/buckets/test2/ddocs"
    }, 
    "evictionPolicy": "valueOnly", 
    "fastWarmupSettings": false, 
    "localRandomKeyUri": "/pools/default/buckets/test2/localRandomKey", 
    "name": "test2", 
    "nodeLocator": "vbucket", 
    "nodes": [
        {
            "clusterCompatibility": 196608, 
            "clusterMembership": "active", 
            "couchApiBase": "http://10.5.2.117:8092/test2%2B19e3c64824c22f9ad5604a15f856999d", 
            "couchApiBaseHTTPS": "https://10.5.2.117:18092/test2%2B19e3c64824c22f9ad5604a15f856999d", 
            "hostname": "10.5.2.117:8091", 
            "interestingStats": {
                "cmd_get": 0, 
                "couch_docs_actual_disk_size": 34907800, 
                "couch_docs_data_size": 33648640, 
                "couch_views_actual_disk_size": 0, 
                "couch_views_data_size": 0, 
                "curr_items": 0, 
                "curr_items_tot": 0, 
                "ep_bg_fetched": 0, 
                "get_hits": 0, 
                "mem_used": 66961824, 
                "ops": 0, 
                "vb_replica_curr_items": 0
            }, 
            "mcdMemoryAllocated": 3159, 
            "mcdMemoryReserved": 3159, 
            "memoryFree": 2912423936, 
            "memoryTotal": 4140740608, 
            "os": "x86_64-unknown-linux-gnu", 
            "otpNode": "[email protected]", 
            "ports": {
                "direct": 11210, 
                "httpsCAPI": 18092, 
                "httpsMgmt": 18091, 
                "proxy": 11211, 
                "sslProxy": 11214
            }, 
            "recoveryType": "none", 
            "replication": 0, 
            "status": "healthy", 
            "systemStats": {
                "cpu_utilization_rate": 1, 
                "mem_free": 2912423936, 
                "mem_total": 4140740608, 
                "swap_total": 6140452864, 
                "swap_used": 0
            }, 
            "thisNode": true, 
            "uptime": "2680754", 
            "version": "3.0.0-1209-rel-enterprise"
        }
    ], 
    "proxyPort": 0, 
    "purgeInterval": 2, 
    "quota": {
        "ram": 268435456, 
        "rawRAM": 268435456
    }, 
    "replicaIndex": false, 
    "replicaNumber": 1, 
    "saslPassword": "", 
    "stats": {
        "directoryURI": "/pools/default/buckets/test2/statsDirectory", 
        "nodeStatsListURI": "/pools/default/buckets/test2/nodes", 
        "uri": "/pools/default/buckets/test2/stats"
    }, 
    "streamingUri": "/pools/default/bucketsStreaming/test2?bucket_uuid=19e3c64824c22f9ad5604a15f856999d", 
    "threadsNumber": 3, 
    "uri": "/pools/default/buckets/test2?bucket_uuid=19e3c64824c22f9ad5604a15f856999d", 
    "uuid": "19e3c64824c22f9ad5604a15f856999d", 
    "vBucketServerMap": {
        "hashAlgorithm": "CRC", 
        "numReplicas": 1, 
        "serverList": [
            "10.5.2.117:11210"
        ], 
        "vBucketMap": [

Response codes

HTTP/1.1 200 OK