Réinitialiser les identifiants

POST

databases

{database_id}

credentials

reset

Réinitialiser les identifiants

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Fait pivoter le mot de passe d’accès ou le certificat TLS d’une base de données, sans la recréer ni modifier la structure de son URL de connexion. Utilisez cette route si un identifiant a fuité, ou dans le cadre d’une politique de rotation régulière. La base de données doit être en cours d’exécution pour réinitialiser l’un ou l’autre identifiant. La réinitialisation de password renvoie le nouveau mot de passe une seule fois dans le corps de la réponse : il n’est plus jamais réaffiché, enregistrez-le donc immédiatement. La réinitialisation de certificate renvoie un simple succès ; récupérez ensuite le nouveau certificat via Obtenir le certificat. Après l’une ou l’autre réinitialisation, les connexions client existantes utilisant l’ancien identifiant devront se reconnecter. Limité à 1 réinitialisation toutes les 3 secondes par utilisateur.

Paramètres

string

requis

L’ID de la base de données.

string

requis

L’identifiant que vous souhaitez réinitialiser, password ou certificate.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

S’il s’agit d’une réinitialisation de mot de passe

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

Le nouveau mot de passe généré.

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

Erreurs courantes

Code	HTTP	Signification
`INVALID_RESET_TYPE`	400	`reset` n’était pas `"password"` ni `"certificate"`.
`DATABASE_NOT_RUNNING`	400	La base de données est arrêtée ; démarrez-la avant de réinitialiser les identifiants.
`DATABASE_NOT_FOUND`	404	La base de données n’existe pas ou n’appartient pas à l’appelant.
`RESET_FAILED`	500	La rotation de l’identifiant a été rejetée par le cluster.

Lister les snapshotsRécupère la liste de tous les snapshots liés à une base de données.

Réinitialiser les identifiants

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

​Paramètres

​Réponse

​S’il s’agit d’une réinitialisation de mot de passe

​Erreurs courantes

Paramètres

Réponse

S’il s’agit d’une réinitialisation de mot de passe

Erreurs courantes