A newer version of this documentation is available.

View Latest

Listing Scopes and Collections

  • reference
    Scopes and collections can be listed, by means of the REST API.


    Scopes and collections are listed by means of the GET /pools/default/buckets/<bucket_name>/scopes/ HTTP method and URI.

    HTTP Method and URI

    GET /pools/default/buckets/<bucket_name>/scopes/


    The curl syntax is as follows:

    curl -X GET -v
      -u <username>:<password>

    The <bucket-name> path-parameter specifies the name of the bucket whose defined collections are to be listed.


    Success returns 200 OK. Failure to authenticate gives 401 Unauthorized. A malformed URI fails with 404 Object Not Found.


    The following example lists the collections in a bucket named testBucket:

    curl -X GET -v -u Administrator:password \

    If successful, the call returns 200 OK, and an object listing scopes and collections. For example:


    See Also

    An overview of scopes and collections is provided in Scopes and Collections. Step-by-step procedures for management are provided in Manage Scopes and Collections. See also the CLI reference page for the collection-manage command.