{
  "schema_version": 2,
  "id": "operate/rs/clusters/configure/call-home",
  "title": "Call home client",
  "url": "https://redis.io/docs/latest/operate/rs/clusters/configure/call-home/",
  "summary": "The call home client sends your Redis Software cluster's daily usage statistics to Redis.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-09-24T10:14:16+01:00",
  "page_type": "content",
  "content_hash": "b37bcff19568e11cf0b71364cf417ad9ab532753788f1e6cc28eeea3c86ae89b",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "The call home client collects data hourly and sends daily usage statistics to Redis with a POST request to `https://usage.redis.io/callHome`. Reports include memory usage, shard details, enabled features, and other operational metrics. To prevent increased load when multiple clusters are running, the daily report is sent at a random time.\n\nThese reports provide insights into license consumption, which helps Redis to ensure performance metrics align with contractual agreements, optimize service delivery, and offer proactive customer support.\nWe recommend contacting [Redis support](https://redis.io/support/) before making changes to call home behavior."
    },
    {
      "id": "collected-data",
      "title": "Collected data",
      "role": "content",
      "text": "The following example shows the data collected hourly for each database:\n\n[code example]"
    },
    {
      "id": "change-data-collection-schedule",
      "title": "Change data collection schedule",
      "role": "content",
      "text": "The cluster collects usage data hourly by default.\n\nTo change the data collection schedule, [update job scheduler settings](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/job_scheduler#put-job-scheduler) for `bdb_usage_report_job_settings` with a REST API request:\n\n[code example]\n\nReplace `cron_expression`'s value with a [`cron` expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the new data collection schedule."
    },
    {
      "id": "turn-off-call-home-client",
      "title": "Turn off call home client",
      "role": "content",
      "text": "To stop the call home client from sending daily usage statistics to Redis, [update cluster services configuration](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/services_configuration#put-cluster-services_config) for `call_home_agent` with a REST API request:\n\n[code example]"
    }
  ],
  "examples": [
    {
      "id": "collected-data-ex0",
      "language": "sh",
      "code": "{\n  \"support_package\": true,\n  \"customer_name\": \"string\",\n  \"license_hash\": \"string\",\n  \"usage_data\": [\n    {\n      \"date\": \"2025-03-25T11:42:13.984Z\",\n      \"cluster_UUID\": \"string\",\n      \"cluster_name\": \"string\",\n      \"api_version\": \"string\",\n      \"software_version\": \"string\",\n      \"bdb_uid\": \"string\",\n      \"type\": \"string\",\n      \"shard_type\": \"string\",\n      \"dominant_shard_criteria\": \"string\",\n      \"provisioned_memory\": 0,\n      \"used_memory\": 0,\n      \"master_shards_count\": 0,\n      \"no_eviction\": true,\n      \"persistence\": true,\n      \"backup\": true,\n      \"using_redis_search\": true,\n      \"ops_sec\": 0,\n      \"replication\": true,\n      \"active_active\": true\n    }\n  ]\n}",
      "section_id": "collected-data"
    },
    {
      "id": "change-data-collection-schedule-ex0",
      "language": "sh",
      "code": "PUT /v1/job_scheduler\n{\n  \"bdb_usage_report_job_settings\": {\n    \"enabled\": true,\n    \"cron_expression\": \"*/60 * * * *\"\n  }\n}",
      "section_id": "change-data-collection-schedule"
    },
    {
      "id": "turn-off-call-home-client-ex0",
      "language": "sh",
      "code": "PUT /v1/cluster/services_configuration\n{\n  \"call_home_agent\": {\n    \"operating_mode\": \"disabled\"\n  }\n}",
      "section_id": "turn-off-call-home-client"
    }
  ]
}