Update a PostgresAddon

Error

A valid request URL is required to generate request examples

{
  "outputs": [
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    },
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    }
  ],
  "annotations": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "created_at": "2000-01-23T04:56:07.000Z",
  "spec": {
    "databases": [
      {
        "extensions": [
          "vector",
          "vector"
        ],
        "name": "name"
      },
      {
        "extensions": [
          "vector",
          "vector"
        ],
        "name": "name"
      }
    ],
    "backup": {
      "object_store_id": "object_store_id",
      "schedule": "0 0 0 * * 0",
      "wal_archiving": false,
      "enabled": false
    },
    "instances": {
      "count": 1,
      "placement": {
        "node_selector": {
          "key": "node_selector"
        },
        "tolerations": [
          {
            "effect": "effect",
            "value": "value",
            "key": "key",
            "operator": "operator"
          },
          {
            "effect": "effect",
            "value": "value",
            "key": "key",
            "operator": "operator"
          }
        ],
        "topology_key": "kubernetes.io/hostname",
        "policy": "preferred"
      }
    },
    "configuration": {
      "enable_superuser_access": false,
      "parameters": {
        "max_connections": "200",
        "shared_buffers": "256MB",
        "work_mem": "4MB"
      }
    },
    "resources": {
      "memory": {
        "request": "request",
        "limit": "limit"
      },
      "cpu": {
        "request": "request",
        "limit": "limit"
      }
    },
    "initialization": {
      "import_from_external": {
        "database": "database",
        "databases_to_import": [
          "databases_to_import",
          "databases_to_import"
        ],
        "port": 5,
        "host": "host",
        "password_secret_id": "password_secret_id",
        "ssl_mode": "require",
        "username": "username"
      },
      "restore_from_object_store": {
        "object_store_id": "object_store_id",
        "source_postgres_addon_id": "source_postgres_addon_id",
        "recovery_target_time": "2000-01-23T04:56:07.000Z"
      },
      "type": "new",
      "restore_from_backup": {
        "backup_id": "backup_id"
      }
    },
    "storage": {
      "storage_class": "storage_class",
      "size": "size"
    },
    "version": {
      "major": 13,
      "minor": 6,
      "enable_auto_minor_upgrade": true,
      "enable_auto_major_upgrade": false
    }
  },
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "revision": "revision",
  "organisation_id": "organisation_id",
  "cluster_id": "cluster_id",
  "updated_at": "2000-01-23T04:56:07.000Z",
  "project_id": "project_id",
  "user_id": "user_id",
  "name": "name",
  "namespace": "namespace",
  "id": "id",
  "status": {
    "phase": "phase",
    "connection_info": {
      "databases": [
        {
          "owner": "owner",
          "name": "name"
        },
        {
          "owner": "owner",
          "name": "name"
        }
      ],
      "port": 2,
      "credentials": {
        "app_user_secrets": {
          "key": "app_user_secrets"
        },
        "ca_certificate_secret_id": "ca_certificate_secret_id",
        "superuser_secret_id": "superuser_secret_id"
      },
      "host": "host"
    },
    "state": "Pending",
    "message": "message",
    "conditions": [
      {
        "reason": "reason",
        "last_transition_time": "2000-01-23T04:56:07.000Z",
        "type": "type",
        "message": "message",
        "observed_generation": 1,
        "status": "status"
      },
      {
        "reason": "reason",
        "last_transition_time": "2000-01-23T04:56:07.000Z",
        "type": "type",
        "message": "message",
        "observed_generation": 1,
        "status": "status"
      }
    ],
    "cluster_info": {
      "version": "version"
    },
    "observed_revision": "observed_revision",
    "observed_generation": 5
  }
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

PUT

api

organizations

{org_id}

projects

{project_name}

addons

postgres

{id}

Error

A valid request URL is required to generate request examples

{
  "outputs": [
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    },
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    }
  ],
  "annotations": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "created_at": "2000-01-23T04:56:07.000Z",
  "spec": {
    "databases": [
      {
        "extensions": [
          "vector",
          "vector"
        ],
        "name": "name"
      },
      {
        "extensions": [
          "vector",
          "vector"
        ],
        "name": "name"
      }
    ],
    "backup": {
      "object_store_id": "object_store_id",
      "schedule": "0 0 0 * * 0",
      "wal_archiving": false,
      "enabled": false
    },
    "instances": {
      "count": 1,
      "placement": {
        "node_selector": {
          "key": "node_selector"
        },
        "tolerations": [
          {
            "effect": "effect",
            "value": "value",
            "key": "key",
            "operator": "operator"
          },
          {
            "effect": "effect",
            "value": "value",
            "key": "key",
            "operator": "operator"
          }
        ],
        "topology_key": "kubernetes.io/hostname",
        "policy": "preferred"
      }
    },
    "configuration": {
      "enable_superuser_access": false,
      "parameters": {
        "max_connections": "200",
        "shared_buffers": "256MB",
        "work_mem": "4MB"
      }
    },
    "resources": {
      "memory": {
        "request": "request",
        "limit": "limit"
      },
      "cpu": {
        "request": "request",
        "limit": "limit"
      }
    },
    "initialization": {
      "import_from_external": {
        "database": "database",
        "databases_to_import": [
          "databases_to_import",
          "databases_to_import"
        ],
        "port": 5,
        "host": "host",
        "password_secret_id": "password_secret_id",
        "ssl_mode": "require",
        "username": "username"
      },
      "restore_from_object_store": {
        "object_store_id": "object_store_id",
        "source_postgres_addon_id": "source_postgres_addon_id",
        "recovery_target_time": "2000-01-23T04:56:07.000Z"
      },
      "type": "new",
      "restore_from_backup": {
        "backup_id": "backup_id"
      }
    },
    "storage": {
      "storage_class": "storage_class",
      "size": "size"
    },
    "version": {
      "major": 13,
      "minor": 6,
      "enable_auto_minor_upgrade": true,
      "enable_auto_major_upgrade": false
    }
  },
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "revision": "revision",
  "organisation_id": "organisation_id",
  "cluster_id": "cluster_id",
  "updated_at": "2000-01-23T04:56:07.000Z",
  "project_id": "project_id",
  "user_id": "user_id",
  "name": "name",
  "namespace": "namespace",
  "id": "id",
  "status": {
    "phase": "phase",
    "connection_info": {
      "databases": [
        {
          "owner": "owner",
          "name": "name"
        },
        {
          "owner": "owner",
          "name": "name"
        }
      ],
      "port": 2,
      "credentials": {
        "app_user_secrets": {
          "key": "app_user_secrets"
        },
        "ca_certificate_secret_id": "ca_certificate_secret_id",
        "superuser_secret_id": "superuser_secret_id"
      },
      "host": "host"
    },
    "state": "Pending",
    "message": "message",
    "conditions": [
      {
        "reason": "reason",
        "last_transition_time": "2000-01-23T04:56:07.000Z",
        "type": "type",
        "message": "message",
        "observed_generation": 1,
        "status": "status"
      },
      {
        "reason": "reason",
        "last_transition_time": "2000-01-23T04:56:07.000Z",
        "type": "type",
        "message": "message",
        "observed_generation": 1,
        "status": "status"
      }
    ],
    "cluster_info": {
      "version": "version"
    },
    "observed_revision": "observed_revision",
    "observed_generation": 5
  }
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

org_id

string

required

The ID of the organization

project_name

string

required

The name of the project

string

required

The id of record

Body

application/json

name

string

required

Unique name for this PostgreSQL cluster

spec

object

required

Show child attributes

Example:

{
  "databases": [
    {
      "extensions": ["vector", "vector"],
      "name": "name"
    },
    {
      "extensions": ["vector", "vector"],
      "name": "name"
    }
  ],
  "backup": {
    "object_store_id": "object_store_id",
    "schedule": "0 0 0 * * 0",
    "wal_archiving": false,
    "enabled": false
  },
  "instances": {
    "count": 1,
    "placement": {
      "node_selector": { "key": "node_selector" },
      "tolerations": [
        {
          "effect": "effect",
          "value": "value",
          "key": "key",
          "operator": "operator"
        },
        {
          "effect": "effect",
          "value": "value",
          "key": "key",
          "operator": "operator"
        }
      ],
      "topology_key": "kubernetes.io/hostname",
      "policy": "preferred"
    }
  },
  "configuration": {
    "enable_superuser_access": false,
    "parameters": {
      "max_connections": "200",
      "shared_buffers": "256MB",
      "work_mem": "4MB"
    }
  },
  "resources": {
    "memory": { "request": "request", "limit": "limit" },
    "cpu": { "request": "request", "limit": "limit" }
  },
  "initialization": {
    "import_from_external": {
      "database": "database",
      "databases_to_import": [
        "databases_to_import",
        "databases_to_import"
      ],
      "port": 5,
      "host": "host",
      "password_secret_id": "password_secret_id",
      "ssl_mode": "require",
      "username": "username"
    },
    "restore_from_object_store": {
      "object_store_id": "object_store_id",
      "source_postgres_addon_id": "source_postgres_addon_id",
      "recovery_target_time": "2000-01-23T04:56:07.000Z"
    },
    "type": "new",
    "restore_from_backup": { "backup_id": "backup_id" }
  },
  "storage": {
    "storage_class": "storage_class",
    "size": "size"
  },
  "version": {
    "major": 13,
    "minor": 6,
    "enable_auto_minor_upgrade": true,
    "enable_auto_major_upgrade": false
  }
}

labels

object[]

Show child attributes

annotations

object[]

Show child attributes

status

object

Show child attributes

Example:

{
  "phase": "phase",
  "connection_info": {
    "databases": [
      { "owner": "owner", "name": "name" },
      { "owner": "owner", "name": "name" }
    ],
    "port": 2,
    "credentials": {
      "app_user_secrets": { "key": "app_user_secrets" },
      "ca_certificate_secret_id": "ca_certificate_secret_id",
      "superuser_secret_id": "superuser_secret_id"
    },
    "host": "host"
  },
  "state": "Pending",
  "message": "message",
  "conditions": [
    {
      "reason": "reason",
      "last_transition_time": "2000-01-23T04:56:07.000Z",
      "type": "type",
      "message": "message",
      "observed_generation": 1,
      "status": "status"
    },
    {
      "reason": "reason",
      "last_transition_time": "2000-01-23T04:56:07.000Z",
      "type": "type",
      "message": "message",
      "observed_generation": 1,
      "status": "status"
    }
  ],
  "cluster_info": { "version": "version" },
  "observed_revision": "observed_revision",
  "observed_generation": 5
}

Response

PostgresAddon updated successfully

name

string

required

Unique name for this PostgreSQL cluster

spec

object

required

Show child attributes

Example:

{
  "databases": [
    {
      "extensions": ["vector", "vector"],
      "name": "name"
    },
    {
      "extensions": ["vector", "vector"],
      "name": "name"
    }
  ],
  "backup": {
    "object_store_id": "object_store_id",
    "schedule": "0 0 0 * * 0",
    "wal_archiving": false,
    "enabled": false
  },
  "instances": {
    "count": 1,
    "placement": {
      "node_selector": { "key": "node_selector" },
      "tolerations": [
        {
          "effect": "effect",
          "value": "value",
          "key": "key",
          "operator": "operator"
        },
        {
          "effect": "effect",
          "value": "value",
          "key": "key",
          "operator": "operator"
        }
      ],
      "topology_key": "kubernetes.io/hostname",
      "policy": "preferred"
    }
  },
  "configuration": {
    "enable_superuser_access": false,
    "parameters": {
      "max_connections": "200",
      "shared_buffers": "256MB",
      "work_mem": "4MB"
    }
  },
  "resources": {
    "memory": { "request": "request", "limit": "limit" },
    "cpu": { "request": "request", "limit": "limit" }
  },
  "initialization": {
    "import_from_external": {
      "database": "database",
      "databases_to_import": [
        "databases_to_import",
        "databases_to_import"
      ],
      "port": 5,
      "host": "host",
      "password_secret_id": "password_secret_id",
      "ssl_mode": "require",
      "username": "username"
    },
    "restore_from_object_store": {
      "object_store_id": "object_store_id",
      "source_postgres_addon_id": "source_postgres_addon_id",
      "recovery_target_time": "2000-01-23T04:56:07.000Z"
    },
    "type": "new",
    "restore_from_backup": { "backup_id": "backup_id" }
  },
  "storage": {
    "storage_class": "storage_class",
    "size": "size"
  },
  "version": {
    "major": 13,
    "minor": 6,
    "enable_auto_minor_upgrade": true,
    "enable_auto_major_upgrade": false
  }
}

string

read-only

organisation_id

string

read-only

project_id

string

read-only

user_id

string

read-only

cluster_id

string

read-only

namespace

string

read-only

labels

object[]

Show child attributes

annotations

object[]

Show child attributes

revision

string

read-only

outputs

object[]

read-only

Show child attributes

status

object

Show child attributes

Example:

{
  "phase": "phase",
  "connection_info": {
    "databases": [
      { "owner": "owner", "name": "name" },
      { "owner": "owner", "name": "name" }
    ],
    "port": 2,
    "credentials": {
      "app_user_secrets": { "key": "app_user_secrets" },
      "ca_certificate_secret_id": "ca_certificate_secret_id",
      "superuser_secret_id": "superuser_secret_id"
    },
    "host": "host"
  },
  "state": "Pending",
  "message": "message",
  "conditions": [
    {
      "reason": "reason",
      "last_transition_time": "2000-01-23T04:56:07.000Z",
      "type": "type",
      "message": "message",
      "observed_generation": 1,
      "status": "status"
    },
    {
      "reason": "reason",
      "last_transition_time": "2000-01-23T04:56:07.000Z",
      "type": "type",
      "message": "message",
      "observed_generation": 1,
      "status": "status"
    }
  ],
  "cluster_info": { "version": "version" },
  "observed_revision": "observed_revision",
  "observed_generation": 5
}

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

⌘I

Authentication and users

Organizations, projects, and access

Source and registry integrations

Stacks and resources

Releases

Builds, logs, and metrics

Secrets, volumes, and object stores

PostgreSQL addons

Preview environments

Compute administration

Update a PostgresAddon

Authorizations

Path Parameters

Body

Response