Obter certificado - Square Cloud

GET

databases

{database_id}

credentials

certificate

Obter certificado

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
  .header("Authorization", "<authorization>")
  .asString();

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"
    }
}

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Retorna o certificado TLS que o banco de dados usa para conexões criptografadas, codificado em base64 para poder ser gravado diretamente em um arquivo .pem. Bancos de dados gerenciados MongoDB, MySQL e PostgreSQL possuem cada um seu próprio certificado; verifique as opções de TLS do seu driver para saber se ele precisa de um. O banco de dados precisa estar em execução ao chamar este endpoint; se estiver parado, inicie-o primeiro. Para rotacionar o certificado em vez de apenas lê-lo, use Redefinir Credenciais com reset: "certificate" e depois busque-o novamente aqui.

Parâmetros

database_id

string

obrigatório

O ID do banco de dados.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

object

O conteúdo da resposta.

Mostrar Alternar objeto

certificate

string

O certificado codificado em base64.

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

Erros comuns

Código	HTTP	Significado
`DATABASE_NOT_RUNNING`	400	O banco de dados está parado; inicie-o antes de ler o certificado.
`READ_FAILED`	400	Não foi possível ler o arquivo de certificado no cluster.
`DATABASE_NOT_FOUND`	404	O banco de dados não existe ou não pertence a quem fez a chamada.

Redefinir credenciaisRedefinir o certificado ou a senha de um banco de dados hospedado na Square Cloud.

Obter certificado

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
  .header("Authorization", "<authorization>")
  .asString();

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"
    }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns