Skip to content

Commit beb4800

Browse files
committed
Add virus file endpoints
1 parent 22534fb commit beb4800

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

system_admin_account_operations.yaml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3392,6 +3392,102 @@ paths:
33923392
],
33933393
"count": 2
33943394
}
3395+
/api/v2.1/admin/virus-files/:
3396+
get:
3397+
tags:
3398+
- Logs
3399+
summary: List Virus Files
3400+
operationId: listVirusFiles
3401+
description: |
3402+
Returns a list of files that were detected by the virus scanner.
3403+
3404+
Note: The API returns different fields per object depending on the workspace ownership (group vs. personal workspaces).
3405+
security:
3406+
- AccountTokenAuth: []
3407+
parameters:
3408+
- $ref: "#/components/parameters/page"
3409+
- $ref: "#/components/parameters/per_page"
3410+
- in: query
3411+
name: has_handled
3412+
schema:
3413+
type: string
3414+
enum: [true, false, null]
3415+
responses:
3416+
"200":
3417+
description: OK
3418+
content:
3419+
application/json:
3420+
example:
3421+
virus_file_list:
3422+
- repo_id: 696b27df-173e-4628-8ac2-10347c58a428
3423+
file_path: /asset/af5fa655-ef97-4573-8f2d-c3812e17a548/files/2024-08/eicar.com.txt
3424+
has_deleted: true
3425+
has_ignored": false,
3426+
virus_id: 1
3427+
group_id: 1,
3428+
group_name: group-11
3429+
org_id: 1
3430+
org_name: org-1
3431+
dtable_uuid: af5fa655-ef97-4573-8f2d-c3812e17a548
3432+
dtable_name: rows
3433+
- repo_id: 696b27df-173e-4628-8ac2-10347c58a428
3434+
file_path: /asset/af5fa655-ef97-4573-8f2d-c3812e17a548/files/2024-08/eicar.com (1).txt
3435+
has_deleted: false
3436+
has_ignored: false
3437+
virus_id: 2,
3438+
username: ac8961c4118f4400ad71bada398675b7@auth.local
3439+
nickname: test@demo.com
3440+
org_id: 1
3441+
org_name: org-1
3442+
dtable_uuid: af5fa655-ef97-4573-8f2d-c3812e17a548
3443+
dtable_name: rows
3444+
has_next_page: false
3445+
/api/v2.1/admin/virus-files/{virus_id}/:
3446+
put:
3447+
tags:
3448+
- Logs
3449+
summary: Update Virus File
3450+
operationId: updateVirusFile
3451+
description: Updates the status of a virus file.
3452+
security:
3453+
- AccountTokenAuth: []
3454+
parameters:
3455+
- in: path
3456+
name: virus_id
3457+
required: true
3458+
schema:
3459+
type: integer
3460+
description: The ID of the virus file
3461+
requestBody:
3462+
required: true
3463+
content:
3464+
application/x-www-form-urlencoded:
3465+
schema:
3466+
type: object
3467+
properties:
3468+
ignore:
3469+
type: string
3470+
enum: [true, false]
3471+
required:
3472+
- ignore
3473+
responses:
3474+
"200":
3475+
description: OK
3476+
content:
3477+
application/json:
3478+
example:
3479+
virus_file:
3480+
repo_id: 696b27df-173e-4628-8ac2-10347c58a428
3481+
file_path: /asset/af5fa655-ef97-4573-8f2d-c3812e17a548/files/2024-08/eicar.com (1).txt
3482+
has_deleted: false
3483+
has_ignored: true
3484+
virus_id: 2
3485+
group_id: 1
3486+
group_name: group-11
3487+
org_id: 1
3488+
org_name: org-1
3489+
dtable_uuid: af5fa655-ef97-4573-8f2d-c3812e17a548
3490+
dtable_name: rows
33953491

33963492
# Plugins
33973493
/api/v2.1/admin/dtable-system-plugins/:

0 commit comments

Comments
 (0)