Skip to main content
PUT
/
database
/
{databaseId}
Edit a database 
curl --request PUT \
  --url https://api.qovery.com/database/{databaseId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "version": "10.1",
  "accessibility": "PRIVATE",
  "cpu": 1250,
  "memory": 1024,
  "storage": 4,
  "instance_type": "db.t3.medium",
  "annotations_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "labels_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "icon_uri": "<string>"
}
'
import requests

url = "https://api.qovery.com/database/{databaseId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "version": "10.1",
    "accessibility": "PRIVATE",
    "cpu": 1250,
    "memory": 1024,
    "storage": 4,
    "instance_type": "db.t3.medium",
    "annotations_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
    "labels_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
    "icon_uri": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    version: '10.1',
    accessibility: 'PRIVATE',
    cpu: 1250,
    memory: 1024,
    storage: 4,
    instance_type: 'db.t3.medium',
    annotations_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
    labels_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
    icon_uri: '<string>'
  })
};

fetch('https://api.qovery.com/database/{databaseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/database/{databaseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'version' => '10.1',
    'accessibility' => 'PRIVATE',
    'cpu' => 1250,
    'memory' => 1024,
    'storage' => 4,
    'instance_type' => 'db.t3.medium',
    'annotations_groups' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'labels_groups' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'icon_uri' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/database/{databaseId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"version\": \"10.1\",\n  \"accessibility\": \"PRIVATE\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"storage\": 4,\n  \"instance_type\": \"db.t3.medium\",\n  \"annotations_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"labels_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"icon_uri\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.qovery.com/database/{databaseId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"version\": \"10.1\",\n  \"accessibility\": \"PRIVATE\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"storage\": 4,\n  \"instance_type\": \"db.t3.medium\",\n  \"annotations_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"labels_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"icon_uri\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/database/{databaseId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"version\": \"10.1\",\n  \"accessibility\": \"PRIVATE\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"storage\": 4,\n  \"instance_type\": \"db.t3.medium\",\n  \"annotations_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"labels_groups\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"icon_uri\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "version": "10.1",
  "icon_uri": "<string>",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "accessibility": "PRIVATE",
  "cpu": 1250,
  "instance_type": "db.t3.medium",
  "memory": 1024,
  "storage": 10,
  "annotations_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "annotations": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "scopes": [],
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "labels_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "labels": [
        {
          "key": "<string>",
          "value": "<string>",
          "propagate_to_cloud_provider": true
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "host": "<string>",
  "port": 5432,
  "maximum_cpu": 1250,
  "maximum_memory": 1024,
  "disk_encrypted": true
}

Authorizations

​
Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

​
databaseId
string<uuid>
required

Database ID

Body

application/json
​
name
string

name is case-insensitive

​
description
string

give a description to this database

​
version
string
Example:

"10.1"

​
accessibility
enum<string>
default:PRIVATE
Available options:
PRIVATE,
PUBLIC
​
cpu
integer
default:250

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

Example:

1250

​
memory
integer

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
Example:

1024

​
storage
integer

unit is GB

Example:

4

​
instance_type
string

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.

Example:

"db.t3.medium"

​
annotations_groups
object[]
​
labels_groups
object[]
​
icon_uri
string<uri>

Icon URI representing the database.

​
disk_type
enum<string> | null

EBS disk type for MANAGED AWS databases. Allowed values: gp2, gp3. Only applicable for MANAGED mode.

Available options:
gp2,
gp3

Response

Edit a database

​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
name
string
required

name is case insensitive

​
type
enum<string>
required
Available options:
MONGODB,
MYSQL,
POSTGRESQL,
REDIS
​
version
string
required
Example:

"10.1"

​
mode
enum<string>
required
Available options:
CONTAINER,
MANAGED
​
icon_uri
string<uri>
required

Icon URI representing the database.

​
environment
object
required
​
service_type
enum<string>
required

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

Available options:
APPLICATION,
DATABASE,
CONTAINER,
JOB,
HELM,
TERRAFORM,
ARGOCD_APP
​
updated_at
string<date-time>
read-only
​
description
string

give a description to this database

​
accessibility
enum<string>
default:PRIVATE
Available options:
PRIVATE,
PUBLIC
​
cpu
integer
default:250

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

Example:

1250

​
instance_type
string

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.

Example:

"db.t3.medium"

​
memory
integer

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
Example:

1024

​
storage
integer
default:10

unit is GB

​
annotations_groups
object[]
​
labels_groups
object[]
​
host
string
​
port
integer
Example:

5432

​
maximum_cpu
integer

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

Example:

1250

​
maximum_memory
integer

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

Example:

1024

​
disk_encrypted
boolean

indicates if the database disk is encrypted or not

​
disk_type
enum<string> | null

EBS disk type for the database. Only applicable for MANAGED mode (gp2 or gp3). Null for CONTAINER mode.

Available options:
gp2,
gp3