Get project config | Management API Reference

[Alpha] Get a project's service configuration

get/v2/projects/{ref}/config

Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. storage is read live from the storage service; the rest come from this platform's own records.

The fine-grained token must include the following permissions to access this endpoint:

database_config_read
database_read
database_ssl_config_read
database_network_restrictions_read
auth_config_read
data_api_config_read
realtime_config_read
storage_config_read

Path parameters

ref
Required
string
Project ref

Response codes

Response (200)

1
{
2
  "data": {
3
    "type": "project_config",
4
    "id": "lorem",
5
    "attributes": {
6
      "database": {
7
        "major_version": -9007199254740991,
8
        "ssl_enforced": true,
9
        "network_restrictions": {
10
          "entitlement": "disallowed",
11
          "status": "stored",
12
          "allowed_cidrs": [
13
            {
14
              "address": "lorem",
15
              "type": "v4"
16
            }
17
          ],
18
          "updated_at": "lorem",
19
          "applied_at": "lorem"
20
        },
21
        "postgres_settings": {
22
          "effective_cache_size": "lorem",
23
          "logical_decoding_work_mem": "lorem",
24
          "log_autovacuum_min_duration": "444444444444444444444444444444444444444444444444444",
25
          "log_checkpoints": true,
26
          "log_connections": true,
27
          "log_disconnections": true,
28
          "log_duration": true,
29
          "log_lock_waits": true,
30
          "log_recovery_conflict_waits": true,
31
          "log_replication_commands": true,
32
          "log_startup_progress_interval": "444444444444444444444444444444444444444444444444444",
33
          "log_temp_files": "lorem",
34
          "maintenance_work_mem": "lorem",
35
          "track_activity_query_size": "lorem",
36
          "max_connections": 1,
37
          "max_locks_per_transaction": 10,
38
          "max_logical_replication_workers": 0,
39
          "max_parallel_maintenance_workers": 0,
40
          "max_parallel_workers": 0,
41
          "max_parallel_workers_per_gather": 0,
42
          "max_replication_slots": -9007199254740991,
43
          "max_slot_wal_keep_size": "lorem",
44
          "max_standby_archive_delay": "lorem",
45
          "max_standby_streaming_delay": "lorem",
46
          "max_sync_workers_per_subscription": 0,
47
          "max_wal_size": "lorem",
48
          "max_wal_senders": -9007199254740991,
49
          "max_worker_processes": 0,
50
          "session_replication_role": "origin",
51
          "shared_buffers": "lorem",
52
          "statement_timeout": "444444444444444444444444444444444444444444444444444",
53
          "track_commit_timestamp": true,
54
          "wal_keep_size": "lorem",
55
          "wal_sender_timeout": "444444444444444444444444444444444444444444444444444",
56
          "work_mem": "lorem",
57
          "checkpoint_timeout": "444444444444444444444444444444444444444444444444444",
58
          "hot_standby_feedback": true,
59
          "cron_log_statement": true
60
        }
61
      },
62
      "pooler": {
63
        "pool_mode": "transaction",
64
        "ignore_startup_parameters": "lorem",
65
        "server_idle_timeout": -9007199254740991,
66
        "server_lifetime": -9007199254740991,
67
        "query_wait_timeout": -9007199254740991,
68
        "reserve_pool_size": -9007199254740991,
69
        "default_pool_size": -9007199254740991,
70
        "max_client_conn": -9007199254740991
71
      },
72
      "auth": {
73
        "property1": null,
74
        "property2": null
75
      },
76
      "api": {
77
        "db_schema": "lorem",
78
        "db_extra_search_path": "lorem",
79
        "max_rows": -9007199254740991,
80
        "db_pool_acquisition_timeout": -9007199254740991,
81
        "db_pool": -9007199254740991
82
      },
83
      "realtime": {
84
        "private_only": true,
85
        "max_concurrent_users": -9007199254740991,
86
        "max_events_per_second": -9007199254740991,
87
        "max_bytes_per_second": -9007199254740991,
88
        "max_channels_per_client": -9007199254740991,
89
        "max_joins_per_second": -9007199254740991,
90
        "max_presence_events_per_second": -9007199254740991,
91
        "max_payload_size_in_kb": -9007199254740991,
92
        "presence_enabled": true,
93
        "suspend": true,
94
        "connection_pool": -9007199254740991,
95
        "postgres_changes_pool": -9007199254740991
96
      },
97
      "storage": {
98
        "file_size_limit": -9007199254740991,
99
        "features": {
100
          "image_transformation": {
101
            "enabled": true
102
          },
103
          "s3_protocol": {
104
            "enabled": true
105
          },
106
          "purge_cache": {
107
            "enabled": true
108
          },
109
          "iceberg_catalog": {
110
            "enabled": true,
111
            "max_namespaces": -9007199254740991,
112
            "max_tables": -9007199254740991,
113
            "max_catalogs": -9007199254740991
114
          },
115
          "vector_buckets": {
116
            "enabled": true,
117
            "max_buckets": -9007199254740991,
118
            "max_indexes": -9007199254740991
119
          }
120
        },
121
        "capabilities": {
122
          "list_v2": true,
123
          "iceberg_catalog": true
124
        },
125
        "upstream_target": "main",
126
        "migration_version": "lorem",
127
        "database_pool_mode": "lorem"
128
      }
129
    }
130
  }
131
}