{
  "id": "crdbs",
  "title": "CRDBs requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/crdbs/",
  "summary": "Active-Active database requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-all-crdbs) | `/v1/crdbs` | Get all Active-Active databases |\n| [GET](#get-crdb) | `/v1/crdbs/{crdb_guid}` | Get a specific Active-Active database |\n| [PATCH](#patch-crdbs) | `/v1/crdbs/{crdb_guid}` | Update an Active-Active database |\n| [POST](#post-crdb) | `/v1/crdbs` | Create a new Active-Active database |\n| [DELETE](#delete-crdb) | `/v1/crdbs/{crdb_guid}` | Delete an Active-Active database |\n\n## Get all Active-Active databases {#get-all-crdbs}\n\n```sh\nGET /v1/crdbs\n```\n\nGet a list of all Active-Active databases on the cluster.\n\n### Request {#get-all-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/crdbs\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| X-Task-ID | string | Specified task ID |\n| X-Result-TTL | integer | Time (in seconds) to keep task result |\n\n### Response {#get-all-response}\n\nReturns a JSON array of [CRDB objects]().\n\n##### Status codes {#get-all-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | A list of Active-Active database. |\n| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | Unauthorized request. Invalid credentials |\n\n## Get an Active-Active database {#get-crdb}\n\n```sh\nGET /v1/crdbs/{crdb_guid}\n```\n\nGet a specific Active-Active database.\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\n GET /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| X-Task-ID | string | Specified task ID |\n| X-Result-TTL | integer | Time (in seconds) to keep task result |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| crdb_guid | string | Globally unique Active-Active database ID (GUID) |\n\n#### Query parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| instance_id | integer | Instance from which to get the Active-Active database information |\n\n### Response {#get-response}\n\nReturns a [CRDB object]().\n\n#### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Active-Active database information is returned. |\n| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | Unauthorized request. Invalid credentials |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Database or configuration does not exist. |\n\n## Update an Active-Active database {#patch-crdbs}\n\n```sh\nPATCH /v1/crdbs/{crdb_guid}\n```\n\nUpdate an Active-Active database's configuration.\n\nIn order to add or remove instances, use [\u003cnobr\u003e`POST crdbs/{crdb_guid}/updates`\u003c/nobr\u003e]() instead.\n\n### Request {#patch-request}\n\n#### Example HTTP request\n\n```sh\n PATCH /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| X-Task-ID | string | Specified task ID |\n| X-Result-TTL | integer | Time (in seconds) to keep task result |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| crdb_guid | string | Globally unique Active-Active database ID (GUID) |\n\n#### Request body\n\nInclude a [CRDB object]() with updated fields in the request body.\n\n### Response {#patch-response}\n\nReturns a [CRDB task object]().\n\n#### Status codes {#patch-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The request has been accepted. |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | The posted Active-Active database contains invalid parameters. |\n| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | Unauthorized request. Invalid credentials |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Configuration or Active-Active database not found. |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | The posted Active-Active database cannot be accepted. |\n\n## Create an Active-Active database {#post-crdb}\n\n```sh\nPOST /v1/crdbs\n```\n\nCreate a new Active-Active database.\n\n### Request {#post-request}\n\n#### Example HTTP request\n\n```sh\n POST /v1/crdbs\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| X-Task-ID | string | Specified task ID |\n| X-Result-TTL | integer | Time (in seconds) to keep task result |\n\n#### Query parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| dry_run | boolean | Validate the request without creating the database (optional) |\n\n#### Request body\n\nInclude a [CRDB object](), which defines the Active-Active database, in the request body.\n\n##### Example body\n\n```json\n{\n    \"default_db_config\":\n    {\n        \"name\": \"sample-crdb\",\n        \"memory_size\": 214748365\n    },\n    \"instances\":\n    [\n        {\n            \"cluster\":\n            {\n                \"url\": \"http://\u003ccluster1_FQDN\u003e:9443\",\n                \"credentials\":\n                {\n                    \"username\": \"\u003cusername\u003e\",\n                    \"password\": \"\u003cpassword\u003e\"\n                },\n                \"name\": \"cluster-1\"\n            },\n            \"compression\": 6\n        },\n        {\n            \"cluster\":\n            {\n                \"url\": \"http://\u003ccluster2_FQDN\u003e:9443\",\n                \"credentials\":\n                {\n                    \"username\": \"\u003cusername\u003e\",\n                    \"password\": \"\u003cpassword\u003e\"\n                },\n                \"name\": \"cluster-2\"\n            },\n            \"compression\": 6\n        }\n    ],\n    \"name\": \"sample-crdb\"\n}\n```\n\nThis JSON body creates an Active-Active database without TLS and with two participating clusters.\n\n### Response {#post-response}\n\nReturns a [CRDB task object]().\n\n#### Status codes {#post-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The request has been accepted. |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | The request is invalid or malformed. |\n| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | Unauthorized request. Invalid credentials |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | The posted Active-Active database cannot be accepted. |\n\n## Delete an Active-Active database {#delete-crdb}\n\n```sh\nDELETE /v1/crdbs/{crdb_guid}\n```\n\nDelete an Active-Active database.\n\n### Request {#delete-request}\n\n#### Example HTTP request\n\n```sh\n DELETE /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| X-Task-ID | string | Specified task ID |\n| X-Result-TTL | integer | Time (in seconds) to keep task result |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| crdb_guid | string | Globally unique Active-Active database ID (GUID) |\n\n### Response {#delete-response}\n\nReturns a [CRDB task object]().\n\n#### Status codes {#delete-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Action was successful. |\n| [401 Unauthorized](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2) | Unauthorized request. Invalid credentials |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Configuration or Active-Active database not found. |\n| [406\u0026nbsp;Not\u0026nbsp;Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | The Active-Active GUID is invalid or the Active-Active database was already deleted. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": [{"id":"flush","summary":"Flush Active-Active database requests","title":"CRDB flush requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/crdbs/flush/"},{"id":"health_report","summary":"Active-Active database health report requests","title":"CRDB health report requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/crdbs/health_report/"},{"id":"purge","summary":"Purge removed Active-Active database requests","title":"CRDB purge requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/crdbs/purge/"},{"id":"updates","summary":"Update Active-Active configuration requests","title":"CRDB updates requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/crdbs/updates/"}]
}