CLI: Audit Categories
- Lindsey Byers (Deactivated)
- Andrea Harvey
On This Page
- 1 Audit Categories
- 1.1 List Audit Categories
- 1.1.1 Example
- 1.2 Show an Audit Category
- 1.2.1 Example
- 1.3 Create an Audit Category
- 1.3.1 Example with parameters
- 1.3.2 Example with JSON
- 1.4 Delete an Audit Category
- 1.4.1 Example
- 1.1 List Audit Categories
The CLI references “skysync.” This is expected.
Audit Categories
In the following examples, the authentication parameters are provided within the configuration file. See the authentication section for more information.
List Audit Categories
parameter | description | required | default |
|---|---|---|---|
search, q | Search text | optional |
|
offset | Search offset | optional | 0 |
limit | Search page size | optional | 20 |
Example
Command
skysync-cli transfer-audit-categories listExample results
ID Name Action Level Priority
414625577a8643fbb3498ba552b0220c ParamTest retry warn 9999
17cd1af5358f4a5cb718c7083dbed7ca License Failures retry error 5000
3024e963e1bf45578f6ef7c5722fea53 Conflict Failures retry error 5000
65c5e85659284d279f6dea0c71707fc0 Io Failures retry error 5000
480f984a7dd94343b107553dd017ca83 Invalid Item Failures retry error 5000
e92c5ec1a0f4415ba3efe79a8c78627b Duplicate Item Failures retry error 5000
009fa2b7578d488695a3f0db0dc53553 Item Not Found Failures retry error 5000
9ab945f3d3524f4a9b128eb717cf20fd Policy Failures retry error 5000
a4bdd7af71f6490c817155b4d1dabe51 Permission Failures retry error 5000
ae073f4b34a846ca9a71eabca31f475f Access Failures retry error 5000
9b3b464d77ab4fa5a03d097f6da9f745 Connectivity Failures retry error 5000
814d1fa15a974c83a8bcac10d266798b Unknown Failures retry error 5000Example results (JSON)
[
{
"id": "17cd1af5358f4a5cb718c7083dbed7ca",
"name": "License Failures",
"action": "retry",
"level": "error",
"priority": 5000,
"description": "Files and folders that have failed due an unlicensed product feature.",
"filter": {
"rules": [
{
"filter": {
"name": "audit_type",
"select": null,
"op": "eq",
"value": 5011
},
"type": "filter_context"
}
]
}
},
{
"id": "3024e963e1bf45578f6ef7c5722fea53",
"name": "Conflict Failures",
"action": "retry",
"level": "error",
"priority": 5000,
"description": "Files that have failed due to unresolved conflicts.",
"filter": {
"rules": [
{
"filter": {
"name": "audit_type",
"select": null,
"op": "eq",
"value": 5010
},
"type": "filter_context"
}
]
}
}
]
Show an Audit Category
parameter | description | requires |
|---|---|---|
id | ID of the audit category to be shown | required |
Example
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command with variables
Command with example values
Example results
Example results (JSON)
Create an Audit Category
parameter | description | type | option 1 | option 2 |
|---|---|---|---|---|
name | Audit category name | string | required |
|
description | Audit category description | string | required |
|
action | Action to take when audit category is triggered | string | required |
|
level | Logging Level | string | required |
|
priority | Priority in case multiple audit categories match an error | integer | required |
|
auditType | Error code to match this audit category against | integer | required |
|
options-input | parameter to specify that JSON should be read from pipeline | switch |
| required |
Example with parameters
Command with variables
Command with example values
Expected result
Expected result (JSON)
Example with JSON
Command with variables
Command with example values
Expected result
Expected result (JSON)
Delete an Audit Category
parameter | description | required |
|---|---|---|
id | ID of the audit category to be deleted | required |
Example
In the following example, the authentication parameters are provided within the configuration file. See the authentication section for more information.
Command with variables
Command with example values
Expected result
Error result