athena_rs 3.3.0

Database gateway API
Documentation
# Actix route inventory


**Routes:** 101


| Method | Path                                                                         | Location                                  | Handler                                     |
| ------ | ---------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------- |
| GET    | `/`                                                                          | `../src/api/health.rs:613`                | `root`                                      |
| GET    | `/admin/admission-events`                                                    | `../src/api/admin/mod.rs:1369`            | `admin_list_admission_events`               |
| GET    | `/admin/api-key-clients`                                                     | `../src/api/admin/mod.rs:659`             | `admin_list_api_key_clients`                |
| DELETE | `/admin/api-key-clients/{client_name}`                                       | `../src/api/admin/mod.rs:706`             | `admin_delete_api_key_client`               |
| PUT    | `/admin/api-key-clients/{client_name}`                                       | `../src/api/admin/mod.rs:679`             | `admin_upsert_api_key_client`               |
| GET    | `/admin/api-key-config`                                                      | `../src/api/admin/mod.rs:609`             | `admin_get_api_key_config`                  |
| PUT    | `/admin/api-key-config`                                                      | `../src/api/admin/mod.rs:638`             | `admin_set_api_key_config`                  |
| GET    | `/admin/api-key-rights`                                                      | `../src/api/admin/mod.rs:506`             | `admin_list_api_key_rights`                 |
| POST   | `/admin/api-key-rights`                                                      | `../src/api/admin/mod.rs:523`             | `admin_create_api_key_right`                |
| DELETE | `/admin/api-key-rights/{id}`                                                 | `../src/api/admin/mod.rs:577`             | `admin_delete_api_key_right`                |
| PATCH  | `/admin/api-key-rights/{id}`                                                 | `../src/api/admin/mod.rs:544`             | `admin_update_api_key_right`                |
| GET    | `/admin/api-keys`                                                            | `../src/api/admin/mod.rs:347`             | `admin_list_api_keys`                       |
| POST   | `/admin/api-keys`                                                            | `../src/api/admin/mod.rs:364`             | `admin_create_api_key`                      |
| DELETE | `/admin/api-keys/{id}`                                                       | `../src/api/admin/mod.rs:474`             | `admin_delete_api_key`                      |
| PATCH  | `/admin/api-keys/{id}`                                                       | `../src/api/admin/mod.rs:412`             | `admin_update_api_key`                      |
| GET    | `/admin/backups`                                                             | `../src/api/backup/mod.rs:2021`           | `admin_list_backups`                        |
| POST   | `/admin/backups`                                                             | `../src/api/backup/mod.rs:1686`           | `admin_create_backup`                       |
| GET    | `/admin/backups/config`                                                      | `../src/api/backup/mod.rs:1992`           | `admin_backup_config`                       |
| GET    | `/admin/backups/jobs`                                                        | `../src/api/backup/mod.rs:2141`           | `admin_list_backup_jobs`                    |
| DELETE | `/admin/backups/jobs/{id}`                                                   | `../src/api/backup/mod.rs:2369`           | `admin_delete_backup_job`                   |
| GET    | `/admin/backups/jobs/{id}`                                                   | `../src/api/backup/mod.rs:2203`           | `admin_get_backup_job`                      |
| POST   | `/admin/backups/jobs/{id}/cancel`                                            | `../src/api/backup/mod.rs:2271`           | `admin_cancel_backup_job`                   |
| GET    | `/admin/backups/schedules`                                                   | `../src/api/backup/mod.rs:2878`           | `admin_list_schedules`                      |
| POST   | `/admin/backups/schedules`                                                   | `../src/api/backup/mod.rs:2898`           | `admin_create_schedule`                     |
| DELETE | `/admin/backups/schedules/{id}`                                              | `../src/api/backup/mod.rs:3044`           | `admin_delete_schedule`                     |
| PATCH  | `/admin/backups/schedules/{id}`                                              | `../src/api/backup/mod.rs:2964`           | `admin_update_schedule`                     |
| DELETE | `/admin/backups/{key:.*}`                                                    | `../src/api/backup/mod.rs:2748`           | `admin_delete_backup`                       |
| GET    | `/admin/backups/{key:.*}/download`                                           | `../src/api/backup/mod.rs:2671`           | `admin_download_backup`                     |
| POST   | `/admin/backups/{key:.*}/restore`                                            | `../src/api/backup/mod.rs:2460`           | `admin_restore_backup`                      |
| GET    | `/admin/clients`                                                             | `../src/api/admin/mod.rs:735`             | `admin_list_clients`                        |
| POST   | `/admin/clients`                                                             | `../src/api/admin/mod.rs:764`             | `admin_create_client`                       |
| GET    | `/admin/clients/statistics`                                                  | `../src/api/admin/mod.rs:978`             | `admin_list_client_statistics`              |
| POST   | `/admin/clients/statistics/refresh`                                          | `../src/api/admin/mod.rs:1001`            | `admin_refresh_client_statistics`           |
| DELETE | `/admin/clients/{client_name}`                                               | `../src/api/admin/mod.rs:945`             | `admin_delete_client`                       |
| PATCH  | `/admin/clients/{client_name}`                                               | `../src/api/admin/mod.rs:841`             | `admin_update_client`                       |
| PUT    | `/admin/clients/{client_name}/freeze`                                        | `../src/api/admin/mod.rs:903`             | `admin_freeze_client`                       |
| GET    | `/admin/clients/{client_name}/query-optimizations`                           | `../src/api/admin/mod.rs:1135`            | `admin_list_client_query_optimizations`     |
| POST   | `/admin/clients/{client_name}/query-optimizations/refresh`                   | `../src/api/admin/mod.rs:1187`            | `admin_refresh_client_query_optimizations`  |
| GET    | `/admin/clients/{client_name}/query-optimizations/runs`                      | `../src/api/admin/mod.rs:1224`            | `admin_list_client_query_optimization_runs` |
| POST   | `/admin/clients/{client_name}/query-optimizations/{recommendation_id}/apply` | `../src/api/admin/mod.rs:1261`            | `admin_apply_client_query_optimization`     |
| GET    | `/admin/clients/{client_name}/statistics`                                    | `../src/api/admin/mod.rs:1028`            | `admin_get_client_statistics`               |
| GET    | `/admin/clients/{client_name}/statistics/drilldown`                          | `../src/api/admin/mod.rs:1071`            | `admin_get_client_statistics_drilldown`     |
| POST   | `/admin/provision`                                                           | `../src/api/provision.rs:530`             | `admin_provision`                           |
| POST   | `/admin/provision/instances`                                                 | `../src/api/provision.rs:796`             | `admin_spin_up_postgres_instance`           |
| DELETE | `/admin/provision/instances/{container_name}`                                | `../src/api/provision.rs:1501`            | `admin_delete_postgres_instance`            |
| GET    | `/admin/provision/instances/{container_name}`                                | `../src/api/provision.rs:1418`            | `admin_get_postgres_instance_status`        |
| GET    | `/admin/provision/local/databases`                                           | `../src/api/provision.rs:660`             | `admin_list_local_cluster_databases`        |
| POST   | `/admin/provision/local/databases`                                           | `../src/api/provision.rs:696`             | `admin_create_local_cluster_database`       |
| POST   | `/admin/provision/providers/neon`                                            | `../src/api/provision.rs:886`             | `admin_provision_neon`                      |
| POST   | `/admin/provision/providers/railway`                                         | `../src/api/provision.rs:1014`            | `admin_provision_railway`                   |
| POST   | `/admin/provision/providers/render`                                          | `../src/api/provision.rs:1289`            | `admin_provision_render`                    |
| GET    | `/admin/provision/status`                                                    | `../src/api/provision.rs:597`             | `admin_provision_status`                    |
| GET    | `/admin/vacuum-health`                                                       | `../src/api/admin/mod.rs:1311`            | `admin_list_vacuum_health`                  |
| GET    | `/admin/vacuum-health/{client_name}`                                         | `../src/api/admin/mod.rs:1333`            | `admin_get_vacuum_health`                   |
| POST   | `/api/v2/supabase/ssl_enforcement`                                           | `../src/api/supabase.rs:126`              | `ssl_enforcement`                           |
| GET    | `/clients`                                                                   | `../src/api/schema.rs:62`                 | `list_clients_protected`                    |
| GET    | `/data`                                                                      | `../src/api/gateway/fetch/get_data.rs:22` | `get_data_route`                            |
| GET    | `/docs`                                                                      | `../src/api/mod.rs:86`                    | `athena_docs`                               |
| POST   | `/gateway/data`                                                              | `../src/api/gateway/fetch/routes.rs:490`  | `fetch_data_route`                          |
| GET    | `/gateway/deferred/{request_id}`                                             | `../src/api/gateway/deferred.rs:467`      | `gateway_deferred_status`                   |
| POST   | `/gateway/deferred/{request_id}/requeue`                                     | `../src/api/gateway/deferred.rs:365`      | `gateway_deferred_requeue`                  |
| DELETE | `/gateway/delete`                                                            | `../src/api/gateway/delete/mod.rs:35`     | `delete_data`                               |
| POST   | `/gateway/fetch`                                                             | `../src/api/gateway/fetch/routes.rs:500`  | `proxy_fetch_data_route`                    |
| PUT    | `/gateway/insert`                                                            | `../src/api/gateway/insert/mod.rs:261`    | `insert_data`                               |
| PUT    | `/gateway/insert`                                                            | `../src/api/gateway/update/mod.rs:34`     | `insert_data`                               |
| POST   | `/gateway/query`                                                             | `../src/api/gateway/query/mod.rs:45`      | `gateway_query_route`                       |
| POST   | `/gateway/update`                                                            | `../src/api/gateway/fetch/update.rs:356`  | `gateway_update_route`                      |
| GET    | `/health/cluster`                                                            | `../src/api/health.rs:866`                | `cluster_health`                            |
| GET    | `/management/capabilities`                                                   | `../src/api/management/mod.rs:743`        | `management_capabilities_route`             |
| POST   | `/management/extensions/install`                                             | `../src/api/management/mod.rs:257`        | `management_install_extension`              |
| POST   | `/management/indexes`                                                        | `../src/api/management/mod.rs:2331`       | `management_create_index`                   |
| DELETE | `/management/indexes/{index_name}`                                           | `../src/api/management/mod.rs:2514`       | `management_drop_index`                     |
| GET    | `/management/provision/local/databases`                                      | `../src/api/management/mod.rs:791`        | `management_list_local_cluster_databases`   |
| POST   | `/management/provision/local/databases`                                      | `../src/api/management/mod.rs:863`        | `management_create_local_cluster_database`  |
| POST   | `/management/provision/providers/neon`                                       | `../src/api/management/mod.rs:1006`       | `management_provision_neon`                 |
| POST   | `/management/provision/providers/railway`                                    | `../src/api/management/mod.rs:1174`       | `management_provision_railway`              |
| POST   | `/management/provision/providers/render`                                     | `../src/api/management/mod.rs:1505`       | `management_provision_render`               |
| POST   | `/management/tables`                                                         | `../src/api/management/mod.rs:1674`       | `management_create_table`                   |
| DELETE | `/management/tables/{table_name}`                                            | `../src/api/management/mod.rs:2006`       | `management_drop_table`                     |
| PATCH  | `/management/tables/{table_name}`                                            | `../src/api/management/mod.rs:1844`       | `management_edit_table`                     |
| DELETE | `/management/tables/{table_name}/columns/{column_name}`                      | `../src/api/management/mod.rs:2166`       | `management_drop_column`                    |
| GET    | `/metrics`                                                                   | `../src/api/metrics.rs:730`               | `prometheus_metrics`                        |
| GET    | `/openapi-wss.yaml`                                                          | `../src/api/mod.rs:76`                    | `athena_wss_openapi_host`                   |
| GET    | `/openapi.yaml`                                                              | `../src/api/mod.rs:68`                    | `athena_openapi_host`                       |
| GET    | `/ping`                                                                      | `../src/api/health.rs:871`                | `ping`                                      |
| POST   | `/pipelines`                                                                 | `../src/api/pipelines/mod.rs:543`         | `run_pipeline`                              |
| POST   | `/pipelines/simulate`                                                        | `../src/api/pipelines/mod.rs:553`         | `simulate_pipeline`                         |
| GET    | `/pipelines/templates`                                                       | `../src/api/pipelines/mod.rs:565`         | `list_pipeline_templates`                   |
| POST   | `/query/sql`                                                                 | `../src/api/query/sql/mod.rs:128`         | `sql_query`                                 |
| GET    | `/registry`                                                                  | `../src/api/registry/mod.rs:16`           | `api_registry`                              |
| GET    | `/registry/{api_registry_id}`                                                | `../src/api/registry/mod.rs:62`           | `api_registry_by_id`                        |
| DELETE | `/rest/v1/{table}`                                                           | `../src/api/gateway/postgrest/mod.rs:269` | `postgrest_delete_route`                    |
| GET    | `/rest/v1/{table}`                                                           | `../src/api/gateway/postgrest/mod.rs:36`  | `postgrest_get_route`                       |
| PATCH  | `/rest/v1/{table}`                                                           | `../src/api/gateway/postgrest/mod.rs:181` | `postgrest_patch_route`                     |
| POST   | `/rest/v1/{table}`                                                           | `../src/api/gateway/postgrest/mod.rs:104` | `postgrest_post_route`                      |
| GET    | `/router/registry`                                                           | `../src/api/mod.rs:53`                    | `athena_router_registry`                    |
| GET    | `/schema/clients`                                                            | `../src/api/schema.rs:44`                 | `schema_clients`                            |
| GET    | `/schema/columns`                                                            | `../src/api/schema.rs:133`                | `schema_columns`                            |
| GET    | `/schema/migrations`                                                         | `../src/api/schema.rs:236`                | `schema_migrations`                         |
| GET    | `/schema/tables`                                                             | `../src/api/schema.rs:75`                 | `schema_tables`                             |
| GET    | `/wss/info`                                                                  | `../src/wss/mod.rs:37`                    | `gateway_wss_info`                          |