pgbeam 0.3.6 → 0.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +31 -2
- package/dist/index.d.cts +440 -2
- package/dist/index.d.mts +440 -2
- package/dist/index.mjs +31 -2
- package/dist/operations.cjs +111 -17
- package/dist/operations.d.cts +381 -0
- package/dist/operations.d.mts +381 -0
- package/dist/operations.mjs +111 -17
- package/package.json +1 -1
package/dist/operations.mjs
CHANGED
|
@@ -490,7 +490,7 @@
|
|
|
490
490
|
"parameters": [],
|
|
491
491
|
"requestBodyType": "",
|
|
492
492
|
"requestBodyRequired": false,
|
|
493
|
-
"responseType": "{ plans: ({ annual_price?: number; description?: string; label: string; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; monthly_price: number; name: string; overage_text?: string; trial_days?: number })[] }",
|
|
493
|
+
"responseType": "{ plans: ({ annual_price?: number; description?: string; label: string; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; monthly_price: number; name: string; overage_text?: string; trial_days?: number })[] }",
|
|
494
494
|
"responseStatus": "200"
|
|
495
495
|
},
|
|
496
496
|
"getOrganizationPlan": {
|
|
@@ -510,7 +510,7 @@
|
|
|
510
510
|
],
|
|
511
511
|
"requestBodyType": "",
|
|
512
512
|
"requestBodyRequired": false,
|
|
513
|
-
"responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
|
|
513
|
+
"responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
|
|
514
514
|
"responseStatus": "200"
|
|
515
515
|
},
|
|
516
516
|
"getVercelInstallation": {
|
|
@@ -550,7 +550,7 @@
|
|
|
550
550
|
],
|
|
551
551
|
"requestBodyType": "{ spend_limit?: number }",
|
|
552
552
|
"requestBodyRequired": true,
|
|
553
|
-
"responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { bytes_per_month: number; included_seats: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
|
|
553
|
+
"responseType": "{ billing_provider?: \"stripe\" | \"vercel\" | \"aws\" | \"manual\"; created_at?: string; current_period_end?: string; custom_pricing?: boolean; enabled?: boolean; limits: { audit_retention_days: number; bytes_per_month: number; included_seats: number; max_agent_credentials: number; max_connections: number; max_databases: number; max_projects: number; max_query_shapes: number; queries_per_day: number; queries_per_second: number; sandbox_idle_seconds: number; sandbox_max_branches: number; sandbox_max_upstream_bytes: number; sandbox_ttl_seconds: number }; org_id: string; plan: \"starter\" | \"pro\" | \"scale\" | \"enterprise\"; spend_capped?: boolean; spend_capped_at?: string; spend_limit?: number; subscription_status?: \"none\" | \"active\" | \"trialing\" | \"past_due\" | \"canceled\" | \"unpaid\" | \"incomplete\" | \"incomplete_expired\" | \"paused\"; updated_at?: string }",
|
|
554
554
|
"responseStatus": "200"
|
|
555
555
|
},
|
|
556
556
|
"submitCancellationFeedback": {
|
|
@@ -1177,7 +1177,7 @@
|
|
|
1177
1177
|
],
|
|
1178
1178
|
"requestBodyType": "",
|
|
1179
1179
|
"requestBodyRequired": false,
|
|
1180
|
-
"responseType": "{ next_page_token?: string; policies: ({ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" })[] }",
|
|
1180
|
+
"responseType": "{ next_page_token?: string; policies: ({ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" })[] }",
|
|
1181
1181
|
"responseStatus": "200"
|
|
1182
1182
|
},
|
|
1183
1183
|
"createPolicyProfile": {
|
|
@@ -1195,9 +1195,9 @@
|
|
|
1195
1195
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1196
1196
|
}
|
|
1197
1197
|
],
|
|
1198
|
-
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1198
|
+
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1199
1199
|
"requestBodyRequired": true,
|
|
1200
|
-
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1200
|
+
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1201
1201
|
"responseStatus": "201"
|
|
1202
1202
|
},
|
|
1203
1203
|
"getPolicyProfile": {
|
|
@@ -1224,7 +1224,7 @@
|
|
|
1224
1224
|
],
|
|
1225
1225
|
"requestBodyType": "",
|
|
1226
1226
|
"requestBodyRequired": false,
|
|
1227
|
-
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1227
|
+
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1228
1228
|
"responseStatus": "200"
|
|
1229
1229
|
},
|
|
1230
1230
|
"updatePolicyProfile": {
|
|
@@ -1249,9 +1249,9 @@
|
|
|
1249
1249
|
"description": "Unique policy profile identifier (prefixed, e.g. pol_xxx)."
|
|
1250
1250
|
}
|
|
1251
1251
|
],
|
|
1252
|
-
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1252
|
+
"requestBodyType": "{ access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1253
1253
|
"requestBodyRequired": true,
|
|
1254
|
-
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1254
|
+
"responseType": "{ access_mode: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; created_at: string; egress_bytes_per_day?: number; id: string; masking_rules: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; project_id: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist: string[]; table_denylist: string[]; updated_at: string; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }",
|
|
1255
1255
|
"responseStatus": "200"
|
|
1256
1256
|
},
|
|
1257
1257
|
"deletePolicyProfile": {
|
|
@@ -1286,7 +1286,7 @@
|
|
|
1286
1286
|
"method": "POST",
|
|
1287
1287
|
"path": "/v1/projects/{project_id}/policy-evaluations",
|
|
1288
1288
|
"summary": "Dry-eval a policy against a SQL statement",
|
|
1289
|
-
"description": "Evaluates a single SQL statement against a policy
|
|
1289
|
+
"description": "Evaluates a single SQL statement against a policy (either a draft policy supplied inline or an existing policy referenced by id) and returns the decision the proxy would make: allow, block, mask, or row-filter. The evaluation reuses the data plane's own policy engine (the same parser, allow/block rules, row-filter rewriter, and masking analysis enforced on live agent sessions), so a what-if verdict matches real enforcement. Stateful checks a single-statement preview cannot model (per-region query and egress budgets, human approvals, and rollback/sandbox write routing) are reported as informational notes, not verdicts. This is a pure compute endpoint; it does not connect to the upstream database and persists nothing.",
|
|
1290
1290
|
"parameters": [
|
|
1291
1291
|
{
|
|
1292
1292
|
"name": "project_id",
|
|
@@ -1296,7 +1296,7 @@
|
|
|
1296
1296
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1297
1297
|
}
|
|
1298
1298
|
],
|
|
1299
|
-
"requestBodyType": "{ policy?: { access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }; policy_id?: string; sql: string }",
|
|
1299
|
+
"requestBodyType": "{ policy?: { access_mode?: \"read_only\" | \"read_write\"; approval_auto_max_rows?: number; approval_mode?: \"off\" | \"writes\" | \"ddl\" | \"all\"; approval_timeout_seconds?: number; budget_queries_per_day?: number; budget_queries_per_hour?: number; egress_bytes_per_day?: number; masking_rules?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\"; table: string })[]; max_affected_rows?: number; max_rows?: number; migration_safety?: \"off\" | \"warn\" | \"block\"; name: string; row_filters?: ({ predicate: string; table: string })[]; statement_rules?: { allow?: string[]; deny?: string[] }; statement_timeout_ms?: number; table_allowlist?: string[]; table_denylist?: string[]; write_mode?: \"normal\" | \"rollback\" | \"sandbox\" }; policy_id?: string; sql: string }",
|
|
1300
1300
|
"requestBodyRequired": true,
|
|
1301
1301
|
"responseType": "{ hint?: string; masked_columns?: ({ column: string; kind: \"redact\" | \"null\" | \"hash\" })[]; notes?: string[]; reason: string; rewritten_sql?: string; row_filter_predicate?: string; rule: string; verdict: \"allow\" | \"block\" | \"mask\" | \"row-filter\" }",
|
|
1302
1302
|
"responseStatus": "200"
|
|
@@ -1339,7 +1339,7 @@
|
|
|
1339
1339
|
],
|
|
1340
1340
|
"requestBodyType": "",
|
|
1341
1341
|
"requestBodyRequired": false,
|
|
1342
|
-
"responseType": "{ next_page_token?: string; projects: ({ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string })[]; total: number }",
|
|
1342
|
+
"responseType": "{ next_page_token?: string; projects: ({ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string })[]; total: number }",
|
|
1343
1343
|
"responseStatus": "200"
|
|
1344
1344
|
},
|
|
1345
1345
|
"createProject": {
|
|
@@ -1349,9 +1349,9 @@
|
|
|
1349
1349
|
"summary": "Create a project",
|
|
1350
1350
|
"description": "Creates a new project within the specified organization.",
|
|
1351
1351
|
"parameters": [],
|
|
1352
|
-
"requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; tags?: string[] }",
|
|
1352
|
+
"requestBodyType": "{ cloud?: \"aws\" | \"azure\" | \"gcp\"; database: { auto_read_routing?: boolean; cache_config?: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; host: string; name: string; password: string; pool_config?: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode?: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; username: string }; description?: string; name: string; org_id: string; self_hosted?: boolean; tags?: string[] }",
|
|
1353
1353
|
"requestBodyRequired": true,
|
|
1354
|
-
"responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
|
|
1354
|
+
"responseType": "{ database?: { auto_read_routing?: boolean; cache_config: { enabled: boolean; max_entries: number; swr_seconds: number; ttl_seconds: number }; connection_string?: string; created_at: string; host: string; id: string; name: string; pool_config: { max_active?: number; min_pool_size: number; pool_mode: \"session\" | \"transaction\" | \"statement\"; pool_size: number }; pool_region?: string; port: number; project_id: string; query_timeout_ms?: number; role?: \"primary\" | \"replica\"; ssl_mode: \"disable\" | \"allow\" | \"prefer\" | \"require\" | \"verify-ca\" | \"verify-full\"; updated_at: string; username: string }; project: { active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string } }",
|
|
1355
1355
|
"responseStatus": "201"
|
|
1356
1356
|
},
|
|
1357
1357
|
"getProject": {
|
|
@@ -1371,7 +1371,7 @@
|
|
|
1371
1371
|
],
|
|
1372
1372
|
"requestBodyType": "",
|
|
1373
1373
|
"requestBodyRequired": false,
|
|
1374
|
-
"responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
|
|
1374
|
+
"responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
|
|
1375
1375
|
"responseStatus": "200"
|
|
1376
1376
|
},
|
|
1377
1377
|
"updateProject": {
|
|
@@ -1389,9 +1389,9 @@
|
|
|
1389
1389
|
"description": "Unique project identifier (prefixed, e.g. prj_xxx)."
|
|
1390
1390
|
}
|
|
1391
1391
|
],
|
|
1392
|
-
"requestBodyType": "{ agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; default_policy_profile_id?: string; description?: string; name?: string; status?: \"active\" | \"suspended\" | \"deleted\"; tags?: string[] }",
|
|
1392
|
+
"requestBodyType": "{ agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; default_policy_profile_id?: string; description?: string; name?: string; residency?: \"any\" | \"us\" | \"eu\"; status?: \"active\" | \"suspended\" | \"deleted\"; tags?: string[] }",
|
|
1393
1393
|
"requestBodyRequired": true,
|
|
1394
|
-
"responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
|
|
1394
|
+
"responseType": "{ active_connections?: number; agents_disabled?: boolean; allowed_cidrs?: ({ cidr: string; label?: string })[]; burst_size?: number; cloud?: \"aws\" | \"azure\" | \"gcp\"; created_at: string; database_count?: number; default_policy_profile_id?: string; description?: string; id: string; max_connections?: number; name: string; org_id: string; proxy_host?: string; queries_per_second?: number; residency?: \"any\" | \"us\" | \"eu\"; self_hosted?: boolean; status: \"active\" | \"suspended\" | \"deleted\"; tags?: string[]; updated_at: string }",
|
|
1395
1395
|
"responseStatus": "200"
|
|
1396
1396
|
},
|
|
1397
1397
|
"deleteProject": {
|
|
@@ -1527,6 +1527,73 @@
|
|
|
1527
1527
|
"responseType": "",
|
|
1528
1528
|
"responseStatus": "204"
|
|
1529
1529
|
},
|
|
1530
|
+
"listSelfHostEnrollments": {
|
|
1531
|
+
"operationId": "listSelfHostEnrollments",
|
|
1532
|
+
"method": "GET",
|
|
1533
|
+
"path": "/v1/organizations/{org_id}/self-host-enrollments",
|
|
1534
|
+
"summary": "List self-host enrollments",
|
|
1535
|
+
"description": "Lists an organization's self-host enrollments. Tokens are never returned.",
|
|
1536
|
+
"parameters": [
|
|
1537
|
+
{
|
|
1538
|
+
"name": "org_id",
|
|
1539
|
+
"in": "path",
|
|
1540
|
+
"required": true,
|
|
1541
|
+
"type": "string",
|
|
1542
|
+
"description": "Unique organization identifier."
|
|
1543
|
+
}
|
|
1544
|
+
],
|
|
1545
|
+
"requestBodyType": "",
|
|
1546
|
+
"requestBodyRequired": false,
|
|
1547
|
+
"responseType": "{ enrollments: ({ created_at: string; created_by?: string; description?: string; id: string; last_seen_at?: string; org_id: string; region_label?: string; revoked_at?: string })[] }",
|
|
1548
|
+
"responseStatus": "200"
|
|
1549
|
+
},
|
|
1550
|
+
"createSelfHostEnrollment": {
|
|
1551
|
+
"operationId": "createSelfHostEnrollment",
|
|
1552
|
+
"method": "POST",
|
|
1553
|
+
"path": "/v1/organizations/{org_id}/self-host-enrollments",
|
|
1554
|
+
"summary": "Issue a self-host enrollment token",
|
|
1555
|
+
"description": "Issues an enrollment token a self-hosted (BYOC) proxy uses to authenticate to the control plane's config/audit gRPC stream. The token is returned once and cannot be retrieved again. Requires the Scale or enterprise plan.",
|
|
1556
|
+
"parameters": [
|
|
1557
|
+
{
|
|
1558
|
+
"name": "org_id",
|
|
1559
|
+
"in": "path",
|
|
1560
|
+
"required": true,
|
|
1561
|
+
"type": "string",
|
|
1562
|
+
"description": "Unique organization identifier."
|
|
1563
|
+
}
|
|
1564
|
+
],
|
|
1565
|
+
"requestBodyType": "{ description?: string; region_label?: string }",
|
|
1566
|
+
"requestBodyRequired": false,
|
|
1567
|
+
"responseType": "{ enrollment: { created_at: string; created_by?: string; description?: string; id: string; last_seen_at?: string; org_id: string; region_label?: string; revoked_at?: string }; token: string }",
|
|
1568
|
+
"responseStatus": "201"
|
|
1569
|
+
},
|
|
1570
|
+
"revokeSelfHostEnrollment": {
|
|
1571
|
+
"operationId": "revokeSelfHostEnrollment",
|
|
1572
|
+
"method": "DELETE",
|
|
1573
|
+
"path": "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}",
|
|
1574
|
+
"summary": "Revoke a self-host enrollment",
|
|
1575
|
+
"description": "Revokes an enrollment so its token can no longer authenticate a proxy. Connected proxies keep their last-known config until they reconnect.",
|
|
1576
|
+
"parameters": [
|
|
1577
|
+
{
|
|
1578
|
+
"name": "org_id",
|
|
1579
|
+
"in": "path",
|
|
1580
|
+
"required": true,
|
|
1581
|
+
"type": "string",
|
|
1582
|
+
"description": "Unique organization identifier."
|
|
1583
|
+
},
|
|
1584
|
+
{
|
|
1585
|
+
"name": "enrollment_id",
|
|
1586
|
+
"in": "path",
|
|
1587
|
+
"required": true,
|
|
1588
|
+
"type": "string",
|
|
1589
|
+
"description": "Unique enrollment identifier."
|
|
1590
|
+
}
|
|
1591
|
+
],
|
|
1592
|
+
"requestBodyType": "",
|
|
1593
|
+
"requestBodyRequired": false,
|
|
1594
|
+
"responseType": "",
|
|
1595
|
+
"responseStatus": "204"
|
|
1596
|
+
},
|
|
1530
1597
|
"listSupportCases": {
|
|
1531
1598
|
"operationId": "listSupportCases",
|
|
1532
1599
|
"method": "GET",
|
|
@@ -2144,6 +2211,18 @@
|
|
|
2144
2211
|
listRegions: {
|
|
2145
2212
|
method: "GET",
|
|
2146
2213
|
path: "/v1/regions"
|
|
2214
|
+
},
|
|
2215
|
+
listSelfHostEnrollments: {
|
|
2216
|
+
method: "GET",
|
|
2217
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments"
|
|
2218
|
+
},
|
|
2219
|
+
createSelfHostEnrollment: {
|
|
2220
|
+
method: "POST",
|
|
2221
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments"
|
|
2222
|
+
},
|
|
2223
|
+
revokeSelfHostEnrollment: {
|
|
2224
|
+
method: "DELETE",
|
|
2225
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}"
|
|
2147
2226
|
}
|
|
2148
2227
|
},
|
|
2149
2228
|
migrations: {
|
|
@@ -2514,6 +2593,21 @@ const operationsByPath = {
|
|
|
2514
2593
|
path: "/v1/databases/{database_id}/replicas/{replica_id}",
|
|
2515
2594
|
operationId: "deleteReplica"
|
|
2516
2595
|
},
|
|
2596
|
+
"GET /v1/organizations/{org_id}/self-host-enrollments": {
|
|
2597
|
+
method: "GET",
|
|
2598
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments",
|
|
2599
|
+
operationId: "listSelfHostEnrollments"
|
|
2600
|
+
},
|
|
2601
|
+
"POST /v1/organizations/{org_id}/self-host-enrollments": {
|
|
2602
|
+
method: "POST",
|
|
2603
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments",
|
|
2604
|
+
operationId: "createSelfHostEnrollment"
|
|
2605
|
+
},
|
|
2606
|
+
"DELETE /v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}": {
|
|
2607
|
+
method: "DELETE",
|
|
2608
|
+
path: "/v1/organizations/{org_id}/self-host-enrollments/{enrollment_id}",
|
|
2609
|
+
operationId: "revokeSelfHostEnrollment"
|
|
2610
|
+
},
|
|
2517
2611
|
"GET /v1/organizations/{org_id}/support/cases": {
|
|
2518
2612
|
method: "GET",
|
|
2519
2613
|
path: "/v1/organizations/{org_id}/support/cases",
|