files.com 1.2.35 → 1.2.37
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/ApiRequestLog.md +55 -0
- package/docs/models/AutomationLog.md +47 -0
- package/docs/models/EmailLog.md +39 -0
- package/docs/models/ExavaultApiRequestLog.md +47 -0
- package/docs/models/FileMigrationLog.md +45 -0
- package/docs/models/RemoteServer.md +24 -3
- package/docs/models/RemoteServerConfigurationFile.md +15 -1
- package/docs/models/SftpActionLog.md +75 -0
- package/docs/models/SyncLog.md +45 -0
- package/lib/Files.js +1 -1
- package/lib/models/ApiRequestLog.js +154 -0
- package/lib/models/AutomationLog.js +138 -0
- package/lib/models/EmailLog.js +122 -0
- package/lib/models/ExavaultApiRequestLog.js +138 -0
- package/lib/models/FileMigrationLog.js +134 -0
- package/lib/models/RemoteServer.js +65 -16
- package/lib/models/RemoteServerConfigurationFile.js +28 -0
- package/lib/models/SftpActionLog.js +194 -0
- package/lib/models/SyncLog.js +134 -0
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/ApiRequestLog.js +99 -0
- package/src/models/AutomationLog.js +87 -0
- package/src/models/EmailLog.js +75 -0
- package/src/models/ExavaultApiRequestLog.js +87 -0
- package/src/models/FileMigrationLog.js +84 -0
- package/src/models/RemoteServer.js +35 -0
- package/src/models/RemoteServerConfigurationFile.js +21 -0
- package/src/models/SftpActionLog.js +129 -0
- package/src/models/SyncLog.js +84 -0
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.2.
|
1
|
+
1.2.37
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# ApiRequestLog
|
2
|
+
|
3
|
+
## Example ApiRequestLog Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"timestamp": "2000-01-01T01:00:00Z",
|
8
|
+
"api_key_id": "example",
|
9
|
+
"user_id": 1,
|
10
|
+
"username": "example",
|
11
|
+
"interface": "example",
|
12
|
+
"request_method": "example",
|
13
|
+
"request_path": "example",
|
14
|
+
"request_ip": "example",
|
15
|
+
"request_host": "example",
|
16
|
+
"api_name": "example",
|
17
|
+
"user_agent": "example",
|
18
|
+
"error_type": "example",
|
19
|
+
"response_code": 1,
|
20
|
+
"duration_ms": 1
|
21
|
+
}
|
22
|
+
```
|
23
|
+
|
24
|
+
* `timestamp` (date-time): Start Time of Action
|
25
|
+
* `api_key_id` (string): API Key ID, if applicable
|
26
|
+
* `user_id` (int64): User ID
|
27
|
+
* `username` (string): Username
|
28
|
+
* `interface` (string): API Interface
|
29
|
+
* `request_method` (string): HTTP Method
|
30
|
+
* `request_path` (string): Request path
|
31
|
+
* `request_ip` (string): IP of requesting client
|
32
|
+
* `request_host` (string): Hostname the request was sent to
|
33
|
+
* `api_name` (string): Name of API Endpoint
|
34
|
+
* `user_agent` (string): User-Agent
|
35
|
+
* `error_type` (string): Error type, if applicable
|
36
|
+
* `response_code` (int64): HTTP Response Code
|
37
|
+
* `duration_ms` (int64): Duration (in milliseconds)
|
38
|
+
|
39
|
+
---
|
40
|
+
|
41
|
+
## List Api Request Logs
|
42
|
+
|
43
|
+
```
|
44
|
+
await ApiRequestLog.list({
|
45
|
+
'per_page': 1,
|
46
|
+
})
|
47
|
+
```
|
48
|
+
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
53
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
54
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `api_key_id`, `interface`, `request_id`, `request_ip`, `request_method`, `status` or `user_id`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ api_key_id ]`, `[ interface ]`, `[ request_id ]`, `[ request_ip ]`, `[ request_method ]`, `[ status ]`, `[ user_id ]`, `[ start_date, end_date ]`, `[ start_date, api_key_id ]`, `[ start_date, interface ]`, `[ start_date, request_id ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, status ]`, `[ start_date, user_id ]`, `[ end_date, api_key_id ]`, `[ end_date, interface ]`, `[ end_date, request_id ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, status ]`, `[ end_date, user_id ]`, `[ api_key_id, interface ]`, `[ api_key_id, request_id ]`, `[ api_key_id, request_ip ]`, `[ api_key_id, request_method ]`, `[ api_key_id, status ]`, `[ api_key_id, user_id ]`, `[ interface, request_id ]`, `[ interface, request_ip ]`, `[ interface, request_method ]`, `[ interface, status ]`, `[ interface, user_id ]`, `[ request_id, request_ip ]`, `[ request_id, request_method ]`, `[ request_id, status ]`, `[ request_id, user_id ]`, `[ request_ip, request_method ]`, `[ request_ip, status ]`, `[ request_ip, user_id ]`, `[ request_method, status ]`, `[ request_method, user_id ]`, `[ status, user_id ]`, `[ start_date, end_date, api_key_id ]`, `[ start_date, end_date, interface ]`, `[ start_date, end_date, request_id ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, user_id ]`, `[ start_date, api_key_id, interface ]`, `[ start_date, api_key_id, request_id ]`, `[ start_date, api_key_id, request_ip ]`, `[ start_date, api_key_id, request_method ]`, `[ start_date, api_key_id, status ]`, `[ start_date, api_key_id, user_id ]`, `[ start_date, interface, request_id ]`, `[ start_date, interface, request_ip ]`, `[ start_date, interface, request_method ]`, `[ start_date, interface, status ]`, `[ start_date, interface, user_id ]`, `[ start_date, request_id, request_ip ]`, `[ start_date, request_id, request_method ]`, `[ start_date, request_id, status ]`, `[ start_date, request_id, user_id ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, status ]`, `[ start_date, request_ip, user_id ]`, `[ start_date, request_method, status ]`, `[ start_date, request_method, user_id ]`, `[ start_date, status, user_id ]`, `[ end_date, api_key_id, interface ]`, `[ end_date, api_key_id, request_id ]`, `[ end_date, api_key_id, request_ip ]`, `[ end_date, api_key_id, request_method ]`, `[ end_date, api_key_id, status ]`, `[ end_date, api_key_id, user_id ]`, `[ end_date, interface, request_id ]`, `[ end_date, interface, request_ip ]`, `[ end_date, interface, request_method ]`, `[ end_date, interface, status ]`, `[ end_date, interface, user_id ]`, `[ end_date, request_id, request_ip ]`, `[ end_date, request_id, request_method ]`, `[ end_date, request_id, status ]`, `[ end_date, request_id, user_id ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, status ]`, `[ end_date, request_ip, user_id ]`, `[ end_date, request_method, status ]`, `[ end_date, request_method, user_id ]`, `[ end_date, status, user_id ]`, `[ api_key_id, interface, request_id ]`, `[ api_key_id, interface, request_ip ]`, `[ api_key_id, interface, request_method ]`, `[ api_key_id, interface, status ]`, `[ api_key_id, interface, user_id ]`, `[ api_key_id, request_id, request_ip ]`, `[ api_key_id, request_id, request_method ]`, `[ api_key_id, request_id, status ]`, `[ api_key_id, request_id, user_id ]`, `[ api_key_id, request_ip, request_method ]`, `[ api_key_id, request_ip, status ]`, `[ api_key_id, request_ip, user_id ]`, `[ api_key_id, request_method, status ]`, `[ api_key_id, request_method, user_id ]`, `[ api_key_id, status, user_id ]`, `[ interface, request_id, request_ip ]`, `[ interface, request_id, request_method ]`, `[ interface, request_id, status ]`, `[ interface, request_id, user_id ]`, `[ interface, request_ip, request_method ]`, `[ interface, request_ip, status ]`, `[ interface, request_ip, user_id ]`, `[ interface, request_method, status ]`, `[ interface, request_method, user_id ]`, `[ interface, status, user_id ]`, `[ request_id, request_ip, request_method ]`, `[ request_id, request_ip, status ]`, `[ request_id, request_ip, user_id ]`, `[ request_id, request_method, status ]`, `[ request_id, request_method, user_id ]`, `[ request_id, status, user_id ]`, `[ request_ip, request_method, status ]`, `[ request_ip, request_method, user_id ]`, `[ request_ip, status, user_id ]`, `[ request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface ]`, `[ start_date, end_date, api_key_id, request_id ]`, `[ start_date, end_date, api_key_id, request_ip ]`, `[ start_date, end_date, api_key_id, request_method ]`, `[ start_date, end_date, api_key_id, status ]`, `[ start_date, end_date, api_key_id, user_id ]`, `[ start_date, end_date, interface, request_id ]`, `[ start_date, end_date, interface, request_ip ]`, `[ start_date, end_date, interface, request_method ]`, `[ start_date, end_date, interface, status ]`, `[ start_date, end_date, interface, user_id ]`, `[ start_date, end_date, request_id, request_ip ]`, `[ start_date, end_date, request_id, request_method ]`, `[ start_date, end_date, request_id, status ]`, `[ start_date, end_date, request_id, user_id ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, status ]`, `[ start_date, end_date, request_ip, user_id ]`, `[ start_date, end_date, request_method, status ]`, `[ start_date, end_date, request_method, user_id ]`, `[ start_date, end_date, status, user_id ]`, `[ start_date, api_key_id, interface, request_id ]`, `[ start_date, api_key_id, interface, request_ip ]`, `[ start_date, api_key_id, interface, request_method ]`, `[ start_date, api_key_id, interface, status ]`, `[ start_date, api_key_id, interface, user_id ]`, `[ start_date, api_key_id, request_id, request_ip ]`, `[ start_date, api_key_id, request_id, request_method ]`, `[ start_date, api_key_id, request_id, status ]`, `[ start_date, api_key_id, request_id, user_id ]`, `[ start_date, api_key_id, request_ip, request_method ]`, `[ start_date, api_key_id, request_ip, status ]`, `[ start_date, api_key_id, request_ip, user_id ]`, `[ start_date, api_key_id, request_method, status ]`, `[ start_date, api_key_id, request_method, user_id ]`, `[ start_date, api_key_id, status, user_id ]`, `[ start_date, interface, request_id, request_ip ]`, `[ start_date, interface, request_id, request_method ]`, `[ start_date, interface, request_id, status ]`, `[ start_date, interface, request_id, user_id ]`, `[ start_date, interface, request_ip, request_method ]`, `[ start_date, interface, request_ip, status ]`, `[ start_date, interface, request_ip, user_id ]`, `[ start_date, interface, request_method, status ]`, `[ start_date, interface, request_method, user_id ]`, `[ start_date, interface, status, user_id ]`, `[ start_date, request_id, request_ip, request_method ]`, `[ start_date, request_id, request_ip, status ]`, `[ start_date, request_id, request_ip, user_id ]`, `[ start_date, request_id, request_method, status ]`, `[ start_date, request_id, request_method, user_id ]`, `[ start_date, request_id, status, user_id ]`, `[ start_date, request_ip, request_method, status ]`, `[ start_date, request_ip, request_method, user_id ]`, `[ start_date, request_ip, status, user_id ]`, `[ start_date, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id ]`, `[ end_date, api_key_id, interface, request_ip ]`, `[ end_date, api_key_id, interface, request_method ]`, `[ end_date, api_key_id, interface, status ]`, `[ end_date, api_key_id, interface, user_id ]`, `[ end_date, api_key_id, request_id, request_ip ]`, `[ end_date, api_key_id, request_id, request_method ]`, `[ end_date, api_key_id, request_id, status ]`, `[ end_date, api_key_id, request_id, user_id ]`, `[ end_date, api_key_id, request_ip, request_method ]`, `[ end_date, api_key_id, request_ip, status ]`, `[ end_date, api_key_id, request_ip, user_id ]`, `[ end_date, api_key_id, request_method, status ]`, `[ end_date, api_key_id, request_method, user_id ]`, `[ end_date, api_key_id, status, user_id ]`, `[ end_date, interface, request_id, request_ip ]`, `[ end_date, interface, request_id, request_method ]`, `[ end_date, interface, request_id, status ]`, `[ end_date, interface, request_id, user_id ]`, `[ end_date, interface, request_ip, request_method ]`, `[ end_date, interface, request_ip, status ]`, `[ end_date, interface, request_ip, user_id ]`, `[ end_date, interface, request_method, status ]`, `[ end_date, interface, request_method, user_id ]`, `[ end_date, interface, status, user_id ]`, `[ end_date, request_id, request_ip, request_method ]`, `[ end_date, request_id, request_ip, status ]`, `[ end_date, request_id, request_ip, user_id ]`, `[ end_date, request_id, request_method, status ]`, `[ end_date, request_id, request_method, user_id ]`, `[ end_date, request_id, status, user_id ]`, `[ end_date, request_ip, request_method, status ]`, `[ end_date, request_ip, request_method, user_id ]`, `[ end_date, request_ip, status, user_id ]`, `[ end_date, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip ]`, `[ api_key_id, interface, request_id, request_method ]`, `[ api_key_id, interface, request_id, status ]`, `[ api_key_id, interface, request_id, user_id ]`, `[ api_key_id, interface, request_ip, request_method ]`, `[ api_key_id, interface, request_ip, status ]`, `[ api_key_id, interface, request_ip, user_id ]`, `[ api_key_id, interface, request_method, status ]`, `[ api_key_id, interface, request_method, user_id ]`, `[ api_key_id, interface, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method ]`, `[ api_key_id, request_id, request_ip, status ]`, `[ api_key_id, request_id, request_ip, user_id ]`, `[ api_key_id, request_id, request_method, status ]`, `[ api_key_id, request_id, request_method, user_id ]`, `[ api_key_id, request_id, status, user_id ]`, `[ api_key_id, request_ip, request_method, status ]`, `[ api_key_id, request_ip, request_method, user_id ]`, `[ api_key_id, request_ip, status, user_id ]`, `[ api_key_id, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method ]`, `[ interface, request_id, request_ip, status ]`, `[ interface, request_id, request_ip, user_id ]`, `[ interface, request_id, request_method, status ]`, `[ interface, request_id, request_method, user_id ]`, `[ interface, request_id, status, user_id ]`, `[ interface, request_ip, request_method, status ]`, `[ interface, request_ip, request_method, user_id ]`, `[ interface, request_ip, status, user_id ]`, `[ interface, request_method, status, user_id ]`, `[ request_id, request_ip, request_method, status ]`, `[ request_id, request_ip, request_method, user_id ]`, `[ request_id, request_ip, status, user_id ]`, `[ request_id, request_method, status, user_id ]`, `[ request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip ]`, `[ start_date, end_date, api_key_id, interface, request_method ]`, `[ start_date, end_date, api_key_id, interface, status ]`, `[ start_date, end_date, api_key_id, interface, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip ]`, `[ start_date, end_date, api_key_id, request_id, request_method ]`, `[ start_date, end_date, api_key_id, request_id, status ]`, `[ start_date, end_date, api_key_id, request_id, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, request_method, status ]`, `[ start_date, end_date, api_key_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip ]`, `[ start_date, end_date, interface, request_id, request_method ]`, `[ start_date, end_date, interface, request_id, status ]`, `[ start_date, end_date, interface, request_id, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method ]`, `[ start_date, end_date, interface, request_ip, status ]`, `[ start_date, end_date, interface, request_ip, user_id ]`, `[ start_date, end_date, interface, request_method, status ]`, `[ start_date, end_date, interface, request_method, user_id ]`, `[ start_date, end_date, interface, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method ]`, `[ start_date, end_date, request_id, request_ip, status ]`, `[ start_date, end_date, request_id, request_ip, user_id ]`, `[ start_date, end_date, request_id, request_method, status ]`, `[ start_date, end_date, request_id, request_method, user_id ]`, `[ start_date, end_date, request_id, status, user_id ]`, `[ start_date, end_date, request_ip, request_method, status ]`, `[ start_date, end_date, request_ip, request_method, user_id ]`, `[ start_date, end_date, request_ip, status, user_id ]`, `[ start_date, end_date, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip ]`, `[ start_date, api_key_id, interface, request_id, request_method ]`, `[ start_date, api_key_id, interface, request_id, status ]`, `[ start_date, api_key_id, interface, request_id, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method ]`, `[ start_date, api_key_id, interface, request_ip, status ]`, `[ start_date, api_key_id, interface, request_ip, user_id ]`, `[ start_date, api_key_id, interface, request_method, status ]`, `[ start_date, api_key_id, interface, request_method, user_id ]`, `[ start_date, api_key_id, interface, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method ]`, `[ start_date, api_key_id, request_id, request_ip, status ]`, `[ start_date, api_key_id, request_id, request_ip, user_id ]`, `[ start_date, api_key_id, request_id, request_method, status ]`, `[ start_date, api_key_id, request_id, request_method, user_id ]`, `[ start_date, api_key_id, request_id, status, user_id ]`, `[ start_date, api_key_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method ]`, `[ start_date, interface, request_id, request_ip, status ]`, `[ start_date, interface, request_id, request_ip, user_id ]`, `[ start_date, interface, request_id, request_method, status ]`, `[ start_date, interface, request_id, request_method, user_id ]`, `[ start_date, interface, request_id, status, user_id ]`, `[ start_date, interface, request_ip, request_method, status ]`, `[ start_date, interface, request_ip, request_method, user_id ]`, `[ start_date, interface, request_ip, status, user_id ]`, `[ start_date, interface, request_method, status, user_id ]`, `[ start_date, request_id, request_ip, request_method, status ]`, `[ start_date, request_id, request_ip, request_method, user_id ]`, `[ start_date, request_id, request_ip, status, user_id ]`, `[ start_date, request_id, request_method, status, user_id ]`, `[ start_date, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip ]`, `[ end_date, api_key_id, interface, request_id, request_method ]`, `[ end_date, api_key_id, interface, request_id, status ]`, `[ end_date, api_key_id, interface, request_id, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method ]`, `[ end_date, api_key_id, interface, request_ip, status ]`, `[ end_date, api_key_id, interface, request_ip, user_id ]`, `[ end_date, api_key_id, interface, request_method, status ]`, `[ end_date, api_key_id, interface, request_method, user_id ]`, `[ end_date, api_key_id, interface, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method ]`, `[ end_date, api_key_id, request_id, request_ip, status ]`, `[ end_date, api_key_id, request_id, request_ip, user_id ]`, `[ end_date, api_key_id, request_id, request_method, status ]`, `[ end_date, api_key_id, request_id, request_method, user_id ]`, `[ end_date, api_key_id, request_id, status, user_id ]`, `[ end_date, api_key_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method ]`, `[ end_date, interface, request_id, request_ip, status ]`, `[ end_date, interface, request_id, request_ip, user_id ]`, `[ end_date, interface, request_id, request_method, status ]`, `[ end_date, interface, request_id, request_method, user_id ]`, `[ end_date, interface, request_id, status, user_id ]`, `[ end_date, interface, request_ip, request_method, status ]`, `[ end_date, interface, request_ip, request_method, user_id ]`, `[ end_date, interface, request_ip, status, user_id ]`, `[ end_date, interface, request_method, status, user_id ]`, `[ end_date, request_id, request_ip, request_method, status ]`, `[ end_date, request_id, request_ip, request_method, user_id ]`, `[ end_date, request_id, request_ip, status, user_id ]`, `[ end_date, request_id, request_method, status, user_id ]`, `[ end_date, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method ]`, `[ api_key_id, interface, request_id, request_ip, status ]`, `[ api_key_id, interface, request_id, request_ip, user_id ]`, `[ api_key_id, interface, request_id, request_method, status ]`, `[ api_key_id, interface, request_id, request_method, user_id ]`, `[ api_key_id, interface, request_id, status, user_id ]`, `[ api_key_id, interface, request_ip, request_method, status ]`, `[ api_key_id, interface, request_ip, request_method, user_id ]`, `[ api_key_id, interface, request_ip, status, user_id ]`, `[ api_key_id, interface, request_method, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method, status ]`, `[ api_key_id, request_id, request_ip, request_method, user_id ]`, `[ api_key_id, request_id, request_ip, status, user_id ]`, `[ api_key_id, request_id, request_method, status, user_id ]`, `[ api_key_id, request_ip, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method, status ]`, `[ interface, request_id, request_ip, request_method, user_id ]`, `[ interface, request_id, request_ip, status, user_id ]`, `[ interface, request_id, request_method, status, user_id ]`, `[ interface, request_ip, request_method, status, user_id ]`, `[ request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_id, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_ip, status ]`, `[ start_date, end_date, api_key_id, interface, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_method, status ]`, `[ start_date, end_date, api_key_id, request_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_id, status, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method ]`, `[ start_date, end_date, interface, request_id, request_ip, status ]`, `[ start_date, end_date, interface, request_id, request_ip, user_id ]`, `[ start_date, end_date, interface, request_id, request_method, status ]`, `[ start_date, end_date, interface, request_id, request_method, user_id ]`, `[ start_date, end_date, interface, request_id, status, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method, status ]`, `[ start_date, end_date, interface, request_ip, request_method, user_id ]`, `[ start_date, end_date, interface, request_ip, status, user_id ]`, `[ start_date, end_date, interface, request_method, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, request_id, request_method, status, user_id ]`, `[ start_date, end_date, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ start_date, api_key_id, interface, request_id, request_ip, status ]`, `[ start_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_method, status ]`, `[ start_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_id, status, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method, status ]`, `[ start_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_ip, status, user_id ]`, `[ start_date, api_key_id, interface, request_method, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, request_id, request_method, status, user_id ]`, `[ start_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method, status ]`, `[ start_date, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, interface, request_id, request_ip, status, user_id ]`, `[ start_date, interface, request_id, request_method, status, user_id ]`, `[ start_date, interface, request_ip, request_method, status, user_id ]`, `[ start_date, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ end_date, api_key_id, interface, request_id, request_ip, status ]`, `[ end_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_method, status ]`, `[ end_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_id, status, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method, status ]`, `[ end_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_ip, status, user_id ]`, `[ end_date, api_key_id, interface, request_method, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, request_id, request_method, status, user_id ]`, `[ end_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method, status ]`, `[ end_date, interface, request_id, request_ip, request_method, user_id ]`, `[ end_date, interface, request_id, request_ip, status, user_id ]`, `[ end_date, interface, request_id, request_method, status, user_id ]`, `[ end_date, interface, request_ip, request_method, status, user_id ]`, `[ end_date, request_id, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ api_key_id, interface, request_id, request_method, status, user_id ]`, `[ api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, status, user_id ]` or `[ end_date, api_key_id, interface, request_id, request_ip, request_method, status, user_id ]`.
|
55
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `api_key_id`, `interface`, `request_ip` or `request_method`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ api_key_id ]`, `[ interface ]`, `[ request_id ]`, `[ request_ip ]`, `[ request_method ]`, `[ status ]`, `[ user_id ]`, `[ start_date, end_date ]`, `[ start_date, api_key_id ]`, `[ start_date, interface ]`, `[ start_date, request_id ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, status ]`, `[ start_date, user_id ]`, `[ end_date, api_key_id ]`, `[ end_date, interface ]`, `[ end_date, request_id ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, status ]`, `[ end_date, user_id ]`, `[ api_key_id, interface ]`, `[ api_key_id, request_id ]`, `[ api_key_id, request_ip ]`, `[ api_key_id, request_method ]`, `[ api_key_id, status ]`, `[ api_key_id, user_id ]`, `[ interface, request_id ]`, `[ interface, request_ip ]`, `[ interface, request_method ]`, `[ interface, status ]`, `[ interface, user_id ]`, `[ request_id, request_ip ]`, `[ request_id, request_method ]`, `[ request_id, status ]`, `[ request_id, user_id ]`, `[ request_ip, request_method ]`, `[ request_ip, status ]`, `[ request_ip, user_id ]`, `[ request_method, status ]`, `[ request_method, user_id ]`, `[ status, user_id ]`, `[ start_date, end_date, api_key_id ]`, `[ start_date, end_date, interface ]`, `[ start_date, end_date, request_id ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, user_id ]`, `[ start_date, api_key_id, interface ]`, `[ start_date, api_key_id, request_id ]`, `[ start_date, api_key_id, request_ip ]`, `[ start_date, api_key_id, request_method ]`, `[ start_date, api_key_id, status ]`, `[ start_date, api_key_id, user_id ]`, `[ start_date, interface, request_id ]`, `[ start_date, interface, request_ip ]`, `[ start_date, interface, request_method ]`, `[ start_date, interface, status ]`, `[ start_date, interface, user_id ]`, `[ start_date, request_id, request_ip ]`, `[ start_date, request_id, request_method ]`, `[ start_date, request_id, status ]`, `[ start_date, request_id, user_id ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, status ]`, `[ start_date, request_ip, user_id ]`, `[ start_date, request_method, status ]`, `[ start_date, request_method, user_id ]`, `[ start_date, status, user_id ]`, `[ end_date, api_key_id, interface ]`, `[ end_date, api_key_id, request_id ]`, `[ end_date, api_key_id, request_ip ]`, `[ end_date, api_key_id, request_method ]`, `[ end_date, api_key_id, status ]`, `[ end_date, api_key_id, user_id ]`, `[ end_date, interface, request_id ]`, `[ end_date, interface, request_ip ]`, `[ end_date, interface, request_method ]`, `[ end_date, interface, status ]`, `[ end_date, interface, user_id ]`, `[ end_date, request_id, request_ip ]`, `[ end_date, request_id, request_method ]`, `[ end_date, request_id, status ]`, `[ end_date, request_id, user_id ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, status ]`, `[ end_date, request_ip, user_id ]`, `[ end_date, request_method, status ]`, `[ end_date, request_method, user_id ]`, `[ end_date, status, user_id ]`, `[ api_key_id, interface, request_id ]`, `[ api_key_id, interface, request_ip ]`, `[ api_key_id, interface, request_method ]`, `[ api_key_id, interface, status ]`, `[ api_key_id, interface, user_id ]`, `[ api_key_id, request_id, request_ip ]`, `[ api_key_id, request_id, request_method ]`, `[ api_key_id, request_id, status ]`, `[ api_key_id, request_id, user_id ]`, `[ api_key_id, request_ip, request_method ]`, `[ api_key_id, request_ip, status ]`, `[ api_key_id, request_ip, user_id ]`, `[ api_key_id, request_method, status ]`, `[ api_key_id, request_method, user_id ]`, `[ api_key_id, status, user_id ]`, `[ interface, request_id, request_ip ]`, `[ interface, request_id, request_method ]`, `[ interface, request_id, status ]`, `[ interface, request_id, user_id ]`, `[ interface, request_ip, request_method ]`, `[ interface, request_ip, status ]`, `[ interface, request_ip, user_id ]`, `[ interface, request_method, status ]`, `[ interface, request_method, user_id ]`, `[ interface, status, user_id ]`, `[ request_id, request_ip, request_method ]`, `[ request_id, request_ip, status ]`, `[ request_id, request_ip, user_id ]`, `[ request_id, request_method, status ]`, `[ request_id, request_method, user_id ]`, `[ request_id, status, user_id ]`, `[ request_ip, request_method, status ]`, `[ request_ip, request_method, user_id ]`, `[ request_ip, status, user_id ]`, `[ request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface ]`, `[ start_date, end_date, api_key_id, request_id ]`, `[ start_date, end_date, api_key_id, request_ip ]`, `[ start_date, end_date, api_key_id, request_method ]`, `[ start_date, end_date, api_key_id, status ]`, `[ start_date, end_date, api_key_id, user_id ]`, `[ start_date, end_date, interface, request_id ]`, `[ start_date, end_date, interface, request_ip ]`, `[ start_date, end_date, interface, request_method ]`, `[ start_date, end_date, interface, status ]`, `[ start_date, end_date, interface, user_id ]`, `[ start_date, end_date, request_id, request_ip ]`, `[ start_date, end_date, request_id, request_method ]`, `[ start_date, end_date, request_id, status ]`, `[ start_date, end_date, request_id, user_id ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, status ]`, `[ start_date, end_date, request_ip, user_id ]`, `[ start_date, end_date, request_method, status ]`, `[ start_date, end_date, request_method, user_id ]`, `[ start_date, end_date, status, user_id ]`, `[ start_date, api_key_id, interface, request_id ]`, `[ start_date, api_key_id, interface, request_ip ]`, `[ start_date, api_key_id, interface, request_method ]`, `[ start_date, api_key_id, interface, status ]`, `[ start_date, api_key_id, interface, user_id ]`, `[ start_date, api_key_id, request_id, request_ip ]`, `[ start_date, api_key_id, request_id, request_method ]`, `[ start_date, api_key_id, request_id, status ]`, `[ start_date, api_key_id, request_id, user_id ]`, `[ start_date, api_key_id, request_ip, request_method ]`, `[ start_date, api_key_id, request_ip, status ]`, `[ start_date, api_key_id, request_ip, user_id ]`, `[ start_date, api_key_id, request_method, status ]`, `[ start_date, api_key_id, request_method, user_id ]`, `[ start_date, api_key_id, status, user_id ]`, `[ start_date, interface, request_id, request_ip ]`, `[ start_date, interface, request_id, request_method ]`, `[ start_date, interface, request_id, status ]`, `[ start_date, interface, request_id, user_id ]`, `[ start_date, interface, request_ip, request_method ]`, `[ start_date, interface, request_ip, status ]`, `[ start_date, interface, request_ip, user_id ]`, `[ start_date, interface, request_method, status ]`, `[ start_date, interface, request_method, user_id ]`, `[ start_date, interface, status, user_id ]`, `[ start_date, request_id, request_ip, request_method ]`, `[ start_date, request_id, request_ip, status ]`, `[ start_date, request_id, request_ip, user_id ]`, `[ start_date, request_id, request_method, status ]`, `[ start_date, request_id, request_method, user_id ]`, `[ start_date, request_id, status, user_id ]`, `[ start_date, request_ip, request_method, status ]`, `[ start_date, request_ip, request_method, user_id ]`, `[ start_date, request_ip, status, user_id ]`, `[ start_date, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id ]`, `[ end_date, api_key_id, interface, request_ip ]`, `[ end_date, api_key_id, interface, request_method ]`, `[ end_date, api_key_id, interface, status ]`, `[ end_date, api_key_id, interface, user_id ]`, `[ end_date, api_key_id, request_id, request_ip ]`, `[ end_date, api_key_id, request_id, request_method ]`, `[ end_date, api_key_id, request_id, status ]`, `[ end_date, api_key_id, request_id, user_id ]`, `[ end_date, api_key_id, request_ip, request_method ]`, `[ end_date, api_key_id, request_ip, status ]`, `[ end_date, api_key_id, request_ip, user_id ]`, `[ end_date, api_key_id, request_method, status ]`, `[ end_date, api_key_id, request_method, user_id ]`, `[ end_date, api_key_id, status, user_id ]`, `[ end_date, interface, request_id, request_ip ]`, `[ end_date, interface, request_id, request_method ]`, `[ end_date, interface, request_id, status ]`, `[ end_date, interface, request_id, user_id ]`, `[ end_date, interface, request_ip, request_method ]`, `[ end_date, interface, request_ip, status ]`, `[ end_date, interface, request_ip, user_id ]`, `[ end_date, interface, request_method, status ]`, `[ end_date, interface, request_method, user_id ]`, `[ end_date, interface, status, user_id ]`, `[ end_date, request_id, request_ip, request_method ]`, `[ end_date, request_id, request_ip, status ]`, `[ end_date, request_id, request_ip, user_id ]`, `[ end_date, request_id, request_method, status ]`, `[ end_date, request_id, request_method, user_id ]`, `[ end_date, request_id, status, user_id ]`, `[ end_date, request_ip, request_method, status ]`, `[ end_date, request_ip, request_method, user_id ]`, `[ end_date, request_ip, status, user_id ]`, `[ end_date, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip ]`, `[ api_key_id, interface, request_id, request_method ]`, `[ api_key_id, interface, request_id, status ]`, `[ api_key_id, interface, request_id, user_id ]`, `[ api_key_id, interface, request_ip, request_method ]`, `[ api_key_id, interface, request_ip, status ]`, `[ api_key_id, interface, request_ip, user_id ]`, `[ api_key_id, interface, request_method, status ]`, `[ api_key_id, interface, request_method, user_id ]`, `[ api_key_id, interface, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method ]`, `[ api_key_id, request_id, request_ip, status ]`, `[ api_key_id, request_id, request_ip, user_id ]`, `[ api_key_id, request_id, request_method, status ]`, `[ api_key_id, request_id, request_method, user_id ]`, `[ api_key_id, request_id, status, user_id ]`, `[ api_key_id, request_ip, request_method, status ]`, `[ api_key_id, request_ip, request_method, user_id ]`, `[ api_key_id, request_ip, status, user_id ]`, `[ api_key_id, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method ]`, `[ interface, request_id, request_ip, status ]`, `[ interface, request_id, request_ip, user_id ]`, `[ interface, request_id, request_method, status ]`, `[ interface, request_id, request_method, user_id ]`, `[ interface, request_id, status, user_id ]`, `[ interface, request_ip, request_method, status ]`, `[ interface, request_ip, request_method, user_id ]`, `[ interface, request_ip, status, user_id ]`, `[ interface, request_method, status, user_id ]`, `[ request_id, request_ip, request_method, status ]`, `[ request_id, request_ip, request_method, user_id ]`, `[ request_id, request_ip, status, user_id ]`, `[ request_id, request_method, status, user_id ]`, `[ request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip ]`, `[ start_date, end_date, api_key_id, interface, request_method ]`, `[ start_date, end_date, api_key_id, interface, status ]`, `[ start_date, end_date, api_key_id, interface, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip ]`, `[ start_date, end_date, api_key_id, request_id, request_method ]`, `[ start_date, end_date, api_key_id, request_id, status ]`, `[ start_date, end_date, api_key_id, request_id, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, request_method, status ]`, `[ start_date, end_date, api_key_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip ]`, `[ start_date, end_date, interface, request_id, request_method ]`, `[ start_date, end_date, interface, request_id, status ]`, `[ start_date, end_date, interface, request_id, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method ]`, `[ start_date, end_date, interface, request_ip, status ]`, `[ start_date, end_date, interface, request_ip, user_id ]`, `[ start_date, end_date, interface, request_method, status ]`, `[ start_date, end_date, interface, request_method, user_id ]`, `[ start_date, end_date, interface, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method ]`, `[ start_date, end_date, request_id, request_ip, status ]`, `[ start_date, end_date, request_id, request_ip, user_id ]`, `[ start_date, end_date, request_id, request_method, status ]`, `[ start_date, end_date, request_id, request_method, user_id ]`, `[ start_date, end_date, request_id, status, user_id ]`, `[ start_date, end_date, request_ip, request_method, status ]`, `[ start_date, end_date, request_ip, request_method, user_id ]`, `[ start_date, end_date, request_ip, status, user_id ]`, `[ start_date, end_date, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip ]`, `[ start_date, api_key_id, interface, request_id, request_method ]`, `[ start_date, api_key_id, interface, request_id, status ]`, `[ start_date, api_key_id, interface, request_id, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method ]`, `[ start_date, api_key_id, interface, request_ip, status ]`, `[ start_date, api_key_id, interface, request_ip, user_id ]`, `[ start_date, api_key_id, interface, request_method, status ]`, `[ start_date, api_key_id, interface, request_method, user_id ]`, `[ start_date, api_key_id, interface, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method ]`, `[ start_date, api_key_id, request_id, request_ip, status ]`, `[ start_date, api_key_id, request_id, request_ip, user_id ]`, `[ start_date, api_key_id, request_id, request_method, status ]`, `[ start_date, api_key_id, request_id, request_method, user_id ]`, `[ start_date, api_key_id, request_id, status, user_id ]`, `[ start_date, api_key_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method ]`, `[ start_date, interface, request_id, request_ip, status ]`, `[ start_date, interface, request_id, request_ip, user_id ]`, `[ start_date, interface, request_id, request_method, status ]`, `[ start_date, interface, request_id, request_method, user_id ]`, `[ start_date, interface, request_id, status, user_id ]`, `[ start_date, interface, request_ip, request_method, status ]`, `[ start_date, interface, request_ip, request_method, user_id ]`, `[ start_date, interface, request_ip, status, user_id ]`, `[ start_date, interface, request_method, status, user_id ]`, `[ start_date, request_id, request_ip, request_method, status ]`, `[ start_date, request_id, request_ip, request_method, user_id ]`, `[ start_date, request_id, request_ip, status, user_id ]`, `[ start_date, request_id, request_method, status, user_id ]`, `[ start_date, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip ]`, `[ end_date, api_key_id, interface, request_id, request_method ]`, `[ end_date, api_key_id, interface, request_id, status ]`, `[ end_date, api_key_id, interface, request_id, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method ]`, `[ end_date, api_key_id, interface, request_ip, status ]`, `[ end_date, api_key_id, interface, request_ip, user_id ]`, `[ end_date, api_key_id, interface, request_method, status ]`, `[ end_date, api_key_id, interface, request_method, user_id ]`, `[ end_date, api_key_id, interface, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method ]`, `[ end_date, api_key_id, request_id, request_ip, status ]`, `[ end_date, api_key_id, request_id, request_ip, user_id ]`, `[ end_date, api_key_id, request_id, request_method, status ]`, `[ end_date, api_key_id, request_id, request_method, user_id ]`, `[ end_date, api_key_id, request_id, status, user_id ]`, `[ end_date, api_key_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method ]`, `[ end_date, interface, request_id, request_ip, status ]`, `[ end_date, interface, request_id, request_ip, user_id ]`, `[ end_date, interface, request_id, request_method, status ]`, `[ end_date, interface, request_id, request_method, user_id ]`, `[ end_date, interface, request_id, status, user_id ]`, `[ end_date, interface, request_ip, request_method, status ]`, `[ end_date, interface, request_ip, request_method, user_id ]`, `[ end_date, interface, request_ip, status, user_id ]`, `[ end_date, interface, request_method, status, user_id ]`, `[ end_date, request_id, request_ip, request_method, status ]`, `[ end_date, request_id, request_ip, request_method, user_id ]`, `[ end_date, request_id, request_ip, status, user_id ]`, `[ end_date, request_id, request_method, status, user_id ]`, `[ end_date, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method ]`, `[ api_key_id, interface, request_id, request_ip, status ]`, `[ api_key_id, interface, request_id, request_ip, user_id ]`, `[ api_key_id, interface, request_id, request_method, status ]`, `[ api_key_id, interface, request_id, request_method, user_id ]`, `[ api_key_id, interface, request_id, status, user_id ]`, `[ api_key_id, interface, request_ip, request_method, status ]`, `[ api_key_id, interface, request_ip, request_method, user_id ]`, `[ api_key_id, interface, request_ip, status, user_id ]`, `[ api_key_id, interface, request_method, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method, status ]`, `[ api_key_id, request_id, request_ip, request_method, user_id ]`, `[ api_key_id, request_id, request_ip, status, user_id ]`, `[ api_key_id, request_id, request_method, status, user_id ]`, `[ api_key_id, request_ip, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method, status ]`, `[ interface, request_id, request_ip, request_method, user_id ]`, `[ interface, request_id, request_ip, status, user_id ]`, `[ interface, request_id, request_method, status, user_id ]`, `[ interface, request_ip, request_method, status, user_id ]`, `[ request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_id, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_ip, status ]`, `[ start_date, end_date, api_key_id, interface, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_method, status ]`, `[ start_date, end_date, api_key_id, request_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_id, status, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method ]`, `[ start_date, end_date, interface, request_id, request_ip, status ]`, `[ start_date, end_date, interface, request_id, request_ip, user_id ]`, `[ start_date, end_date, interface, request_id, request_method, status ]`, `[ start_date, end_date, interface, request_id, request_method, user_id ]`, `[ start_date, end_date, interface, request_id, status, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method, status ]`, `[ start_date, end_date, interface, request_ip, request_method, user_id ]`, `[ start_date, end_date, interface, request_ip, status, user_id ]`, `[ start_date, end_date, interface, request_method, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, request_id, request_method, status, user_id ]`, `[ start_date, end_date, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ start_date, api_key_id, interface, request_id, request_ip, status ]`, `[ start_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_method, status ]`, `[ start_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_id, status, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method, status ]`, `[ start_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_ip, status, user_id ]`, `[ start_date, api_key_id, interface, request_method, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, request_id, request_method, status, user_id ]`, `[ start_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method, status ]`, `[ start_date, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, interface, request_id, request_ip, status, user_id ]`, `[ start_date, interface, request_id, request_method, status, user_id ]`, `[ start_date, interface, request_ip, request_method, status, user_id ]`, `[ start_date, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ end_date, api_key_id, interface, request_id, request_ip, status ]`, `[ end_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_method, status ]`, `[ end_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_id, status, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method, status ]`, `[ end_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_ip, status, user_id ]`, `[ end_date, api_key_id, interface, request_method, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, request_id, request_method, status, user_id ]`, `[ end_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method, status ]`, `[ end_date, interface, request_id, request_ip, request_method, user_id ]`, `[ end_date, interface, request_id, request_ip, status, user_id ]`, `[ end_date, interface, request_id, request_method, status, user_id ]`, `[ end_date, interface, request_ip, request_method, status, user_id ]`, `[ end_date, request_id, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ api_key_id, interface, request_id, request_method, status, user_id ]`, `[ api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ end_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ end_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ end_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ end_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ end_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ api_key_id, interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method, status ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, request_method, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_ip, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_id, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, interface, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, api_key_id, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, end_date, interface, request_id, request_ip, request_method, status, user_id ]`, `[ start_date, api_key_id, interface, request_id, request_ip, request_method, status, user_id ]` or `[ end_date, api_key_id, interface, request_id, request_ip, request_method, status, user_id ]`.
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# AutomationLog
|
2
|
+
|
3
|
+
## Example AutomationLog Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"timestamp": "2000-01-01T01:00:00Z",
|
8
|
+
"automation_id": 1,
|
9
|
+
"automation_run_id": 1,
|
10
|
+
"dest_path": "example",
|
11
|
+
"error_type": "example",
|
12
|
+
"message": "example",
|
13
|
+
"operation": "example",
|
14
|
+
"path": "example",
|
15
|
+
"status": "example",
|
16
|
+
"type": "example"
|
17
|
+
}
|
18
|
+
```
|
19
|
+
|
20
|
+
* `timestamp` (date-time): Start Time of Action
|
21
|
+
* `automation_id` (int64): Automation ID
|
22
|
+
* `automation_run_id` (int64): Automation Run ID
|
23
|
+
* `dest_path` (string): Destination path, for moves and copies
|
24
|
+
* `error_type` (string): Error type, if applicable
|
25
|
+
* `message` (string): Message
|
26
|
+
* `operation` (string): Operation type
|
27
|
+
* `path` (string): File path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
28
|
+
* `status` (string): Status
|
29
|
+
* `type` (string): Operation type
|
30
|
+
|
31
|
+
---
|
32
|
+
|
33
|
+
## List Automation Logs
|
34
|
+
|
35
|
+
```
|
36
|
+
await AutomationLog.list({
|
37
|
+
'per_page': 1,
|
38
|
+
})
|
39
|
+
```
|
40
|
+
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
45
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `automation_id`, `automation_run_id`, `operation`, `path`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, type ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, type ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, type ]`, `[ path, status ]`, `[ path, type ]`, `[ status, type ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_id, type ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, automation_run_id, type ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, path, status ]`, `[ start_date, path, type ]`, `[ start_date, status, type ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_id, type ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, automation_run_id, type ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, path, status ]`, `[ end_date, path, type ]`, `[ end_date, status, type ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, type ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, type ]`, `[ automation_id, path, status ]`, `[ automation_id, path, type ]`, `[ automation_id, status, type ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, type ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, type ]`, `[ automation_run_id, status, type ]`, `[ operation, path, status ]`, `[ operation, path, type ]`, `[ operation, status, type ]`, `[ path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_id, type ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, automation_run_id, type ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, path, status ]`, `[ start_date, end_date, path, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, automation_run_id, type ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, operation, type ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_id, path, type ]`, `[ start_date, automation_id, status, type ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, operation, type ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, automation_run_id, path, type ]`, `[ start_date, automation_run_id, status, type ]`, `[ start_date, operation, path, status ]`, `[ start_date, operation, path, type ]`, `[ start_date, operation, status, type ]`, `[ start_date, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, automation_run_id, type ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, operation, type ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_id, path, type ]`, `[ end_date, automation_id, status, type ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, operation, type ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, automation_run_id, path, type ]`, `[ end_date, automation_run_id, status, type ]`, `[ end_date, operation, path, status ]`, `[ end_date, operation, path, type ]`, `[ end_date, operation, status, type ]`, `[ end_date, path, status, type ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, type ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, type ]`, `[ automation_id, automation_run_id, status, type ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, type ]`, `[ automation_id, operation, status, type ]`, `[ automation_id, path, status, type ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, type ]`, `[ automation_run_id, operation, status, type ]`, `[ automation_run_id, path, status, type ]`, `[ operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, automation_run_id, type ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, operation, type ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_id, path, type ]`, `[ start_date, end_date, automation_id, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, operation, type ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, automation_run_id, path, type ]`, `[ start_date, end_date, automation_run_id, status, type ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, end_date, operation, path, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, end_date, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, operation, type ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, automation_run_id, path, type ]`, `[ start_date, automation_id, automation_run_id, status, type ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_id, operation, path, type ]`, `[ start_date, automation_id, operation, status, type ]`, `[ start_date, automation_id, path, status, type ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, type ]`, `[ start_date, automation_run_id, operation, status, type ]`, `[ start_date, automation_run_id, path, status, type ]`, `[ start_date, operation, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, operation, type ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, automation_run_id, path, type ]`, `[ end_date, automation_id, automation_run_id, status, type ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_id, operation, path, type ]`, `[ end_date, automation_id, operation, status, type ]`, `[ end_date, automation_id, path, status, type ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, type ]`, `[ end_date, automation_run_id, operation, status, type ]`, `[ end_date, automation_run_id, path, status, type ]`, `[ end_date, operation, path, status, type ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, type ]`, `[ automation_id, automation_run_id, operation, status, type ]`, `[ automation_id, automation_run_id, path, status, type ]`, `[ automation_id, operation, path, status, type ]`, `[ automation_run_id, operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, type ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, type ]`, `[ start_date, end_date, automation_id, automation_run_id, status, type ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_id, operation, path, type ]`, `[ start_date, end_date, automation_id, operation, status, type ]`, `[ start_date, end_date, automation_id, path, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, type ]`, `[ start_date, end_date, automation_run_id, operation, status, type ]`, `[ start_date, end_date, automation_run_id, path, status, type ]`, `[ start_date, end_date, operation, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, type ]`, `[ start_date, automation_id, automation_run_id, operation, status, type ]`, `[ start_date, automation_id, automation_run_id, path, status, type ]`, `[ start_date, automation_id, operation, path, status, type ]`, `[ start_date, automation_run_id, operation, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path, type ]`, `[ end_date, automation_id, automation_run_id, operation, status, type ]`, `[ end_date, automation_id, automation_run_id, path, status, type ]`, `[ end_date, automation_id, operation, path, status, type ]`, `[ end_date, automation_run_id, operation, path, status, type ]`, `[ automation_id, automation_run_id, operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status, type ]`, `[ start_date, end_date, automation_id, operation, path, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path, status, type ]` or `[ end_date, automation_id, automation_run_id, operation, path, status, type ]`.
|
47
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `path`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, type ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, type ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, type ]`, `[ path, status ]`, `[ path, type ]`, `[ status, type ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_id, type ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, automation_run_id, type ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, path, status ]`, `[ start_date, path, type ]`, `[ start_date, status, type ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_id, type ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, automation_run_id, type ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, path, status ]`, `[ end_date, path, type ]`, `[ end_date, status, type ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, type ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, type ]`, `[ automation_id, path, status ]`, `[ automation_id, path, type ]`, `[ automation_id, status, type ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, type ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, type ]`, `[ automation_run_id, status, type ]`, `[ operation, path, status ]`, `[ operation, path, type ]`, `[ operation, status, type ]`, `[ path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_id, type ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, automation_run_id, type ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, path, status ]`, `[ start_date, end_date, path, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, automation_run_id, type ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, operation, type ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_id, path, type ]`, `[ start_date, automation_id, status, type ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, operation, type ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, automation_run_id, path, type ]`, `[ start_date, automation_run_id, status, type ]`, `[ start_date, operation, path, status ]`, `[ start_date, operation, path, type ]`, `[ start_date, operation, status, type ]`, `[ start_date, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, automation_run_id, type ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, operation, type ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_id, path, type ]`, `[ end_date, automation_id, status, type ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, operation, type ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, automation_run_id, path, type ]`, `[ end_date, automation_run_id, status, type ]`, `[ end_date, operation, path, status ]`, `[ end_date, operation, path, type ]`, `[ end_date, operation, status, type ]`, `[ end_date, path, status, type ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, type ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, type ]`, `[ automation_id, automation_run_id, status, type ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, type ]`, `[ automation_id, operation, status, type ]`, `[ automation_id, path, status, type ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, type ]`, `[ automation_run_id, operation, status, type ]`, `[ automation_run_id, path, status, type ]`, `[ operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, automation_run_id, type ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, operation, type ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_id, path, type ]`, `[ start_date, end_date, automation_id, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, operation, type ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, automation_run_id, path, type ]`, `[ start_date, end_date, automation_run_id, status, type ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, end_date, operation, path, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, end_date, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, operation, type ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, automation_run_id, path, type ]`, `[ start_date, automation_id, automation_run_id, status, type ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_id, operation, path, type ]`, `[ start_date, automation_id, operation, status, type ]`, `[ start_date, automation_id, path, status, type ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, type ]`, `[ start_date, automation_run_id, operation, status, type ]`, `[ start_date, automation_run_id, path, status, type ]`, `[ start_date, operation, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, operation, type ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, automation_run_id, path, type ]`, `[ end_date, automation_id, automation_run_id, status, type ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_id, operation, path, type ]`, `[ end_date, automation_id, operation, status, type ]`, `[ end_date, automation_id, path, status, type ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, type ]`, `[ end_date, automation_run_id, operation, status, type ]`, `[ end_date, automation_run_id, path, status, type ]`, `[ end_date, operation, path, status, type ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, type ]`, `[ automation_id, automation_run_id, operation, status, type ]`, `[ automation_id, automation_run_id, path, status, type ]`, `[ automation_id, operation, path, status, type ]`, `[ automation_run_id, operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, type ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, type ]`, `[ start_date, end_date, automation_id, automation_run_id, status, type ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_id, operation, path, type ]`, `[ start_date, end_date, automation_id, operation, status, type ]`, `[ start_date, end_date, automation_id, path, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, type ]`, `[ start_date, end_date, automation_run_id, operation, status, type ]`, `[ start_date, end_date, automation_run_id, path, status, type ]`, `[ start_date, end_date, operation, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, type ]`, `[ start_date, automation_id, automation_run_id, operation, status, type ]`, `[ start_date, automation_id, automation_run_id, path, status, type ]`, `[ start_date, automation_id, operation, path, status, type ]`, `[ start_date, automation_run_id, operation, path, status, type ]`, `[ end_date, automation_id, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path, type ]`, `[ end_date, automation_id, automation_run_id, operation, status, type ]`, `[ end_date, automation_id, automation_run_id, path, status, type ]`, `[ end_date, automation_id, operation, path, status, type ]`, `[ end_date, automation_run_id, operation, path, status, type ]`, `[ automation_id, automation_run_id, operation, path, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path, type ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status, type ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status, type ]`, `[ start_date, end_date, automation_id, operation, path, status, type ]`, `[ start_date, end_date, automation_run_id, operation, path, status, type ]`, `[ start_date, automation_id, automation_run_id, operation, path, status, type ]` or `[ end_date, automation_id, automation_run_id, operation, path, status, type ]`.
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# EmailLog
|
2
|
+
|
3
|
+
## Example EmailLog Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"timestamp": "2000-01-01T01:00:00Z",
|
8
|
+
"message": "example",
|
9
|
+
"status": "example",
|
10
|
+
"subject": "example",
|
11
|
+
"to": "example",
|
12
|
+
"cc": "example"
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
* `timestamp` (date-time): Start Time of Action
|
17
|
+
* `message` (string): Log Message
|
18
|
+
* `status` (string): Status of E-Mail delivery
|
19
|
+
* `subject` (string): Subject line of E-Mail
|
20
|
+
* `to` (string): To field of E-Mail
|
21
|
+
* `cc` (string): CC field of E-Mail
|
22
|
+
|
23
|
+
---
|
24
|
+
|
25
|
+
## List Email Logs
|
26
|
+
|
27
|
+
```
|
28
|
+
await EmailLog.list({
|
29
|
+
'per_page': 1,
|
30
|
+
})
|
31
|
+
```
|
32
|
+
|
33
|
+
|
34
|
+
### Parameters
|
35
|
+
|
36
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
37
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
|
39
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# ExavaultApiRequestLog
|
2
|
+
|
3
|
+
## Example ExavaultApiRequestLog Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"timestamp": "2000-01-01T01:00:00Z",
|
8
|
+
"endpoint": "example",
|
9
|
+
"version": "example",
|
10
|
+
"request_ip": "example",
|
11
|
+
"request_method": "example",
|
12
|
+
"error_type": "example",
|
13
|
+
"error_message": "example",
|
14
|
+
"user_agent": "example",
|
15
|
+
"response_code": 1,
|
16
|
+
"duration_ms": 1
|
17
|
+
}
|
18
|
+
```
|
19
|
+
|
20
|
+
* `timestamp` (date-time): Start Time of Action
|
21
|
+
* `endpoint` (string): Name of API Endpoint
|
22
|
+
* `version` (string): Exavault API Version
|
23
|
+
* `request_ip` (string): IP of requesting client
|
24
|
+
* `request_method` (string): HTTP Method
|
25
|
+
* `error_type` (string): Error type, if applicable
|
26
|
+
* `error_message` (string): Error message, if applicable
|
27
|
+
* `user_agent` (string): User-Agent
|
28
|
+
* `response_code` (int64): HTTP Response Code
|
29
|
+
* `duration_ms` (int64): Duration (in milliseconds)
|
30
|
+
|
31
|
+
---
|
32
|
+
|
33
|
+
## List Exavault Api Request Logs
|
34
|
+
|
35
|
+
```
|
36
|
+
await ExavaultApiRequestLog.list({
|
37
|
+
'per_page': 1,
|
38
|
+
})
|
39
|
+
```
|
40
|
+
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
45
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
|
47
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# FileMigrationLog
|
2
|
+
|
3
|
+
## Example FileMigrationLog Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"timestamp": "2000-01-01T01:00:00Z",
|
8
|
+
"file_migration_id": 1,
|
9
|
+
"dest_path": "example",
|
10
|
+
"error_type": "example",
|
11
|
+
"message": "example",
|
12
|
+
"operation": "example",
|
13
|
+
"path": "example",
|
14
|
+
"status": "example",
|
15
|
+
"type": "example"
|
16
|
+
}
|
17
|
+
```
|
18
|
+
|
19
|
+
* `timestamp` (date-time): Start Time of Action
|
20
|
+
* `file_migration_id` (int64): File Migration ID
|
21
|
+
* `dest_path` (string): Destination path, for moves and copies
|
22
|
+
* `error_type` (string): Error type, if applicable
|
23
|
+
* `message` (string): Message
|
24
|
+
* `operation` (string): Operation type
|
25
|
+
* `path` (string): File path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
26
|
+
* `status` (string): Status
|
27
|
+
* `type` (string): Operation type
|
28
|
+
|
29
|
+
---
|
30
|
+
|
31
|
+
## List File Migration Logs
|
32
|
+
|
33
|
+
```
|
34
|
+
await FileMigrationLog.list({
|
35
|
+
'per_page': 1,
|
36
|
+
})
|
37
|
+
```
|
38
|
+
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
43
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
44
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `file_migration_id`, `operation`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
|
45
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
|
@@ -32,7 +32,7 @@
|
|
32
32
|
"rackspace_username": "rackspaceuser",
|
33
33
|
"rackspace_region": "dfw",
|
34
34
|
"rackspace_container": "my-container",
|
35
|
-
"auth_setup_link": "auth/:provider
|
35
|
+
"auth_setup_link": "auth/:provider",
|
36
36
|
"auth_status": "in_setup",
|
37
37
|
"auth_account_name": "me@example.com",
|
38
38
|
"one_drive_account_type": "personal",
|
@@ -316,9 +316,16 @@ await RemoteServer.create({
|
|
316
316
|
const [remote_server] = await RemoteServer.list()
|
317
317
|
|
318
318
|
await remote_server.configuration_file({
|
319
|
+
'api_token': "example",
|
319
320
|
'permission_set': "example",
|
320
321
|
'root': "C:\\Users\\",
|
322
|
+
'hostname': "example",
|
323
|
+
'port': 1,
|
324
|
+
'status': "example",
|
325
|
+
'config_version': "example",
|
321
326
|
'private_key': "example",
|
327
|
+
'public_key': "example",
|
328
|
+
'server_host_key': "example",
|
322
329
|
'subdomain': "example",
|
323
330
|
})
|
324
331
|
```
|
@@ -326,9 +333,16 @@ await remote_server.configuration_file({
|
|
326
333
|
### Parameters
|
327
334
|
|
328
335
|
* `id` (int64): Required - Remote Server ID.
|
336
|
+
* `api_token` (string): Files Agent API Token
|
329
337
|
* `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
|
330
338
|
* `root` (string): The root directory for the agent
|
339
|
+
* `hostname` (string):
|
340
|
+
* `port` (int64): Incoming port for files agent connections
|
341
|
+
* `status` (string): either running or shutdown
|
342
|
+
* `config_version` (string): agent config version
|
331
343
|
* `private_key` (string): The private key for the agent
|
344
|
+
* `public_key` (string): public key
|
345
|
+
* `server_host_key` (string):
|
332
346
|
* `subdomain` (string): Files.com subdomain site name
|
333
347
|
|
334
348
|
### Example Response
|
@@ -351,7 +365,14 @@ await remote_server.configuration_file({
|
|
351
365
|
"log_rotate_size": 1,
|
352
366
|
"max_concurrent_jobs": 1,
|
353
367
|
"graceful_shutdown_timeout": 1,
|
354
|
-
"transfer_rate_limit": "example"
|
368
|
+
"transfer_rate_limit": "example",
|
369
|
+
"api_token": "example",
|
370
|
+
"port": 1,
|
371
|
+
"hostname": "example",
|
372
|
+
"public_key": "example",
|
373
|
+
"status": "example",
|
374
|
+
"server_host_key": "example",
|
375
|
+
"config_version": "example"
|
355
376
|
}
|
356
377
|
```
|
357
378
|
|
@@ -516,7 +537,7 @@ await remote_server.update({
|
|
516
537
|
"rackspace_username": "rackspaceuser",
|
517
538
|
"rackspace_region": "dfw",
|
518
539
|
"rackspace_container": "my-container",
|
519
|
-
"auth_setup_link": "auth/:provider
|
540
|
+
"auth_setup_link": "auth/:provider",
|
520
541
|
"auth_status": "in_setup",
|
521
542
|
"auth_account_name": "me@example.com",
|
522
543
|
"one_drive_account_type": "personal",
|
@@ -20,7 +20,14 @@
|
|
20
20
|
"log_rotate_size": 1,
|
21
21
|
"max_concurrent_jobs": 1,
|
22
22
|
"graceful_shutdown_timeout": 1,
|
23
|
-
"transfer_rate_limit": "example"
|
23
|
+
"transfer_rate_limit": "example",
|
24
|
+
"api_token": "example",
|
25
|
+
"port": 1,
|
26
|
+
"hostname": "example",
|
27
|
+
"public_key": "example",
|
28
|
+
"status": "example",
|
29
|
+
"server_host_key": "example",
|
30
|
+
"config_version": "example"
|
24
31
|
}
|
25
32
|
```
|
26
33
|
|
@@ -51,3 +58,10 @@ Examples:
|
|
51
58
|
* 10 requests/minute: '10-M'
|
52
59
|
* 1000 requests/hour: '1000-H'
|
53
60
|
* 2000 requests/day: '2000-D'
|
61
|
+
* `api_token` (string): Files Agent API Token
|
62
|
+
* `port` (int64): Incoming port for files agent connections
|
63
|
+
* `hostname` (string):
|
64
|
+
* `public_key` (string): public key
|
65
|
+
* `status` (string): either running or shutdown
|
66
|
+
* `server_host_key` (string):
|
67
|
+
* `config_version` (string): agent config version
|