Reset database password or certificate

POST

databases

{database_id}

credentials

reset

Reset database password or certificate

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

required

The API key for your account. You can find this in your account settings.

Requires an API key with the databases:credentials scope. Rotates either the access password or the TLS certificate of a database, without recreating it or changing its connection URL structure. Use this if a credential leaked or as part of a routine rotation policy. The database must be running to reset either credential. Resetting password returns the new password once in the response body, it is not shown again, so store it immediately. Resetting certificate returns a plain success, fetch the new certificate afterward via Get Certificate. After either reset, existing client connections using the old credential will need to reconnect. Rate limited to 1 reset every 3 seconds per user.

Parameters

string

required

The ID of the database.

string

required

The credential you want to reset, password or certificate.

Response

string

Indicates whether the call was successful: success if it was, error if not.

If it’s a password reset

object

The contents of the response.

Show properties

string

The new generated password.

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

Common errors

Code	HTTP	Meaning
`INVALID_RESET_TYPE`	400	`reset` was not `"password"` or `"certificate"`.
`DATABASE_NOT_RUNNING`	400	The database is stopped; start it before resetting credentials.
`DATABASE_NOT_FOUND`	404	The database does not exist or is not owned by the caller.
`RESET_FAILED`	500	The credential rotation was rejected by the cluster.

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

Reset database password or certificate

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

Get started

Account

Applications

Databases

Workspaces

AI

Reset database password or certificate

Parameters

Response

If it’s a password reset

Common errors

Parameters

Response

If it’s a password reset

Common errors

Related