Update a MongoDB database
Updates a MongoDB database’s settings. Its provisioning and database_name cannot change.
/project/{project_id}/environment/{environment_id}/database/mongodb/{database_id}AuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
environment_iduuidrequiredThe unique identifier of the environment
database_iduuidrequiredUnique identifier of the database.
application/jsonnamestringUpdated database name.
descriptionstringUpdated database description.
versionstringUpdated database engine version.
accessibilitydatabase_accessibilityUpdated database network accessibility.
PRIVATEPUBLICconfigurationobjectShow propertiesHide properties
encrypt_diskbooleanactivate_high_availabilitybooleanactivate_backupsbooleanresourcesobjectShow propertiesHide properties
cpu_request_in_milliinteger<int64>cpu_limit_in_milliinteger<int64>ram_request_in_mibinteger<int64>ram_limit_in_mibinteger<int64>disk_size_in_gibinteger<int64>database_instance_tierstringdatabase_disk_typestringdatabase_disk_iopsinteger<int64>MongoDB database updated successfully
iduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
cluster_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuidrequiredA universally unique identifier (UUID) string
s_idstringrequiredShort identifier for the database resource.
namestringrequiredName of the database.
descriptionstringOptional database description.
typedatabase_typerequiredDatabase engine type.
POSTGRESQLMYSQLMONGODBREDISversionstringrequiredDatabase engine version.
provisioningdatabase_provisioningrequiredDatabase provisioning strategy.
IN_CLUSTERMANAGEDaccessibilitydatabase_accessibilityrequiredDatabase network accessibility.
PRIVATEPUBLICconfigurationobjectrequiredShow propertiesHide properties
database_namestringLogical database name created inside the engine.
encrypt_diskbooleanactivate_high_availabilitybooleanactivate_backupsbooleanresourcesobjectrequiredShow propertiesHide properties
cpu_request_in_milliinteger<int64>cpu_limit_in_milliinteger<int64>ram_request_in_mibinteger<int64>ram_limit_in_mibinteger<int64>disk_size_in_gibinteger<int64>database_instance_tierstringdatabase_disk_typestringdatabase_disk_iopsinteger<int64>created_atstring<date-time>requiredTimestamp when the database was created.
updated_atstring<date-time>requiredTimestamp when the database was last updated.
deleted_atstring<date-time> | nullTimestamp when the database was deleted.
last_run_iduuid | nullLast component run identifier.
Show propertiesHide properties
string<uuid>nulllast_run_statuscomponent_deployment_state | nullLast component run status for the database.
Show propertiesHide properties
stringnullresource_statedatabase_resource_staterequiredCurrent resource state for the database.
OUT_OF_DATEUP_TO_DATENEVER_DEPLOYEDError
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling