Restablecer Credenciales

POST

databases

{database_id}

credentials

reset

Restablecer Credenciales

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reset": "<string>"
}
'

import requests

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

payload = { "reset": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reset: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset', 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/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reset' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"reset\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reset\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reset\": \"<string>\"\n}"

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

{
  "status":"success",
  "response":{
    "password":"f3T1hdskMkchMwK6Hxqinoyb"
  }
}

string

requerido

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

Rota la contraseña de acceso o el certificado TLS de una base de datos, sin recrearla ni cambiar la estructura de su URL de conexión. Úsalo si una credencial se filtró o como parte de una política de rotación periódica. La base de datos debe estar en ejecución para restablecer cualquiera de las dos credenciales. Al restablecer password se devuelve la nueva contraseña una sola vez en el cuerpo de la respuesta, no se vuelve a mostrar, así que guárdala de inmediato. Al restablecer certificate se devuelve un éxito simple, obtén el nuevo certificado después mediante Obtener Certificado. Tras cualquiera de los dos restablecimientos, las conexiones de cliente que usen la credencial anterior deberán reconectarse. Límite de 1 restablecimiento cada 3 segundos por usuario.

Parámetros

string

requerido

El ID de la base de datos.

string

requerido

La credencial que deseas restablecer, password o certificate.

Respuesta

string

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

Si es un restablecimiento de contraseña

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

La nueva contraseña generada.

{
  "status":"success",
  "response":{
    "password":"f3T1hdskMkchMwK6Hxqinoyb"
  }
}

Errores comunes

Código	HTTP	Significado
`INVALID_RESET_TYPE`	400	`reset` no era `"password"` ni `"certificate"`.
`DATABASE_NOT_RUNNING`	400	La base de datos está detenida; inícala antes de restablecer credenciales.
`DATABASE_NOT_FOUND`	404	La base de datos no existe o no pertenece al solicitante.
`RESET_FAILED`	500	El cluster rechazó la rotación de la credencial.

Listar SnapshotsObtén una lista de todos los snapshots relacionados con una única base de datos.

Restablecer Credenciales

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reset": "<string>"
}
'

import requests

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

payload = { "reset": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reset: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset', 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/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reset' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"reset\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reset\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reset\": \"<string>\"\n}"

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

{
  "status":"success",
  "response":{
    "password":"f3T1hdskMkchMwK6Hxqinoyb"
  }
}

​Parámetros

​Respuesta

​Si es un restablecimiento de contraseña

​Errores comunes

Parámetros

Respuesta

Si es un restablecimiento de contraseña

Errores comunes