List

List

curl --request GET \
  --url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases', 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.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "name": "<string>",
    "environment": "<string>",
    "provider": "<string>",
    "sku": "<string>",
    "targetSku": "<string>",
    "allocatedStorageGb": 123,
    "resize": {
      "progressPercent": 123,
      "startedAt": "2023-11-07T05:31:56Z",
      "estimatedCompletedAt": "2023-11-07T05:31:56Z"
    },
    "region": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

GET

orgs

{orgId}

projects

{projectId}

databases

List

curl --request GET \
  --url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases', 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.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "name": "<string>",
    "environment": "<string>",
    "provider": "<string>",
    "sku": "<string>",
    "targetSku": "<string>",
    "allocatedStorageGb": 123,
    "resize": {
      "progressPercent": 123,
      "startedAt": "2023-11-07T05:31:56Z",
      "estimatedCompletedAt": "2023-11-07T05:31:56Z"
    },
    "region": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId

string

required

The organization's id (UUID) or slug — either form is accepted.

projectId

string

required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment

string

Environment slug to filter by. Omitted, databases from every environment are listed. An environment that does not exist on the project answers 404.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Response

Databases, oldest first.

string

required

name

string

required

Customer-chosen database name — unique within the environment. 2-62 chars of lowercase letters, digits, and hyphens, starting with a letter.

Pattern: ^[a-z][a-z0-9-]{1,61}$

environment

string

required

Slug of the environment the database belongs to.

Pattern: ^[a-z][a-z0-9-]{0,38}$

provider

string

required

Database backend generation the row lives on. Set at provisioning.

sku

string | null

required

Database SKU id (see the rate card via billing.get); null on legacy databases.

targetSku

string | null

required

Requested SKU while a zero-downtime HA resize is running; otherwise null.

allocatedStorageGb

integer | null

required

Actual allocated data-disk capacity; durable volumes grow but do not shrink.

resize

object | null

required

Durable progress for an active rolling resize; null when no resize is running.

Show child attributes

region

string

required

Database region id (see regions.list). Immutable after provisioning.

status

enum<string>

required

Available options:

provisioning,

resizing,

ready,

failed

replicas

enum<integer>

required

Topology: 0 creates a single-node database; 2 creates one primary plus two data replicas with synchronous quorum commits and continuous recovery.

Available options:

0,

2

createdAt

string<date-time>

required

Delete Provision

Start

Core concepts

Agents

Build

Data and work

Operate

CLI reference

API reference

Authorizations

Path Parameters

Query Parameters

Response