Get database TLS certificate

GET

databases

{database_id}

credentials

certificate

Get database TLS certificate

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"

headers = {"Authorization": "<authorization>"}

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

print(response.text)

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

fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate', 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.squarecloud.app/v2/databases/{database_id}/credentials/certificate",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/databases/{database_id}/credentials/certificate"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")

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

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

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

{
    "status": "success",
    "response": {
        "certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
    }
}

string

required

The API key for your account. You can find this in your account settings.

Requires an API key with the databases:credentials scope. Returns the TLS file the database uses for encrypted connections, base64-encoded. Once decoded, it is a PEM with the private key followed by the certificate, ready to be written to a .pem file. Managed MongoDB, MySQL and PostgreSQL databases each ship with their own certificate; check your driver’s TLS options to see whether it needs one. The database must be running when you call this, if it is stopped, start it first. To rotate the certificate instead of just reading it, use Reset Credentials with reset: "certificate", then re-fetch it here.

Parameters

string

required

The ID of the database.

Response

string

Indicates whether the call was successful: success if it was, error if not.

object

The contents of the response.

Show properties

string

The PEM (private key followed by the certificate), encoded in base64.

{
    "status": "success",
    "response": {
        "certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
    }
}

Common errors

Code	HTTP	Meaning
`DATABASE_NOT_RUNNING`	400	The database is stopped; start it before reading the certificate.
`READ_FAILED`	400	The certificate file could not be read from the cluster.
`DATABASE_NOT_FOUND`	404	The database does not exist or is not owned by the caller.

CLI: squarecloud db credentials certificate
SDKs: api.databases.certificate() (JavaScript), client.databases.certificate() (Python), c.Databases.Certificate() (Go)

Get database TLS certificate

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"

headers = {"Authorization": "<authorization>"}

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

print(response.text)

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

fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate', 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.squarecloud.app/v2/databases/{database_id}/credentials/certificate",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/databases/{database_id}/credentials/certificate"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")

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

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

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

{
    "status": "success",
    "response": {
        "certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
    }
}

Get started

Account

Applications

Databases

Workspaces

AI

Get database TLS certificate

Parameters

Response

Common errors

Parameters

Response

Common errors

Related