@appwrite.io/console 15.5.0 → 15.7.0
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/README.md +1 -1
- package/dist/cjs/sdk.js +549 -7
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +549 -7
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +549 -7
- package/package.json +4 -1
- package/types/models.d.ts +177 -0
- package/types/services/activities.d.ts +4 -4
- package/types/services/apps.d.ts +91 -0
- package/types/services/backups.d.ts +6 -6
- package/types/services/documents-db.d.ts +34 -3
- package/types/services/mongo.d.ts +30 -2
- package/types/services/mysql.d.ts +30 -2
- package/types/services/postgresql.d.ts +30 -2
- package/types/services/storage.d.ts +6 -3
- package/types/services/tables-db.d.ts +34 -3
- package/types/services/usage.d.ts +4 -0
- package/types/services/vcs.d.ts +31 -3
- package/types/services/vectors-db.d.ts +34 -3
- package/types/services/waf.d.ts +106 -16
|
@@ -171,7 +171,7 @@ export declare class Storage {
|
|
|
171
171
|
* Get a list of all the user files. You can use the query params to filter your results.
|
|
172
172
|
*
|
|
173
173
|
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
174
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
174
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, folder, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
175
175
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
176
176
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
177
177
|
* @throws {AppwriteException}
|
|
@@ -187,7 +187,7 @@ export declare class Storage {
|
|
|
187
187
|
* Get a list of all the user files. You can use the query params to filter your results.
|
|
188
188
|
*
|
|
189
189
|
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
190
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
190
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, folder, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
191
191
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
192
192
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
193
193
|
* @throws {AppwriteException}
|
|
@@ -209,6 +209,7 @@ export declare class Storage {
|
|
|
209
209
|
* @param {string} params.fileId - File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
210
210
|
* @param {File} params.file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
|
|
211
211
|
* @param {string[]} params.permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
212
|
+
* @param {string} params.folder - Virtual folder to place the file in, for example "photos/2026". Nest folders with `/`. Defaults to the bucket root.
|
|
212
213
|
* @throws {AppwriteException}
|
|
213
214
|
* @returns {Promise<Models.File>}
|
|
214
215
|
*/
|
|
@@ -217,6 +218,7 @@ export declare class Storage {
|
|
|
217
218
|
fileId: string;
|
|
218
219
|
file: File;
|
|
219
220
|
permissions?: string[];
|
|
221
|
+
folder?: string;
|
|
220
222
|
onProgress?: (progress: UploadProgress) => void;
|
|
221
223
|
}): Promise<Models.File>;
|
|
222
224
|
/**
|
|
@@ -233,11 +235,12 @@ export declare class Storage {
|
|
|
233
235
|
* @param {string} fileId - File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
234
236
|
* @param {File} file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
|
|
235
237
|
* @param {string[]} permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
238
|
+
* @param {string} folder - Virtual folder to place the file in, for example "photos/2026". Nest folders with `/`. Defaults to the bucket root.
|
|
236
239
|
* @throws {AppwriteException}
|
|
237
240
|
* @returns {Promise<Models.File>}
|
|
238
241
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
239
242
|
*/
|
|
240
|
-
createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
|
|
243
|
+
createFile(bucketId: string, fileId: string, file: File, permissions?: string[], folder?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
|
|
241
244
|
/**
|
|
242
245
|
* Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
|
|
243
246
|
*
|
|
@@ -220,6 +220,7 @@ export declare class TablesDB {
|
|
|
220
220
|
* @param {string} params.databaseId - Database ID.
|
|
221
221
|
* @param {string} params.name - Database name. Max length: 128 chars.
|
|
222
222
|
* @param {boolean} params.enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
223
|
+
* @param {string} params.specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
223
224
|
* @param {number} params.replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
224
225
|
* @throws {AppwriteException}
|
|
225
226
|
* @returns {Promise<Models.Database>}
|
|
@@ -228,6 +229,7 @@ export declare class TablesDB {
|
|
|
228
229
|
databaseId: string;
|
|
229
230
|
name?: string;
|
|
230
231
|
enabled?: boolean;
|
|
232
|
+
specification?: string;
|
|
231
233
|
replicas?: number;
|
|
232
234
|
}): Promise<Models.Database>;
|
|
233
235
|
/**
|
|
@@ -236,12 +238,13 @@ export declare class TablesDB {
|
|
|
236
238
|
* @param {string} databaseId - Database ID.
|
|
237
239
|
* @param {string} name - Database name. Max length: 128 chars.
|
|
238
240
|
* @param {boolean} enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
241
|
+
* @param {string} specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
239
242
|
* @param {number} replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
240
243
|
* @throws {AppwriteException}
|
|
241
244
|
* @returns {Promise<Models.Database>}
|
|
242
245
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
243
246
|
*/
|
|
244
|
-
update(databaseId: string, name?: string, enabled?: boolean, replicas?: number): Promise<Models.Database>;
|
|
247
|
+
update(databaseId: string, name?: string, enabled?: boolean, specification?: string, replicas?: number): Promise<Models.Database>;
|
|
245
248
|
/**
|
|
246
249
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
247
250
|
*
|
|
@@ -262,7 +265,7 @@ export declare class TablesDB {
|
|
|
262
265
|
*/
|
|
263
266
|
delete(databaseId: string): Promise<{}>;
|
|
264
267
|
/**
|
|
265
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
268
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
266
269
|
*
|
|
267
270
|
* @param {string} params.databaseId - Database ID.
|
|
268
271
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -274,7 +277,7 @@ export declare class TablesDB {
|
|
|
274
277
|
targetReplicaId?: string;
|
|
275
278
|
}): Promise<Models.DedicatedDatabase>;
|
|
276
279
|
/**
|
|
277
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
280
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
278
281
|
*
|
|
279
282
|
* @param {string} databaseId - Database ID.
|
|
280
283
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -368,6 +371,34 @@ export declare class TablesDB {
|
|
|
368
371
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
369
372
|
*/
|
|
370
373
|
deleteMigration(databaseId: string, migrationId: string): Promise<{}>;
|
|
374
|
+
/**
|
|
375
|
+
* List the lifecycle operations recorded for a dedicated database, newest first. Every provision, update, restore, backup and replication action is recorded here with its outcome, including an attempt that was abandoned because another worker took over the database.
|
|
376
|
+
*
|
|
377
|
+
* @param {string} params.databaseId - Database ID.
|
|
378
|
+
* @param {string} params.status - Filter by operation status.
|
|
379
|
+
* @param {number} params.limit - Maximum number of operations to return.
|
|
380
|
+
* @param {number} params.offset - Number of operations to skip.
|
|
381
|
+
* @throws {AppwriteException}
|
|
382
|
+
* @returns {Promise<Models.DedicatedDatabaseOperationList>}
|
|
383
|
+
*/
|
|
384
|
+
listOperations(params: {
|
|
385
|
+
databaseId: string;
|
|
386
|
+
status?: string;
|
|
387
|
+
limit?: number;
|
|
388
|
+
offset?: number;
|
|
389
|
+
}): Promise<Models.DedicatedDatabaseOperationList>;
|
|
390
|
+
/**
|
|
391
|
+
* List the lifecycle operations recorded for a dedicated database, newest first. Every provision, update, restore, backup and replication action is recorded here with its outcome, including an attempt that was abandoned because another worker took over the database.
|
|
392
|
+
*
|
|
393
|
+
* @param {string} databaseId - Database ID.
|
|
394
|
+
* @param {string} status - Filter by operation status.
|
|
395
|
+
* @param {number} limit - Maximum number of operations to return.
|
|
396
|
+
* @param {number} offset - Number of operations to skip.
|
|
397
|
+
* @throws {AppwriteException}
|
|
398
|
+
* @returns {Promise<Models.DedicatedDatabaseOperationList>}
|
|
399
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
400
|
+
*/
|
|
401
|
+
listOperations(databaseId: string, status?: string, limit?: number, offset?: number): Promise<Models.DedicatedDatabaseOperationList>;
|
|
371
402
|
/**
|
|
372
403
|
* Get high availability status for a dedicated database. Returns replica statuses, replication lag, and sync mode.
|
|
373
404
|
*
|
|
@@ -64,6 +64,8 @@ export declare class Usage {
|
|
|
64
64
|
/**
|
|
65
65
|
* Aggregate usage gauge snapshots. Gauges are point-in-time values (storage totals, resource counts, …); each point carries the latest snapshot in its interval via `argMax(value, time)`. `metrics[]` (1-10) is required; the response always contains one entry per requested metric, each with its own `points[]` time series.
|
|
66
66
|
*
|
|
67
|
+
* A metric with no stored samples in the window returns an empty `points[]`. A metric that really did read zero returns a point whose `value` is `0`, so "no such series" and "a genuine zero" are different answers.
|
|
68
|
+
*
|
|
67
69
|
* **Two response shapes**:
|
|
68
70
|
* - Omit `interval` for a flat top-N table — `argMax(value, time)` per dimension combination over the whole window, no time axis. Useful for "top 10 resources by current storage".
|
|
69
71
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one snapshot per (time bucket × dimension combination).
|
|
@@ -98,6 +100,8 @@ export declare class Usage {
|
|
|
98
100
|
/**
|
|
99
101
|
* Aggregate usage gauge snapshots. Gauges are point-in-time values (storage totals, resource counts, …); each point carries the latest snapshot in its interval via `argMax(value, time)`. `metrics[]` (1-10) is required; the response always contains one entry per requested metric, each with its own `points[]` time series.
|
|
100
102
|
*
|
|
103
|
+
* A metric with no stored samples in the window returns an empty `points[]`. A metric that really did read zero returns a point whose `value` is `0`, so "no such series" and "a genuine zero" are different answers.
|
|
104
|
+
*
|
|
101
105
|
* **Two response shapes**:
|
|
102
106
|
* - Omit `interval` for a flat top-N table — `argMax(value, time)` per dimension combination over the whole window, no time axis. Useful for "top 10 resources by current storage".
|
|
103
107
|
* - Pass `interval` (`1m`, `15m`, `30m`, `1h`, `1d`) for a time series — one snapshot per (time bucket × dimension combination).
|
package/types/services/vcs.d.ts
CHANGED
|
@@ -38,7 +38,7 @@ export declare class Vcs {
|
|
|
38
38
|
* @param {string} params.installationId - Installation Id
|
|
39
39
|
* @param {VCSDetectionType} params.type - Detector type. Must be one of the following: runtime, framework
|
|
40
40
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
41
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and
|
|
41
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, and equal on namespace.
|
|
42
42
|
* @throws {AppwriteException}
|
|
43
43
|
* @returns {Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>}
|
|
44
44
|
*/
|
|
@@ -54,7 +54,7 @@ export declare class Vcs {
|
|
|
54
54
|
* @param {string} installationId - Installation Id
|
|
55
55
|
* @param {VCSDetectionType} type - Detector type. Must be one of the following: runtime, framework
|
|
56
56
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
57
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and
|
|
57
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, and equal on namespace.
|
|
58
58
|
* @throws {AppwriteException}
|
|
59
59
|
* @returns {Promise<Models.ProviderRepositoryRuntimeList | Models.ProviderRepositoryFrameworkList>}
|
|
60
60
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -66,6 +66,7 @@ export declare class Vcs {
|
|
|
66
66
|
* @param {string} params.installationId - Installation Id
|
|
67
67
|
* @param {string} params.name - Repository name (slug)
|
|
68
68
|
* @param {boolean} params.xprivate - Mark repository public or private
|
|
69
|
+
* @param {string} params.providerNamespace - Namespace of the git repository. Defaults to the installation's own namespace.
|
|
69
70
|
* @throws {AppwriteException}
|
|
70
71
|
* @returns {Promise<Models.ProviderRepository>}
|
|
71
72
|
*/
|
|
@@ -73,6 +74,7 @@ export declare class Vcs {
|
|
|
73
74
|
installationId: string;
|
|
74
75
|
name: string;
|
|
75
76
|
xprivate: boolean;
|
|
77
|
+
providerNamespace?: string;
|
|
76
78
|
}): Promise<Models.ProviderRepository>;
|
|
77
79
|
/**
|
|
78
80
|
* Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
|
|
@@ -80,11 +82,12 @@ export declare class Vcs {
|
|
|
80
82
|
* @param {string} installationId - Installation Id
|
|
81
83
|
* @param {string} name - Repository name (slug)
|
|
82
84
|
* @param {boolean} xprivate - Mark repository public or private
|
|
85
|
+
* @param {string} providerNamespace - Namespace of the git repository. Defaults to the installation's own namespace.
|
|
83
86
|
* @throws {AppwriteException}
|
|
84
87
|
* @returns {Promise<Models.ProviderRepository>}
|
|
85
88
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
86
89
|
*/
|
|
87
|
-
createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository>;
|
|
90
|
+
createRepository(installationId: string, name: string, xprivate: boolean, providerNamespace?: string): Promise<Models.ProviderRepository>;
|
|
88
91
|
/**
|
|
89
92
|
* Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
90
93
|
*
|
|
@@ -255,4 +258,29 @@ export declare class Vcs {
|
|
|
255
258
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
256
259
|
*/
|
|
257
260
|
deleteInstallation(installationId: string): Promise<{}>;
|
|
261
|
+
/**
|
|
262
|
+
* List provider namespaces available to a VCS installation. This can include the user personal namespace and any groups or organizations the installation can browse.
|
|
263
|
+
*
|
|
264
|
+
* @param {string} params.installationId - Installation Id
|
|
265
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
266
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
267
|
+
* @throws {AppwriteException}
|
|
268
|
+
* @returns {Promise<Models.VcsNamespaceList>}
|
|
269
|
+
*/
|
|
270
|
+
listNamespaces(params: {
|
|
271
|
+
installationId: string;
|
|
272
|
+
search?: string;
|
|
273
|
+
queries?: string[];
|
|
274
|
+
}): Promise<Models.VcsNamespaceList>;
|
|
275
|
+
/**
|
|
276
|
+
* List provider namespaces available to a VCS installation. This can include the user personal namespace and any groups or organizations the installation can browse.
|
|
277
|
+
*
|
|
278
|
+
* @param {string} installationId - Installation Id
|
|
279
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
280
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
281
|
+
* @throws {AppwriteException}
|
|
282
|
+
* @returns {Promise<Models.VcsNamespaceList>}
|
|
283
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
284
|
+
*/
|
|
285
|
+
listNamespaces(installationId: string, search?: string, queries?: string[]): Promise<Models.VcsNamespaceList>;
|
|
258
286
|
}
|
|
@@ -240,6 +240,7 @@ export declare class VectorsDB {
|
|
|
240
240
|
* @param {string} params.databaseId - Database ID.
|
|
241
241
|
* @param {string} params.name - Database name. Max length: 128 chars.
|
|
242
242
|
* @param {boolean} params.enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
243
|
+
* @param {string} params.specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
243
244
|
* @param {number} params.replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
244
245
|
* @throws {AppwriteException}
|
|
245
246
|
* @returns {Promise<Models.Database>}
|
|
@@ -248,6 +249,7 @@ export declare class VectorsDB {
|
|
|
248
249
|
databaseId: string;
|
|
249
250
|
name: string;
|
|
250
251
|
enabled?: boolean;
|
|
252
|
+
specification?: string;
|
|
251
253
|
replicas?: number;
|
|
252
254
|
}): Promise<Models.Database>;
|
|
253
255
|
/**
|
|
@@ -256,12 +258,13 @@ export declare class VectorsDB {
|
|
|
256
258
|
* @param {string} databaseId - Database ID.
|
|
257
259
|
* @param {string} name - Database name. Max length: 128 chars.
|
|
258
260
|
* @param {boolean} enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
261
|
+
* @param {string} specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
259
262
|
* @param {number} replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
260
263
|
* @throws {AppwriteException}
|
|
261
264
|
* @returns {Promise<Models.Database>}
|
|
262
265
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
263
266
|
*/
|
|
264
|
-
update(databaseId: string, name: string, enabled?: boolean, replicas?: number): Promise<Models.Database>;
|
|
267
|
+
update(databaseId: string, name: string, enabled?: boolean, specification?: string, replicas?: number): Promise<Models.Database>;
|
|
265
268
|
/**
|
|
266
269
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
267
270
|
*
|
|
@@ -887,7 +890,7 @@ export declare class VectorsDB {
|
|
|
887
890
|
*/
|
|
888
891
|
deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
889
892
|
/**
|
|
890
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
893
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
891
894
|
*
|
|
892
895
|
* @param {string} params.databaseId - Database ID.
|
|
893
896
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -899,7 +902,7 @@ export declare class VectorsDB {
|
|
|
899
902
|
targetReplicaId?: string;
|
|
900
903
|
}): Promise<Models.DedicatedDatabase>;
|
|
901
904
|
/**
|
|
902
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
905
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
903
906
|
*
|
|
904
907
|
* @param {string} databaseId - Database ID.
|
|
905
908
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -908,6 +911,34 @@ export declare class VectorsDB {
|
|
|
908
911
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
909
912
|
*/
|
|
910
913
|
createFailover(databaseId: string, targetReplicaId?: string): Promise<Models.DedicatedDatabase>;
|
|
914
|
+
/**
|
|
915
|
+
* List the lifecycle operations recorded for a dedicated database, newest first. Every provision, update, restore, backup and replication action is recorded here with its outcome, including an attempt that was abandoned because another worker took over the database.
|
|
916
|
+
*
|
|
917
|
+
* @param {string} params.databaseId - Database ID.
|
|
918
|
+
* @param {string} params.status - Filter by operation status.
|
|
919
|
+
* @param {number} params.limit - Maximum number of operations to return.
|
|
920
|
+
* @param {number} params.offset - Number of operations to skip.
|
|
921
|
+
* @throws {AppwriteException}
|
|
922
|
+
* @returns {Promise<Models.DedicatedDatabaseOperationList>}
|
|
923
|
+
*/
|
|
924
|
+
listOperations(params: {
|
|
925
|
+
databaseId: string;
|
|
926
|
+
status?: string;
|
|
927
|
+
limit?: number;
|
|
928
|
+
offset?: number;
|
|
929
|
+
}): Promise<Models.DedicatedDatabaseOperationList>;
|
|
930
|
+
/**
|
|
931
|
+
* List the lifecycle operations recorded for a dedicated database, newest first. Every provision, update, restore, backup and replication action is recorded here with its outcome, including an attempt that was abandoned because another worker took over the database.
|
|
932
|
+
*
|
|
933
|
+
* @param {string} databaseId - Database ID.
|
|
934
|
+
* @param {string} status - Filter by operation status.
|
|
935
|
+
* @param {number} limit - Maximum number of operations to return.
|
|
936
|
+
* @param {number} offset - Number of operations to skip.
|
|
937
|
+
* @throws {AppwriteException}
|
|
938
|
+
* @returns {Promise<Models.DedicatedDatabaseOperationList>}
|
|
939
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
940
|
+
*/
|
|
941
|
+
listOperations(databaseId: string, status?: string, limit?: number, offset?: number): Promise<Models.DedicatedDatabaseOperationList>;
|
|
911
942
|
/**
|
|
912
943
|
* Get high availability status for a dedicated database. Returns replica statuses, replication lag, and sync mode.
|
|
913
944
|
*
|
package/types/services/waf.d.ts
CHANGED
|
@@ -31,7 +31,7 @@ export declare class Waf {
|
|
|
31
31
|
*/
|
|
32
32
|
listRules(queries?: string[], search?: string, total?: boolean): Promise<Models.WafRuleList>;
|
|
33
33
|
/**
|
|
34
|
-
* Create a bypass WAF rule.
|
|
34
|
+
* Create a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
35
35
|
*
|
|
36
36
|
*
|
|
37
37
|
* @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -56,7 +56,7 @@ export declare class Waf {
|
|
|
56
56
|
conditions?: string;
|
|
57
57
|
}): Promise<Models.WafRuleBypass>;
|
|
58
58
|
/**
|
|
59
|
-
* Create a bypass WAF rule.
|
|
59
|
+
* Create a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
62
|
* @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -73,7 +73,7 @@ export declare class Waf {
|
|
|
73
73
|
*/
|
|
74
74
|
createBypassRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleBypass>;
|
|
75
75
|
/**
|
|
76
|
-
* Update a bypass WAF rule.
|
|
76
|
+
* Update a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
77
77
|
*
|
|
78
78
|
*
|
|
79
79
|
* @param {string} params.ruleId - Rule ID.
|
|
@@ -98,7 +98,7 @@ export declare class Waf {
|
|
|
98
98
|
conditions?: string;
|
|
99
99
|
}): Promise<Models.WafRuleBypass>;
|
|
100
100
|
/**
|
|
101
|
-
* Update a bypass WAF rule.
|
|
101
|
+
* Update a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
102
102
|
*
|
|
103
103
|
*
|
|
104
104
|
* @param {string} ruleId - Rule ID.
|
|
@@ -115,7 +115,97 @@ export declare class Waf {
|
|
|
115
115
|
*/
|
|
116
116
|
updateBypassRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleBypass>;
|
|
117
117
|
/**
|
|
118
|
-
* Create a
|
|
118
|
+
* Create a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
119
|
+
*
|
|
120
|
+
*
|
|
121
|
+
* @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
122
|
+
* @param {string} params.resourceType - Resource type the rule applies to.
|
|
123
|
+
* @param {string} params.name - Rule name.
|
|
124
|
+
* @param {string} params.resourceId - Resource identifier. Required for functions and sites.
|
|
125
|
+
* @param {string} params.description - Optional description for the rule.
|
|
126
|
+
* @param {string} params.challengeType - Challenge type enforced by the rule.
|
|
127
|
+
* @param {number} params.priority - Evaluation priority. Lower numbers run earlier.
|
|
128
|
+
* @param {boolean} params.enabled - Set to false to create the rule in a disabled state.
|
|
129
|
+
* @param {string} params.conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
|
|
130
|
+
* @throws {AppwriteException}
|
|
131
|
+
* @returns {Promise<Models.WafRuleChallenge>}
|
|
132
|
+
*/
|
|
133
|
+
createChallengeRule(params: {
|
|
134
|
+
ruleId: string;
|
|
135
|
+
resourceType: string;
|
|
136
|
+
name: string;
|
|
137
|
+
resourceId?: string;
|
|
138
|
+
description?: string;
|
|
139
|
+
challengeType?: string;
|
|
140
|
+
priority?: number;
|
|
141
|
+
enabled?: boolean;
|
|
142
|
+
conditions?: string;
|
|
143
|
+
}): Promise<Models.WafRuleChallenge>;
|
|
144
|
+
/**
|
|
145
|
+
* Create a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
146
|
+
*
|
|
147
|
+
*
|
|
148
|
+
* @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
149
|
+
* @param {string} resourceType - Resource type the rule applies to.
|
|
150
|
+
* @param {string} name - Rule name.
|
|
151
|
+
* @param {string} resourceId - Resource identifier. Required for functions and sites.
|
|
152
|
+
* @param {string} description - Optional description for the rule.
|
|
153
|
+
* @param {string} challengeType - Challenge type enforced by the rule.
|
|
154
|
+
* @param {number} priority - Evaluation priority. Lower numbers run earlier.
|
|
155
|
+
* @param {boolean} enabled - Set to false to create the rule in a disabled state.
|
|
156
|
+
* @param {string} conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
|
|
157
|
+
* @throws {AppwriteException}
|
|
158
|
+
* @returns {Promise<Models.WafRuleChallenge>}
|
|
159
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
160
|
+
*/
|
|
161
|
+
createChallengeRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, challengeType?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleChallenge>;
|
|
162
|
+
/**
|
|
163
|
+
* Update a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
164
|
+
*
|
|
165
|
+
*
|
|
166
|
+
* @param {string} params.ruleId - Rule ID.
|
|
167
|
+
* @param {string} params.resourceType - Resource type the rule applies to.
|
|
168
|
+
* @param {string} params.resourceId - Resource identifier. Required for functions and sites.
|
|
169
|
+
* @param {string} params.name - Rule name.
|
|
170
|
+
* @param {string} params.description - Optional description for the rule.
|
|
171
|
+
* @param {string} params.challengeType - Challenge type enforced by the rule.
|
|
172
|
+
* @param {number} params.priority - Evaluation priority. Lower numbers run earlier.
|
|
173
|
+
* @param {boolean} params.enabled - Set to false to disable the rule.
|
|
174
|
+
* @param {string} params.conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
|
|
175
|
+
* @throws {AppwriteException}
|
|
176
|
+
* @returns {Promise<Models.WafRuleChallenge>}
|
|
177
|
+
*/
|
|
178
|
+
updateChallengeRule(params: {
|
|
179
|
+
ruleId: string;
|
|
180
|
+
resourceType?: string;
|
|
181
|
+
resourceId?: string;
|
|
182
|
+
name?: string;
|
|
183
|
+
description?: string;
|
|
184
|
+
challengeType?: string;
|
|
185
|
+
priority?: number;
|
|
186
|
+
enabled?: boolean;
|
|
187
|
+
conditions?: string;
|
|
188
|
+
}): Promise<Models.WafRuleChallenge>;
|
|
189
|
+
/**
|
|
190
|
+
* Update a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
191
|
+
*
|
|
192
|
+
*
|
|
193
|
+
* @param {string} ruleId - Rule ID.
|
|
194
|
+
* @param {string} resourceType - Resource type the rule applies to.
|
|
195
|
+
* @param {string} resourceId - Resource identifier. Required for functions and sites.
|
|
196
|
+
* @param {string} name - Rule name.
|
|
197
|
+
* @param {string} description - Optional description for the rule.
|
|
198
|
+
* @param {string} challengeType - Challenge type enforced by the rule.
|
|
199
|
+
* @param {number} priority - Evaluation priority. Lower numbers run earlier.
|
|
200
|
+
* @param {boolean} enabled - Set to false to disable the rule.
|
|
201
|
+
* @param {string} conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
|
|
202
|
+
* @throws {AppwriteException}
|
|
203
|
+
* @returns {Promise<Models.WafRuleChallenge>}
|
|
204
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
205
|
+
*/
|
|
206
|
+
updateChallengeRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, challengeType?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleChallenge>;
|
|
207
|
+
/**
|
|
208
|
+
* Create a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
119
209
|
*
|
|
120
210
|
*
|
|
121
211
|
* @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -140,7 +230,7 @@ export declare class Waf {
|
|
|
140
230
|
conditions?: string;
|
|
141
231
|
}): Promise<Models.WafRuleDeny>;
|
|
142
232
|
/**
|
|
143
|
-
* Create a deny WAF rule.
|
|
233
|
+
* Create a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
144
234
|
*
|
|
145
235
|
*
|
|
146
236
|
* @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -157,7 +247,7 @@ export declare class Waf {
|
|
|
157
247
|
*/
|
|
158
248
|
createDenyRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleDeny>;
|
|
159
249
|
/**
|
|
160
|
-
* Update a deny WAF rule.
|
|
250
|
+
* Update a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
161
251
|
*
|
|
162
252
|
*
|
|
163
253
|
* @param {string} params.ruleId - Rule ID.
|
|
@@ -182,7 +272,7 @@ export declare class Waf {
|
|
|
182
272
|
conditions?: string;
|
|
183
273
|
}): Promise<Models.WafRuleDeny>;
|
|
184
274
|
/**
|
|
185
|
-
* Update a deny WAF rule.
|
|
275
|
+
* Update a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
186
276
|
*
|
|
187
277
|
*
|
|
188
278
|
* @param {string} ruleId - Rule ID.
|
|
@@ -199,7 +289,7 @@ export declare class Waf {
|
|
|
199
289
|
*/
|
|
200
290
|
updateDenyRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleDeny>;
|
|
201
291
|
/**
|
|
202
|
-
* Create a rate limit WAF rule.
|
|
292
|
+
* Create a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
203
293
|
*
|
|
204
294
|
*
|
|
205
295
|
* @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -228,7 +318,7 @@ export declare class Waf {
|
|
|
228
318
|
conditions?: string;
|
|
229
319
|
}): Promise<Models.WafRuleRateLimit>;
|
|
230
320
|
/**
|
|
231
|
-
* Create a rate limit WAF rule.
|
|
321
|
+
* Create a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
232
322
|
*
|
|
233
323
|
*
|
|
234
324
|
* @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -247,7 +337,7 @@ export declare class Waf {
|
|
|
247
337
|
*/
|
|
248
338
|
createRateLimitRule(ruleId: string, resourceType: string, name: string, limit: number, interval: number, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRateLimit>;
|
|
249
339
|
/**
|
|
250
|
-
* Update a rate limit WAF rule.
|
|
340
|
+
* Update a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
251
341
|
*
|
|
252
342
|
*
|
|
253
343
|
* @param {string} params.ruleId - Rule ID.
|
|
@@ -276,7 +366,7 @@ export declare class Waf {
|
|
|
276
366
|
conditions?: string;
|
|
277
367
|
}): Promise<Models.WafRuleRateLimit>;
|
|
278
368
|
/**
|
|
279
|
-
* Update a rate limit WAF rule.
|
|
369
|
+
* Update a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
280
370
|
*
|
|
281
371
|
*
|
|
282
372
|
* @param {string} ruleId - Rule ID.
|
|
@@ -295,7 +385,7 @@ export declare class Waf {
|
|
|
295
385
|
*/
|
|
296
386
|
updateRateLimitRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, limit?: number, interval?: number, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRateLimit>;
|
|
297
387
|
/**
|
|
298
|
-
* Create a redirect WAF rule.
|
|
388
|
+
* Create a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
299
389
|
*
|
|
300
390
|
*
|
|
301
391
|
* @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -324,7 +414,7 @@ export declare class Waf {
|
|
|
324
414
|
conditions?: string;
|
|
325
415
|
}): Promise<Models.WafRuleRedirect>;
|
|
326
416
|
/**
|
|
327
|
-
* Create a redirect WAF rule.
|
|
417
|
+
* Create a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
328
418
|
*
|
|
329
419
|
*
|
|
330
420
|
* @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
|
|
@@ -343,7 +433,7 @@ export declare class Waf {
|
|
|
343
433
|
*/
|
|
344
434
|
createRedirectRule(ruleId: string, resourceType: string, name: string, location: string, statusCode: number, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRedirect>;
|
|
345
435
|
/**
|
|
346
|
-
* Update a redirect WAF rule.
|
|
436
|
+
* Update a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
347
437
|
*
|
|
348
438
|
*
|
|
349
439
|
* @param {string} params.ruleId - Rule ID.
|
|
@@ -372,7 +462,7 @@ export declare class Waf {
|
|
|
372
462
|
conditions?: string;
|
|
373
463
|
}): Promise<Models.WafRuleRedirect>;
|
|
374
464
|
/**
|
|
375
|
-
* Update a redirect WAF rule.
|
|
465
|
+
* Update a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
|
|
376
466
|
*
|
|
377
467
|
*
|
|
378
468
|
* @param {string} ruleId - Rule ID.
|