@akamai/openapi-ts
    Preparing search index...

    Type Alias GetDatabasesPostgreSqlInstancesResponses

    type GetDatabasesPostgreSqlInstancesResponses = {
        "200": { page: number; pages: number; results: number } & {
            data: {
                allow_list: string[];
                cluster_size: 1 | 2 | 3;
                created: string;
                encrypted: boolean;
                engine: string;
                engine_config: {
                    pg: {
                        autovacuum_analyze_scale_factor: number;
                        autovacuum_analyze_threshold: number;
                        autovacuum_max_workers: number;
                        autovacuum_naptime: number;
                        autovacuum_vacuum_cost_delay: number;
                        autovacuum_vacuum_cost_limit: number;
                        autovacuum_vacuum_scale_factor: number;
                        autovacuum_vacuum_threshold: number;
                        bgwriter_delay: number;
                        bgwriter_flush_after: number;
                        bgwriter_lru_maxpages: number;
                        bgwriter_lru_multiplier: number;
                        deadlock_timeout: number;
                        default_toast_compression: "lz4" | "pglz";
                        idle_in_transaction_session_timeout: number;
                        jit: boolean;
                        max_files_per_process: number;
                        max_locks_per_transaction: number;
                        max_logical_replication_workers: number;
                        max_parallel_workers: number;
                        max_parallel_workers_per_gather: number;
                        max_pred_locks_per_transaction: number;
                        max_replication_slots: number;
                        max_slot_wal_keep_size: number;
                        max_stack_depth: number;
                        max_standby_archive_delay: number;
                        max_standby_streaming_delay: number;
                        max_wal_senders: number;
                        max_worker_processes: number;
                        password_encryption: "scram-sh-256" | "md5";
                        "pg_partman_bgw.interval": number;
                        "pg_partman_bgw.role": string;
                        "pg_stat_monitor.pgsm_enable_query_plan": boolean;
                        "pg_stat_monitor.pgsm_max_buckets": number;
                        "pg_stat_statements.track": "all" | "top" | "none";
                        temp_file_limit: number;
                        timezone: string;
                        track_activity_query_size: number;
                        track_commit_timestamp: "on" | "off";
                        track_functions: "all" | "pl" | "none";
                        track_io_timing: "on" | "off";
                        wal_sender_timeout: number;
                        wal_writer_delay: number;
                    };
                    pg_stat_monitor_enable: boolean;
                    pglookout: { max_failover_replication_time_lag: number };
                    shared_buffers_percentage: number;
                    work_mem: number;
                };
                fork: { restore_time: string; source: number };
                hosts: { primary: string | null; secondary: string | null };
                id: number;
                label: string;
                members: { [key: string]: unknown };
                oldest_restore_time: string;
                platform: "rdbms-legacy" | "rdbms-default";
                port: number;
                private_network:
                    | { public_access: boolean; subnet_id: number; vpc_id: number }
                    | null;
                region: string;
                ssl_connection: boolean;
                status:
                    | "provisioning"
                    | "active"
                    | "suspending"
                    | "suspended"
                    | "resuming"
                    | "failed"
                    | "degraded"
                    | "updating"
                    | "resizing";
                total_disk_size_gb: number;
                type: string;
                updated: string;
                updates: {
                    day_of_week: number;
                    duration: number;
                    frequency: "weekly";
                    hour_of_day: number;
                    pending: {
                        deadline: string
                        | null;
                        description: string;
                        planned_for: string | null;
                    }[];
                };
                used_disk_size_gb: number;
                version: string;
            }[];
        };
    }
    Index

    Properties

    Properties

    "200": { page: number; pages: number; results: number } & {
        data: {
            allow_list: string[];
            cluster_size: 1 | 2 | 3;
            created: string;
            encrypted: boolean;
            engine: string;
            engine_config: {
                pg: {
                    autovacuum_analyze_scale_factor: number;
                    autovacuum_analyze_threshold: number;
                    autovacuum_max_workers: number;
                    autovacuum_naptime: number;
                    autovacuum_vacuum_cost_delay: number;
                    autovacuum_vacuum_cost_limit: number;
                    autovacuum_vacuum_scale_factor: number;
                    autovacuum_vacuum_threshold: number;
                    bgwriter_delay: number;
                    bgwriter_flush_after: number;
                    bgwriter_lru_maxpages: number;
                    bgwriter_lru_multiplier: number;
                    deadlock_timeout: number;
                    default_toast_compression: "lz4" | "pglz";
                    idle_in_transaction_session_timeout: number;
                    jit: boolean;
                    max_files_per_process: number;
                    max_locks_per_transaction: number;
                    max_logical_replication_workers: number;
                    max_parallel_workers: number;
                    max_parallel_workers_per_gather: number;
                    max_pred_locks_per_transaction: number;
                    max_replication_slots: number;
                    max_slot_wal_keep_size: number;
                    max_stack_depth: number;
                    max_standby_archive_delay: number;
                    max_standby_streaming_delay: number;
                    max_wal_senders: number;
                    max_worker_processes: number;
                    password_encryption: "scram-sh-256" | "md5";
                    "pg_partman_bgw.interval": number;
                    "pg_partman_bgw.role": string;
                    "pg_stat_monitor.pgsm_enable_query_plan": boolean;
                    "pg_stat_monitor.pgsm_max_buckets": number;
                    "pg_stat_statements.track": "all" | "top" | "none";
                    temp_file_limit: number;
                    timezone: string;
                    track_activity_query_size: number;
                    track_commit_timestamp: "on" | "off";
                    track_functions: "all" | "pl" | "none";
                    track_io_timing: "on" | "off";
                    wal_sender_timeout: number;
                    wal_writer_delay: number;
                };
                pg_stat_monitor_enable: boolean;
                pglookout: { max_failover_replication_time_lag: number };
                shared_buffers_percentage: number;
                work_mem: number;
            };
            fork: { restore_time: string; source: number };
            hosts: { primary: string | null; secondary: string | null };
            id: number;
            label: string;
            members: { [key: string]: unknown };
            oldest_restore_time: string;
            platform: "rdbms-legacy" | "rdbms-default";
            port: number;
            private_network:
                | { public_access: boolean; subnet_id: number; vpc_id: number }
                | null;
            region: string;
            ssl_connection: boolean;
            status:
                | "provisioning"
                | "active"
                | "suspending"
                | "suspended"
                | "resuming"
                | "failed"
                | "degraded"
                | "updating"
                | "resizing";
            total_disk_size_gb: number;
            type: string;
            updated: string;
            updates: {
                day_of_week: number;
                duration: number;
                frequency: "weekly";
                hour_of_day: number;
                pending: {
                    deadline: string
                    | null;
                    description: string;
                    planned_for: string | null;
                }[];
            };
            used_disk_size_gb: number;
            version: string;
        }[];
    }

    Returns a paginated list of all accessible PostgreSQL Managed Databases on your account.

    Type Declaration

    • Readonlypage: number

      Read-only The current page.

    • Readonlypages: number

      Read-only The total number of pages.

    • Readonlyresults: number

      Read-only The total number of results.

    • data: {
          allow_list: string[];
          cluster_size: 1 | 2 | 3;
          created: string;
          encrypted: boolean;
          engine: string;
          engine_config: {
              pg: {
                  autovacuum_analyze_scale_factor: number;
                  autovacuum_analyze_threshold: number;
                  autovacuum_max_workers: number;
                  autovacuum_naptime: number;
                  autovacuum_vacuum_cost_delay: number;
                  autovacuum_vacuum_cost_limit: number;
                  autovacuum_vacuum_scale_factor: number;
                  autovacuum_vacuum_threshold: number;
                  bgwriter_delay: number;
                  bgwriter_flush_after: number;
                  bgwriter_lru_maxpages: number;
                  bgwriter_lru_multiplier: number;
                  deadlock_timeout: number;
                  default_toast_compression: "lz4" | "pglz";
                  idle_in_transaction_session_timeout: number;
                  jit: boolean;
                  max_files_per_process: number;
                  max_locks_per_transaction: number;
                  max_logical_replication_workers: number;
                  max_parallel_workers: number;
                  max_parallel_workers_per_gather: number;
                  max_pred_locks_per_transaction: number;
                  max_replication_slots: number;
                  max_slot_wal_keep_size: number;
                  max_stack_depth: number;
                  max_standby_archive_delay: number;
                  max_standby_streaming_delay: number;
                  max_wal_senders: number;
                  max_worker_processes: number;
                  password_encryption: "scram-sh-256" | "md5";
                  "pg_partman_bgw.interval": number;
                  "pg_partman_bgw.role": string;
                  "pg_stat_monitor.pgsm_enable_query_plan": boolean;
                  "pg_stat_monitor.pgsm_max_buckets": number;
                  "pg_stat_statements.track": "all" | "top" | "none";
                  temp_file_limit: number;
                  timezone: string;
                  track_activity_query_size: number;
                  track_commit_timestamp: "on" | "off";
                  track_functions: "all" | "pl" | "none";
                  track_io_timing: "on" | "off";
                  wal_sender_timeout: number;
                  wal_writer_delay: number;
              };
              pg_stat_monitor_enable: boolean;
              pglookout: { max_failover_replication_time_lag: number };
              shared_buffers_percentage: number;
              work_mem: number;
          };
          fork: { restore_time: string; source: number };
          hosts: { primary: string | null; secondary: string | null };
          id: number;
          label: string;
          members: { [key: string]: unknown };
          oldest_restore_time: string;
          platform: "rdbms-legacy" | "rdbms-default";
          port: number;
          private_network:
              | { public_access: boolean; subnet_id: number; vpc_id: number }
              | null;
          region: string;
          ssl_connection: boolean;
          status:
              | "provisioning"
              | "active"
              | "suspending"
              | "suspended"
              | "resuming"
              | "failed"
              | "degraded"
              | "updating"
              | "resizing";
          total_disk_size_gb: number;
          type: string;
          updated: string;
          updates: {
              day_of_week: number;
              duration: number;
              frequency: "weekly";
              hour_of_day: number;
              pending: {
                  deadline: string
                  | null;
                  description: string;
                  planned_for: string | null;
              }[];
          };
          used_disk_size_gb: number;
          version: string;
      }[]