@@ -922,9 +922,25 @@ paths:
922
922
summary : Delete a database
923
923
description : |
924
924
Soft deletes a database.
925
- The database is scheduled for deletion and unavailable for querying.
925
+ The database is scheduled for deletion and unavailable for querying.
926
+ Use the `hard_delete_at` parameter to schedule a hard deletion.
926
927
parameters :
927
928
- $ref : ' #/components/parameters/db'
929
+ - name : hard_delete_at
930
+ in : query
931
+ required : false
932
+ schema :
933
+ type : string
934
+ format : date-time
935
+ description : |
936
+ Schedule the database for hard deletion at the specified time.
937
+ If not provided, the database will be soft deleted.
938
+ Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z").
939
+
940
+ #### Deleting a database cannot be undone
941
+
942
+ Deleting a database is a destructive action.
943
+ Once a database is deleted, data stored in that database cannot be recovered.
928
944
responses :
929
945
' 200 ' :
930
946
description : Success. Database deleted.
@@ -961,14 +977,30 @@ paths:
961
977
summary : Delete a table
962
978
description : |
963
979
Soft deletes a table.
964
- The table is scheduled for deletion and unavailable for querying.
980
+ The table is scheduled for deletion and unavailable for querying.
981
+ Use the `hard_delete_at` parameter to schedule a hard deletion.
982
+
983
+ #### Deleting a table cannot be undone
984
+
985
+ Deleting a table is a destructive action.
986
+ Once a table is deleted, data stored in that table cannot be recovered.
965
987
parameters :
966
988
- $ref : ' #/components/parameters/db'
967
989
- name : table
968
990
in : query
969
991
required : true
970
992
schema :
971
993
type : string
994
+ - name : hard_delete_at
995
+ in : query
996
+ required : false
997
+ schema :
998
+ type : string
999
+ format : date-time
1000
+ description : |
1001
+ Schedule the table for hard deletion at the specified time.
1002
+ If not provided, the table will be soft deleted.
1003
+ Use ISO 8601 format (for example, "2025-12-31T23:59:59Z").
972
1004
responses :
973
1005
' 200 ' :
974
1006
description : Success (no content). The table has been deleted.
@@ -1078,7 +1110,7 @@ paths:
1078
1110
In `"cron:CRON_EXPRESSION"`, `CRON_EXPRESSION` uses extended 6-field cron format.
1079
1111
The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to Friday).
1080
1112
value :
1081
- db : DATABASE_NAME
1113
+ db : mydb
1082
1114
plugin_filename : schedule.py
1083
1115
trigger_name : schedule_cron_trigger
1084
1116
trigger_specification : cron:0 0 6 * * 1-5
@@ -1136,7 +1168,7 @@ paths:
1136
1168
db : mydb
1137
1169
plugin_filename : request.py
1138
1170
trigger_name : hello_world_trigger
1139
- trigger_specification : path :hello-world
1171
+ trigger_specification : request :hello-world
1140
1172
cron_friday_afternoon :
1141
1173
summary : Cron trigger for Friday afternoons
1142
1174
description : |
@@ -1365,16 +1397,16 @@ paths:
1365
1397
description : Plugin not enabled.
1366
1398
tags :
1367
1399
- Processing engine
1368
- /api/v3/engine/{plugin_path } :
1400
+ /api/v3/engine/{request_path } :
1369
1401
parameters :
1370
- - name : plugin_path
1402
+ - name : request_path
1371
1403
description : |
1372
- The path configured in the request trigger specification "path:<plugin_path>"` for the plugin.
1404
+ The path configured in the request trigger specification for the plugin.
1373
1405
1374
1406
For example, if you define a trigger with the following:
1375
1407
1376
1408
```json
1377
- trigger-spec : "path :hello-world"
1409
+ trigger_specification : "request :hello-world"
1378
1410
```
1379
1411
1380
1412
then, the HTTP API exposes the following plugin endpoint:
@@ -1390,7 +1422,7 @@ paths:
1390
1422
operationId : GetProcessingEnginePluginRequest
1391
1423
summary : On Request processing engine plugin request
1392
1424
description : |
1393
- Executes the On Request processing engine plugin specified in `<plugin_path> `.
1425
+ Executes the On Request processing engine plugin specified in the trigger's `plugin_filename `.
1394
1426
The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin.
1395
1427
1396
1428
An On Request plugin implements the following signature:
@@ -1417,7 +1449,7 @@ paths:
1417
1449
operationId : PostProcessingEnginePluginRequest
1418
1450
summary : On Request processing engine plugin request
1419
1451
description : |
1420
- Executes the On Request processing engine plugin specified in `<plugin_path> `.
1452
+ Executes the On Request processing engine plugin specified in the trigger's `plugin_filename `.
1421
1453
The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin.
1422
1454
1423
1455
An On Request plugin implements the following signature:
@@ -1868,7 +1900,7 @@ components:
1868
1900
`schedule.py` or `endpoints/report.py`.
1869
1901
The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3.
1870
1902
1871
- The plugin file must implement the trigger interface associated with the trigger's specification (`trigger_spec`) .
1903
+ The plugin file must implement the trigger interface associated with the trigger's specification.
1872
1904
trigger_name :
1873
1905
type : string
1874
1906
trigger_specification :
@@ -1911,12 +1943,12 @@ components:
1911
1943
- `table:TABLE_NAME` - Triggers on write events to a specific table
1912
1944
1913
1945
### On-demand triggers
1914
- Format: `path:ENDPOINT_NAME `
1946
+ Format: `request:REQUEST_PATH `
1915
1947
1916
- Creates an HTTP endpoint `/api/v3/engine/ENDPOINT_NAME ` for manual invocation:
1917
- - `path :hello-world` - Creates endpoint `/api/v3/engine/hello-world`
1918
- - `path :data-export` - Creates endpoint `/api/v3/engine/data-export`
1919
- pattern : ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|path :[a-zA-Z0-9_-]+)$
1948
+ Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH ` for manual invocation:
1949
+ - `request :hello-world` - Creates endpoint `/api/v3/engine/hello-world`
1950
+ - `request :data-export` - Creates endpoint `/api/v3/engine/data-export`
1951
+ pattern : ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request :[a-zA-Z0-9_-]+)$
1920
1952
example : cron:0 0 6 * * 1-5
1921
1953
trigger_arguments :
1922
1954
type : object
@@ -2013,6 +2045,65 @@ components:
2013
2045
- m
2014
2046
- h
2015
2047
type : string
2048
+ UpdateDatabaseRequest :
2049
+ type : object
2050
+ properties :
2051
+ retention_period :
2052
+ type : string
2053
+ description : |
2054
+ The retention period for the database. Specifies how long data should be retained.
2055
+ Use duration format (for example, "1d", "1h", "30m", "7d").
2056
+ example : " 7d"
2057
+ description : Request schema for updating database configuration.
2058
+ UpdateTableRequest :
2059
+ type : object
2060
+ properties :
2061
+ db :
2062
+ type : string
2063
+ description : The name of the database containing the table.
2064
+ table :
2065
+ type : string
2066
+ description : The name of the table to update.
2067
+ retention_period :
2068
+ type : string
2069
+ description : |
2070
+ The retention period for the table. Specifies how long data in this table should be retained.
2071
+ Use duration format (for example, "1d", "1h", "30m", "7d").
2072
+ example : " 30d"
2073
+ required :
2074
+ - db
2075
+ - table
2076
+ description : Request schema for updating table configuration.
2077
+ LicenseResponse :
2078
+ type : object
2079
+ properties :
2080
+ license_type :
2081
+ type : string
2082
+ description : The type of license (for example, "enterprise", "trial").
2083
+ example : " enterprise"
2084
+ expires_at :
2085
+ type : string
2086
+ format : date-time
2087
+ description : The expiration date of the license in ISO 8601 format.
2088
+ example : " 2025-12-31T23:59:59Z"
2089
+ features :
2090
+ type : array
2091
+ items :
2092
+ type : string
2093
+ description : List of features enabled by the license.
2094
+ example :
2095
+ - " clustering"
2096
+ - " processing_engine"
2097
+ - " advanced_auth"
2098
+ status :
2099
+ type : string
2100
+ enum :
2101
+ - " active"
2102
+ - " expired"
2103
+ - " invalid"
2104
+ description : The current status of the license.
2105
+ example : " active"
2106
+ description : Response schema for license information.
2016
2107
responses :
2017
2108
Unauthorized :
2018
2109
description : Unauthorized access.
0 commit comments