Obtener Certificado - Square Cloud

GET

databases

{database_id}

credentials

certificate

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

}

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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Devuelve el certificado TLS que usa la base de datos para las conexiones cifradas, codificado en base64 para poder escribirlo directamente en un archivo .pem. Las bases de datos MongoDB, MySQL y PostgreSQL gestionadas incluyen cada una su propio certificado; revisa las opciones TLS de tu driver para saber si lo necesita. La base de datos debe estar en ejecución al llamar a este endpoint, si está detenida, inícala primero. Para rotar el certificado en lugar de solo leerlo, usa Restablecer Credenciales con reset: "certificate" y luego vuelve a obtenerlo aquí.

Parámetros

string

requerido

El ID de la base de datos.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

El certificado codificado en base64.

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

Errores comunes

Código	HTTP	Significado
`DATABASE_NOT_RUNNING`	400	La base de datos está detenida; inícala antes de leer el certificado.
`READ_FAILED`	400	No se pudo leer el archivo de certificado desde el cluster.
`DATABASE_NOT_FOUND`	404	La base de datos no existe o no pertenece al solicitante.

Restablecer CredencialesRestablece el certificado o la contraseña de una base de datos alojada en Square Cloud.

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

}

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

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes