Skip to content

DOC-11708 Deprecated REST API endpoint for bucket stats #3895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: release/7.2
Choose a base branch
from
Open

DOC-11708 Deprecated REST API endpoint for bucket stats #3895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92ed285
Update rest-xdcr-table.adoc
supritha-kumar Sep 23, 2025
11400b4
Update rest-buckets-table.adoc
supritha-kumar Sep 23, 2025
dbc65f2
added missing slash in line 26
rao-shwe Sep 23, 2025
198b520
Added correct information
rao-shwe Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion modules/rest-api/pages/rest-bucket-stats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
= Getting Bucket Statistics
:description: pass:q[To retrieve bucket statistics, use the `GET` operation with the `/pools/default/buckets/bucket_name/stats` URI.]
:description: pass:q[See the IMPORTANT note.]
:page-topic-type: reference
:page-aliases: rest-api:rest-node-retrieve-stats

[.deprecated]#Deprecated#

[abstract]
{description}

IMPORTANT: As of Couchbase Server 8.0, the REST API endpoint `GET /pools/default/buckets/<bucket-name>/stats` is deprecated.
For retrieving bucket statistics details, use xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic] or xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics] instead.

== HTTP method and URI

Statistics can be retrieved at the bucket level.
Expand Down
8 changes: 6 additions & 2 deletions modules/rest-api/partials/rest-buckets-table.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,12 @@
| xref:rest-api:rest-retrieve-bucket-nodes.adoc[Listing Nodes by Bucket]

| `GET`
| `/pools/default/buckets/[bucket-name]/stats`
| xref:rest-api:rest-bucket-stats.adoc[Getting Bucket Statistics]
| `/pools/default/stats/range/[metric_name]/[function-expression]`
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]

| `POST`
| `/pools/default/stats/range`
| xref:rest-api:rest-statistics-multiple.adoc[Getting Multiple Statistics]

| `GET`
| `/pools/default/buckets/default`
Expand Down
4 changes: 2 additions & 2 deletions modules/rest-api/partials/rest-xdcr-table.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@


| `GET`
| `/pools/default/buckets/[source_bucket]/stats/[destination_endpoint]`
| xref:rest-api:rest-xdcr-statistics.adoc[Getting Statistics]
| `/pools/default/stats/range/[statistics_name]`
| xref:rest-api:rest-statistics-single.adoc[Getting a Single Statistic]

|===