Get the database a blueprint manages
curl --request GET \
--url https://api.qovery.com/blueprint/{blueprintId}/database \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/blueprint/{blueprintId}/database"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/blueprint/{blueprintId}/database', 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/blueprint/{blueprintId}/database",
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.qovery.com/blueprint/{blueprintId}/database"
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.qovery.com/blueprint/{blueprintId}/database")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/blueprint/{blueprintId}/database")
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{
"kind": "MONGODB",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"endpoint": {
"host": "my-db.abc123.eu-west-3.rds.amazonaws.com",
"port": 5432
}
}Blueprint Main Calls
Get the database a blueprint manages
Returns the kind of database a blueprint manages and its endpoint, read from the DB_ADDRESS and DB_PORT outputs of its terraform service. endpoint is null until a deploy has reported it. Port-forward dials this endpoint to reach a blueprint database.
GET
/
blueprint
/
{blueprintId}
/
database
Get the database a blueprint manages
curl --request GET \
--url https://api.qovery.com/blueprint/{blueprintId}/database \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/blueprint/{blueprintId}/database"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/blueprint/{blueprintId}/database', 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/blueprint/{blueprintId}/database",
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.qovery.com/blueprint/{blueprintId}/database"
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.qovery.com/blueprint/{blueprintId}/database")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/blueprint/{blueprintId}/database")
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{
"kind": "MONGODB",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"endpoint": {
"host": "my-db.abc123.eu-west-3.rds.amazonaws.com",
"port": 5432
}
}Authorizations
bearerAuthApiKeyAuth
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
Blueprint ID
Response
Database the blueprint manages
Database a blueprint manages
Available options:
MONGODB, MYSQL, POSTGRESQL, REDIS Terraform service the blueprint created; null before its first dispatch
Null until a deploy has reported the database endpoint
Show child attributes
Show child attributes
Was this page helpful?