rds.extensions.list

List supported extensions with installed and available versions, preload state and whether a restart is pending

GET /rds/api/instances/{id}/extensionsIAM rds:DescribeDBExtensionsRead

Request syntax

GET /rds/api/instances/{id}/extensions

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Query parameters

  • databaseOptional

    string

    Database inside the instance; omitted: the one created with the instance

    Constraints: 1-63 chars

Response

200 with database, databases, topology, preload, restartRequired and extensions: name, description, category, available, enabled, defaultVersion, installedVersion, schema, preloadLibrary, preloaded, restartPending, … .

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • databaseAlways

    string

    Database read
  • databasesAlways

    array of string

    Every database on the server
  • topologyAlways

    one of single, cluster

    Topology of the database
  • preloadAlways

    object

    shared_preload_libraries
  • preload.​runningAlways

    array of string

    Libraries the running server loaded: the ones in effect
  • preload.​configuredAlways

    array of string

    Libraries configured; differ from running until a restart
  • restartRequiredAlways

    boolean

    The preload list changed and waits for a restart
  • extensionsAlways

    array of object

    Every supported extension
  • extensions[].​nameAlways

    string

    Name CREATE EXTENSION takes
  • extensions[].​descriptionAlways

    string

    What it does
  • extensions[].​categoryAlways

    one of ai, search, types, geo, indexing, jobs, monitoring, security, fdw, dev, utility

    Group it is shown in
  • extensions[].​sourceAlways

    one of contrib, pgdg

    contrib: ships with PostgreSQL; pgdg: an extra package
  • extensions[].​trustedAlways

    boolean

    Any role with CREATE on the database can create it
  • extensions[].​requiresAlways

    array of string

    Extensions it needs, installed with it
  • extensions[].​noteAlways

    string, may be null

    What to know before switching it on
  • extensions[].​preloadLibraryAlways

    string, may be null

    Library it needs preloaded; null: none
  • extensions[].​preloadedAlways

    boolean, may be null

    That library is loaded now; null: it needs none
  • extensions[].​singleDatabaseAlways

    boolean

    Can live in one database of the server only
  • extensions[].​homeDatabaseAlways

    string, may be null

    For a single-database extension: the database it may live in
  • extensions[].​availableAlways

    boolean

    Installed on the server, so it can be enabled
  • extensions[].​defaultVersionAlways

    string

    Version CREATE EXTENSION installs
  • extensions[].​installedVersionAlways

    string, may be null

    Version enabled in this database; null: not enabled
  • extensions[].​schemaAlways

    string, may be null

    Schema it lives in
  • extensions[].​enabledAlways

    boolean

    Enabled in this database
  • extensions[].​restartPendingAlways

    boolean

    Its library was added and loads at the next restart

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow rds:DescribeDBExtensions on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud rds extensions list id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_extensions_list.