{
  "id": "services",
  "title": "Services requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/services/",
  "summary": "REST API requests to list or modify Redis Enterprise services.",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-local-services) | `/v1/local/services` | List Redis Enterprise services on the local node |\n| [POST](#post-local-services) | `/v1/local/services` | Modify or perform operations on local processes |\n| [POST](#post-services) | `/v1/services` | Modify or perform operations on primary node processes |\n\n\nThis API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).\n\nStop, 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.\n\nFor a list of optional services, see the [services configuration object reference]() or use a [`GET /v1/cluster/services_configuration`]() request.\n\n\n## Get local services {#get-local-services}\n\n```sh\nGET /v1/local/services\n```\n\nLists all Redis Enterprise services currently running on the local node and relevant metadata.\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/local/services\n```\n\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n### Response {#get-response}\n\nReturns a JSON object that describes all Redis Enterprise services currently running on the local node and relevant metadata.\n\nPossible `status` values: \n- RESTARTING\n- RUNNING\n- STARTING\n- STOPPED\n\n#### Example JSON response body\n\n```json\n{\n    \"alert_mgr\": {\n        \"start_time\": \"2024-05-13T18:38:00Z\",\n        \"status\": \"RUNNING\",\n        \"uptime\": \"3 days, 0:58:59\"\n    },\n    \"ccs\": {\n        \"start_time\": \"2024-05-13T18:38:59Z\",\n        \"status\": \"RUNNING\",\n        \"uptime\": \"3 days, 0:58:00\"\n    },\n    ...\n}\n```\n\n#### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error |\n\n## Modify local services {#post-local-services}\n\n```sh\nPOST /v1/local/services\n```\n\nModify Redis Enterprise services or perform operations that directly interact with processes on the local node. To perform operations on the primary node, use [`POST /v1/services`](#post-services) instead.\n\nSupported `operation_type` values:\n\n- stop\n- start\n- restart\n\n\nThis API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).\n\nStop, 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.\n\nFor a list of optional services, see the [services configuration object reference]() or use a [`GET /v1/cluster/services_configuration`]() request.\n\n\n### Request {#post-local-request}\n\n#### Example HTTP request\n\n```sh\nPOST /v1/local/services\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Example JSON request body\n\n```json\n{\n  \"operation_type\": \"restart\",\n  \"services\": [\n    \"alert_mgr\"\n  ]\n}\n```\n\n### Response {#post-local-response}\n\nReturns a JSON object that shows whether the operation ran successfully or failed for each requested service.\n\n#### Example JSON response body\n\n```json\n{\n    \"alert_mgr\": true,\n    \"metrics_exporter\": true\n}\n```\n\n\n#### Status codes {#post-local-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |\n\n## Modify primary node services {#post-services}\n\n```sh\nPOST /v1/services\n```\n\nModify Redis Enterprise services or perform operations that directly interact with processes on the primary node. For operations on secondary nodes, use [`POST /v1/local/services`](#post-local-services) instead.\n\nSupported `operation_type` values:\n\n- stop\n- start\n- restart\n\n\nThis API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/).\n\nStop, 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.\n\nFor a list of optional services, see the [services configuration object reference]() or use a [`GET /v1/cluster/services_configuration`]() request.\n\n\n### Request {#post-request}\n\n#### Example HTTP request\n\n```sh\nPOST /v1/services\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Example JSON request body\n\n```json\n{\n  \"operation_type\": \"restart\",\n  \"services\": [\n    \"alert_mgr\"\n  ]\n}\n```\n\n### Response {#post-response}\n\nReturns a JSON object that shows whether the operation ran successfully or failed for each requested service.\n\n#### Example JSON response body\n\n```json\n{\n    \"alert_mgr\": true,\n    \"metrics_exporter\": true\n}\n```\n\n\n#### Status codes {#post-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": []
}