API

Update a PostgreSQL Managed Database

put
https://api.linode.com//databases/postgresql/instances/

Make changes to an existing PostgreSQL Managed Database.

  • The database's status needs to be active.

  • New values set in the allow_list overwrite existing values. To keep existing values, run the List PostgreSQL Managed Databases operation, store the allow_list addresses from the response, and include them with any new addresses in this operation.

  • Updates to your allow_list may take a short period of time to complete, making this operation inappropriate for rapid successive updates.

  • Also allows resizing the database cluster to a larger one. Clusters can't be resized to smaller plans.

  • All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed PostgreSQL Database. Use the updates object in this operation to modify the maintenance window for these updates.

  • If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the updates object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime.

  • Major upgrades are optional until the service reaches end of service, and can be done in place.

  • You can't update engine_config advanced parameter settings for a suspended database. You'll need to resume it first.

  • A successful request triggers a database_update event.

  • Beta. You can update an existing PostgreSQL Managed Database to move it to a Virtual Private Cloud (VPC) using the private_network object in the request. This support is in beta. Talk to your Akamai account team for more details.

    📘

    Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the Cloud Firewall documentation.

Permissions and scopes

To call this operation, you need the following:

  • Identity and access permissions. Your user needs these roles assigned. Learn more.

    • Roles: database_admin

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: databases:read_write

CLI

linode-cli databases postgresql-update 123 \
  --label example-db \
  --allow_list 203.0.113.1 \
  --allow_list 192.0.1.0/24 \
  --type g6-standard-1 \
  --updates.frequency weekly \
  --updates.duration 3 \
  --updates.hour_of_day 12 \
  --updates.day_of_week 4 \

Learn more

Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
integer
required

The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Body Params

Updated information for the Managed PostgreSQL Database.

allow_list
array of strings
length ≥ 0

Controls access to the Managed Database.

  • Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.

  • A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.

  • An empty array ([]) blocks all public and private connections to the Managed Database.

allow_list
engine_config
object

Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.

📘

Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the List PostgreSQL Managed Database advanced parameters operation to see an up-to-date list.

string
length between 3 and 32

Filterable A name used to identify the Managed Database. This needs to be unique per Managed Database engine type. For example, you could use database_1, database_2, and database_3 for three unique MySQL Managed Databases. You can also use these same names for three unique PostgreSQL Managed Databases. However, you can't repeat any of these names for either engine type.

private_network
object | null

Beta Restricts access on a PostgreSQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster.

string

Request re-sizing of your cluster to a Linode Type with more disk space. For example, you could request a Linode Type that uses a higher plan.

  • Needs to be a Linode Type with more disk space than your current Linode.

  • Resizing to a larger Linode Type can accrue additional cost. Review the price output from the List types operation for more information.

  • You can't update the allow_list and set a new type in the same request.

  • Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.

updates
object

Configuration settings for automated patch update maintenance for the Managed Database.

string

Filterable The Managed Database engine version.

Responses

Updated 2 months ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago