Redefinir senha ou certificado do banco de dados

POST

databases

{database_id}

credentials

reset

Redefinir senha ou certificado do banco de dados

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

obrigatório

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

Requer uma chave de API com o escopo databases:credentials. Rotaciona a senha de acesso ou o certificado TLS de um banco de dados, sem recriá-lo ou alterar a estrutura da sua URL de conexão. Use isso se uma credencial vazou ou como parte de uma política de rotação de rotina. O banco de dados precisa estar em execução para redefinir qualquer uma das credenciais. Redefinir a password retorna a nova senha uma única vez no corpo da resposta; ela não é mostrada novamente, então salve-a imediatamente. Redefinir o certificate retorna apenas um sucesso; busque o novo certificado depois via Obter Certificado. Após qualquer uma das redefinições, as conexões de clientes existentes que usam a credencial antiga precisarão se reconectar. Limite de taxa de 1 redefinição a cada 3 segundos por usuário.

Parâmetros

string

obrigatório

O ID do banco de dados.

string

obrigatório

A credencial que você deseja redefinir: “password” ou “certificate”.

Resposta

string

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

Se for redefinição de senha

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

A nova senha gerada.

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

Erros comuns

Código	HTTP	Significado
`INVALID_RESET_TYPE`	400	`reset` não era `"password"` nem `"certificate"`.
`DATABASE_NOT_RUNNING`	400	O banco de dados está parado; inicie-o antes de redefinir as credenciais.
`DATABASE_NOT_FOUND`	404	O banco de dados não existe ou não pertence a quem fez a chamada.
`RESET_FAILED`	500	A rotação da credencial foi rejeitada pelo cluster.

Relacionados

CLI: squarecloud db credentials reset
SDKs: api.databases.resetCredentials() (JavaScript), client.databases.reset_credentials() (Python), c.Databases.ResetCredentials() (Go)

Redefinir senha ou certificado do banco de dados

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Redefinir senha ou certificado do banco de dados

Parâmetros

Resposta

Se for redefinição de senha

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Se for redefinição de senha

​Erros comuns

​Relacionados

Parâmetros

Resposta

Se for redefinição de senha

Erros comuns

Relacionados