QOqovery
Database Main Calls

Edit a database

To edit a database you must have the admin permission

put/database/{databaseId}

Request

Path parameters

databaseIdstring uuid required

Database ID

Request body

namestring

name is case-insensitive

descriptionstring

give a description to this database

versionstring
accessibility'PRIVATE' | 'PUBLIC'
cpuinteger

unit is millicores (m). 1000m = 1 cpu. This field will be ignored for managed DB (instance type will be used instead).

memoryinteger

unit is MB. 1024 MB = 1GB This field will be ignored for managed DB (instance type will be used instead). Default value is linked to the database type:

  • MANAGED: 100
  • CONTAINER
    • POSTGRES: 100
    • REDIS: 100
    • MYSQL: 512
    • MONGODB: 256
storageinteger

unit is GB

instance_typestring

Database instance type to be used for this database. The list of values can be retrieved via the endpoint /{CloudProvider}/managedDatabase/instanceType/{region}/{dbType}. This field SHOULD NOT be set for container DB.

icon_uristring uri

Icon URI representing the database.

Example request

{
  "version": "10.1",
  "cpu": 1250,
  "memory": 1024,
  "storage": 4,
  "instance_type": "db.t3.medium"
}

Response

Edit a database

idstring uuid required
created_atstring date-time required
updated_atstring date-time
namestring required

name is case insensitive

descriptionstring

give a description to this database

type'MONGODB' | 'MYSQL' | 'POSTGRESQL' | 'REDIS' required
versionstring required
mode'CONTAINER' | 'MANAGED' required
accessibility'PRIVATE' | 'PUBLIC'
cpuinteger

unit is millicores (m). 1000m = 1 cpu This field will be ignored for managed DB (instance type will be used instead).

instance_typestring

Database instance type to be used for this database. The list of values can be retrieved via the endpoint /{CloudProvider}/managedDatabase/instanceType/{region}/{dbType}. This field is null for container DB.

memoryinteger

unit is MB. 1024 MB = 1GB This field will be ignored for managed DB (instance type will be used instead). Default value is linked to the database type:

  • MANAGED: 100
  • CONTAINER
    • POSTGRES: 100
    • REDIS: 100
    • MYSQL: 512
    • MONGODB: 256
storageinteger

unit is GB

icon_uristring uri required

Icon URI representing the database.

hoststring
portinteger
maximum_cpuinteger

Maximum cpu that can be allocated to the database based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu

maximum_memoryinteger

Maximum memory that can be allocated to the database based on organization cluster configuration. unit is MB. 1024 MB = 1GB

disk_encryptedboolean

indicates if the database disk is encrypted or not

service_type'APPLICATION' | 'DATABASE' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required

type of the service (application, database, job, ...)

Example response

{
  "version": "10.1",
  "cpu": 1250,
  "instance_type": "db.t3.medium",
  "memory": 1024,
  "port": 5432,
  "maximum_cpu": 1250,
  "maximum_memory": 1024
}

Changes

No recorded changes to this operation across all 1 revision of this API.