Request primary to be recycled

POST /project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle

Request primary to be recycled

cURL

curl --request POST \
  --url https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle"

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

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

print(response.text)

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

fetch('https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle', 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.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle"

	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))

}

HttpResponse<String> response = Unirest.post("https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "flavor": "<string>",
  "ha_type": "<string>",
  "target_server_count": 123,
  "id": "pgn30gjk1d1e2jj34v9x0dq4rp",
  "location": "<string>",
  "name": "<string>",
  "state": "<string>",
  "storage_size_gib": 123,
  "vm_size": "<string>",
  "maintenance_window_start_at": 123,
  "read_replica": true,
  "fallback_active": true,
  "tags": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "connection_string": "<string>",
  "username": "<string>",
  "password": "<string>",
  "hostname": "<string>",
  "earliest_restore_time": "<string>",
  "firewall_rules": [
    {
      "cidr": "<string>",
      "id": "frmjgkgbktw62k53005jpx8tt7",
      "description": "<string>",
      "port": 123
    }
  ],
  "latest_restore_time": "<string>",
  "primary": true,
  "target_storage_size_gib": 123,
  "target_vm_size": "<string>",
  "ca_certificates": "<string>",
  "parent": "<string>"
}

{
  "error": {
    "code": 401,
    "message": "There was an error logging in",
    "type": "InvalidCredentials",
    "details": {}
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id · string · required

ID of the project

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$

Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

location · string · required

The Ubicloud location/region

Example:

"eu-central-h1"

postgres_database_reference · string · required

Postgres database ID or name Resource ID or name

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Response

200

application/json

A Postgres Database

flavor · string · required

Kind of Postgres database

ha_type · string · required

High availability type

target_server_count · integer · required

Target number of servers (primary + standbys)

id · string · required

ID of the Postgres database

Pattern: ^pg[0-9a-hj-km-np-tv-z]{24}$

Example:

"pgn30gjk1d1e2jj34v9x0dq4rp"

location · string · required

Location of the Postgres database

name · string · required

Name of the Postgres database

state · string · required

State of the Postgres database

storage_size_gib · integer · required

Storage size in GiB

version · enum<string> · required

Current Postgres version

Available options: 16, 17, 18

target_version · enum<string> · required

Target Postgres version

Available options: 16, 17, 18

vm_size · string · required

Size of the underlying VM

maintenance_window_start_at · integer | null · required

Maintenance window start time

read_replica · boolean · required

If the database is a read replica or not

fallback_active · boolean · required

Whether the primary server is running on a fallback instance type

tags · object[] · required

Tags of the Postgres database

Show child attributes

created_at · string<date-time> · required

Creation timestamp of the Postgres database

connection_string · string | null · required

Connection string to the Postgres database

username · string | null · required

Username for the Postgres database

password · string | null · required

Password for the Postgres database

hostname · string | null · required

Hostname for the Postgres database

earliest_restore_time · string | null · required

Earliest restore time (if primary)

firewall_rules · object[] · required

List of Postgres firewall rules

Show child attributes

latest_restore_time · string · required

Latest restore time (if primary)"

primary · boolean · required

Is the database primary

target_storage_size_gib · integer

Desired storage size in GiB

target_vm_size · string

Desired VM size

ca_certificates · string | null

CA certificates of the root CA used to issue postgres server certificates

parent · string | null

Parent Postgres database