Skip to content

Commit 47fbff1

Browse files
committed
DOC-3669 Feedback update to emphasize the warning that this API is dangerous
1 parent fd0c691 commit 47fbff1

File tree

1 file changed

+14
-2
lines changed
  • content/operate/rs/references/rest-api/requests/services

1 file changed

+14
-2
lines changed

content/operate/rs/references/rest-api/requests/services/_index.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ weight: $weight
1818
| [POST](#post-local-services) | `/v1/local/services` | Modify or perform operations on local processes |
1919
| [POST](#post-services) | `/v1/services` | Apply cluster-wide changes to services |
2020

21+
{{<warning>}}
22+
This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).
23+
24+
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
25+
26+
For a list of optional services, see the [services configuration object reference]({{<relref "/operate/rs/references/rest-api/objects/services_configuration">}}) or use a [`GET /v1/cluster/services_configuration`]({{<relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#get-cluster-services_config">}}) request.
27+
{{</warning>}}
28+
2129
## Get local services {#get-local-services}
2230

2331
```sh
@@ -92,7 +100,9 @@ Supported `operation_type` values:
92100
- restart
93101

94102
{{<warning>}}
95-
Stop, start, or restart optional services only. Changing the status of required services can affect cluster behavior.
103+
This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).
104+
105+
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
96106

97107
For a list of optional services, see the [services configuration object reference]({{<relref "/operate/rs/references/rest-api/objects/services_configuration">}}) or use a [`GET /v1/cluster/services_configuration`]({{<relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#get-cluster-services_config">}}) request.
98108
{{</warning>}}
@@ -159,7 +169,9 @@ Supported `operation_type` values:
159169
- restart
160170

161171
{{<warning>}}
162-
Stop, start, or restart optional services only. Changing the status of required services can affect cluster behavior.
172+
This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).
173+
174+
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
163175

164176
For a list of optional services, see the [services configuration object reference]({{<relref "/operate/rs/references/rest-api/objects/services_configuration">}}) or use a [`GET /v1/cluster/services_configuration`]({{<relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#get-cluster-services_config">}}) request.
165177
{{</warning>}}

0 commit comments

Comments
 (0)