Edit Database - Square Cloud

PATCH

databases

{database_id}

Edit Database

curl --request PATCH \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ram": 123
}
'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}"

payload = {
    "name": "<string>",
    "ram": 123
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', ram: 123})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'ram' => 123
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.squarecloud.app/v2/databases/{database_id}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status":"success"
}

string

required

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

Updates a database’s display name and/or its allocated memory without recreating the container or rotating its credentials, connection URL and port stay the same. At least one of name or ram must be present in the request body. Changing ram is applied live against the database’s cluster; it fails if the new value is invalid for the plan or engine. This does not restart the database. To check whether a memory change is reflected, see Get Database Info or Get Database Status. Rate limited to 1 update every 5 seconds per user.

Parameters

string

required

The ID of the database.

string

The name of the database. 1–32 characters — letters, numbers, underscores (_), hyphens (-) and spaces — and must include at least one letter, number or underscore.

int

The amount of RAM to allocate, in megabytes. Minimums: Redis 512 MB, MongoDB and PostgreSQL 1024 MB.

Response

string

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

{
  "status":"success"
}

Common errors

Code	HTTP	Meaning
`NO_UPDATE_DATA`	400	Neither `name` nor `ram` was provided in the request body.
`INVALID_NAME`	400	The new name fails the 1-32 character validation.
`INVALID_MEMORY`	400	The new `ram` value is not valid for this database’s engine or plan.
`DATABASE_NOT_FOUND`	404	The database does not exist or is not owned by the caller.
`INTERNAL_SERVER_ERROR`	500	The memory update could not be applied.

Delete DatabaseDelete a database hosted on Square Cloud.

Edit Database

curl --request PATCH \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ram": 123
}
'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}"

payload = {
    "name": "<string>",
    "ram": 123
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', ram: 123})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'ram' => 123
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.squarecloud.app/v2/databases/{database_id}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"ram\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status":"success"
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors