From 7de77e3c8fddcaa35a1ca33801ccfbc2abf3c115 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Mon, 18 May 2026 11:58:48 -0400 Subject: [PATCH] Update critical nodes endpoint to make curl POST more prominent / clearer Fixes DOC-17121 --- src/current/v23.2/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v24.1/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v24.3/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v25.2/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v25.4/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v26.1/monitoring-and-alerting.md | 19 +++++++++++++++++++ src/current/v26.2/monitoring-and-alerting.md | 19 +++++++++++++++++++ 7 files changed, 133 insertions(+) diff --git a/src/current/v23.2/monitoring-and-alerting.md b/src/current/v23.2/monitoring-and-alerting.md index f80cc618eb3..597b04d1f8b 100644 --- a/src/current/v23.2/monitoring-and-alerting.md +++ b/src/current/v23.2/monitoring-and-alerting.md @@ -201,6 +201,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v24.1/monitoring-and-alerting.md b/src/current/v24.1/monitoring-and-alerting.md index 53224596aec..78f85d70f39 100644 --- a/src/current/v24.1/monitoring-and-alerting.md +++ b/src/current/v24.1/monitoring-and-alerting.md @@ -199,6 +199,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v24.3/monitoring-and-alerting.md b/src/current/v24.3/monitoring-and-alerting.md index 126ea495e7e..02d1c722f87 100644 --- a/src/current/v24.3/monitoring-and-alerting.md +++ b/src/current/v24.3/monitoring-and-alerting.md @@ -199,6 +199,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v25.2/monitoring-and-alerting.md b/src/current/v25.2/monitoring-and-alerting.md index 5a5816fb1b3..0caca71984b 100644 --- a/src/current/v25.2/monitoring-and-alerting.md +++ b/src/current/v25.2/monitoring-and-alerting.md @@ -196,6 +196,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v25.4/monitoring-and-alerting.md b/src/current/v25.4/monitoring-and-alerting.md index cc29283cd40..cacd158b087 100644 --- a/src/current/v25.4/monitoring-and-alerting.md +++ b/src/current/v25.4/monitoring-and-alerting.md @@ -173,6 +173,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v26.1/monitoring-and-alerting.md b/src/current/v26.1/monitoring-and-alerting.md index 46dfaf780ea..8b5a447d651 100644 --- a/src/current/v26.1/monitoring-and-alerting.md +++ b/src/current/v26.1/monitoring-and-alerting.md @@ -173,6 +173,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields. diff --git a/src/current/v26.2/monitoring-and-alerting.md b/src/current/v26.2/monitoring-and-alerting.md index d6bd689cb1a..3016d8df308 100644 --- a/src/current/v26.2/monitoring-and-alerting.md +++ b/src/current/v26.2/monitoring-and-alerting.md @@ -185,6 +185,25 @@ The critical nodes status endpoint is used to: If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}). +#### Request the endpoint + +To return the JSON response, send a `POST` request to `/_status/critical_nodes`. + +For an insecure or local testing cluster, use HTTP: + +{% include_cached copy-clipboard.html %} +~~~ shell +curl -X POST http://:/_status/critical_nodes +~~~ + +For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`. + +{% include_cached copy-clipboard.html %} +~~~ shell +cockroach auth-session login --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key +curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://:/_status/critical_nodes +~~~ + #### Fields The JSON object returned by the critical nodes status endpoint contains the following top-level fields.