MethodPathDescription
POST/v1/crdbs/{crdb_guid}/updatesModify Active-Active confgurarion

Modify Active-Active configuration

POST /v1/crdbs/{crdb_guid}/updates

Modify Active-Active configuration.

Warning -
This is a very powerful API request and can cause damage if used incorrectly.

In order to add or remove instances, you must use this API. For simple configuration updates, it is recommended to use PATCH on /crdbs/{crdb_guid} instead.

Updating default_db_config affects both existing and new instances that may be added.

When you update db_config, it changes the configuration of the database that you specify. This field overrides corresponding fields (if any) in default_db_config.

Request

Example HTTP request

POST /crdbs/1/updates

Request headers

KeyValueDescription
X-Task-IDstringSpecified task ID
X-Result-TTLintegerTime (in seconds) to keep task result

URL parameters

FieldTypeDescription
crdb_guidstringGlobally unique Active-Active database ID (GUID)

Request body

Include a CRDB modify_request object with updated fields in the request body.

Response

Returns a CRDB task object.

Status codes

CodeDescription
200 OKThe request has been accepted.
400 Bad RequestThe posted Active-Active database contains invalid parameters.
401 UnauthorizedUnauthorized request. Invalid credentials
404 Not FoundConfiguration, instance or Active-Active database not found.
406 Not AcceptableThe posted Active-Active database cannot be accepted.