Reset Database Password

POST

databases

{id}

credentials

reset

Reset Database Password

curl --request POST \
  --url https://api.vertracloud.app/v1/databases/{id}/credentials/reset \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/databases/{id}/credentials/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vertracloud.app/v1/databases/{id}/credentials/reset"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api.vertracloud.app/v1/databases/{id}/credentials/reset"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "response": {
    "password": "a1b2c3d4e5f6g7h8",
    "restart_required": false,
    "apps_to_restart": []
  }
}

string

required

The ID of the database to reset the password for.

Response

object

The response containing the new password.

Show Toggle object

string

The new password for the database.

boolean

true when at least one application of a connected stack must restart to read the new password.

string[]

The IDs of those applications. Empty when restart_required is false.

{
  "response": {
    "password": "a1b2c3d4e5f6g7h8",
    "restart_required": false,
    "apps_to_restart": []
  }
}

Error Responses

string

The error code indicating the reason for failure. Possible values:

AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: The Authorization header is missing, the API key is invalid, or the dashboard session was revoked (401).
API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: The API key is used from an IP outside its allowlist, or it lacks the scope the route requires (403).
ACCESS_DENIED: The resource belongs to another account, or you lack the workspace permission for it (403).
DATABASE_NOT_FOUND_OR_FORBIDDEN: The specified database does not exist or the user lacks access.
INVALID_PLAN_CONFIG: The database plan configuration is invalid.
FAILED_TO_REBUILD_DATABASE: Failed to rebuild the database with the new password.

string

A descriptive message providing additional details about the error.

{
  "code": "ACCESS_DENIED"
}

{
  "code": "DATABASE_NOT_FOUND_OR_FORBIDDEN"
}

{
  "code": "FAILED_TO_REBUILD_DATABASE"
}

Last modified on October 28, 2026

Reset Database Password

curl --request POST \
  --url https://api.vertracloud.app/v1/databases/{id}/credentials/reset \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/databases/{id}/credentials/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vertracloud.app/v1/databases/{id}/credentials/reset"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api.vertracloud.app/v1/databases/{id}/credentials/reset"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "response": {
    "password": "a1b2c3d4e5f6g7h8",
    "restart_required": false,
    "apps_to_restart": []
  }
}

Overview

Endpoints

Reset Database Password

Response

Error Responses

​Response

​Error Responses

Response

Error Responses