Stop Database
curl --request POST \
--url https://api.vertracloud.app/v1/databases/{id}/stopimport requests
url = "https://api.vertracloud.app/v1/databases/{id}/stop"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.vertracloud.app/v1/databases/{id}/stop', 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.vertracloud.app/v1/databases/{id}/stop",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/databases/{id}/stop"
req, _ := http.NewRequest("POST", url, nil)
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.vertracloud.app/v1/databases/{id}/stop")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/databases/{id}/stop")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"status": "success"
}
}
Databases
Stop Database
Stops a database by its ID.
POST
/
v1
/
databases
/
{id}
/
stop
Stop Database
curl --request POST \
--url https://api.vertracloud.app/v1/databases/{id}/stopimport requests
url = "https://api.vertracloud.app/v1/databases/{id}/stop"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.vertracloud.app/v1/databases/{id}/stop', 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.vertracloud.app/v1/databases/{id}/stop",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/databases/{id}/stop"
req, _ := http.NewRequest("POST", url, nil)
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.vertracloud.app/v1/databases/{id}/stop")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/databases/{id}/stop")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"status": "success"
}
}
string
required
The ID of the database to stop. If the database belongs to a workspace, pass its ID in the
workspace_id query parameter.string
If the database belongs to a workspace, the workspace’s ID. Required for workspace members acting on a database they don’t own.
Stopping is idempotent. Stopping a database that is already stopped is a success, not an error: the API answers
200 and makes sure the recorded state is down. You do not have to read the status first to decide whether the call is safe.Response
object
The response containing the operation status.
Show Toggle object
Show Toggle object
string
The operation status (
success).{
"response": {
"status": "success"
}
}
Error Responses
string
The error code indicating the reason for the failure. Possible values:
DATABASE_NOT_FOUND: The specified database does not exist.ACCESS_DENIED: The user does not have permission to act on the database.OPERATION_IN_PROGRESS: Another lifecycle operation on the same database is already running (409). The container was not touched — wait a few seconds and retry. See Common Error Codes.
{
"code": "OPERATION_IN_PROGRESS"
}