Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsAntivirus Profiles

createOrgAntivirusProfile

POST
/api/v1/orgs/{org_id}/avprofiles

Create an organization antivirus scanning profile with inspected protocols, maximum file size, whitelist settings, and fallback action.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Request Body

application/json

Antivirus scanning profile with protocols, limits, and whitelist settings

fallback_action?avprofile_fallback_action

Action to take when antivirus scanning cannot complete. enum: block, log-and-permit, permit.

Value in

  • "block"
  • "log-and-permit"
  • "permit"
max_filesize?integer

Maximum file size scanned by this antivirus profile, in KB

Range20 <= value <= 40000
Default10000
mime_whitelist?array<string>

Content MIME types exempted from antivirus scanning

name*string

Display name of the antivirus profile

protocols?array<>

Network protocols inspected by this antivirus profile

Items1 <= items
url_whitelist?array<string>

Content MIME types exempted from antivirus scanning

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/avprofiles" \  -H "Content-Type: application/json" \  -d '{    "fallback_action": "permit",    "max_filesize": 10000,    "mime_whitelist": [],    "name": "av-custom",    "protocols": [      "http"    ],    "url_whitelist": []  }'
{  "fallback_action": "permit",  "max_filesize": 10000,  "mime_whitelist": [],  "name": "av-custom",  "protocols": [    "http"  ],  "url_whitelist": []}

listOrgAntivirusProfiles GET

List organization antivirus scanning profiles, including inspected protocols, scan limits, whitelist settings, and fallback actions.

getOrgAntivirusProfile GET

Return one organization antivirus scanning profile, including inspected protocols, scan limits, whitelist settings, and fallback action.