Update a list of policy override of a profile by IDs
Security:
Request Body schema: application/json
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "signatureUuids": [
- "00000001-0001-0001-0001-000000000001",
- "00000001-0001-0001-0001-000000000002"
], - "actionSetId": 1,
- "toEnable": true
}
- 200
{- "signatureUuids": [
- "00000001-0001-0001-0001-000000000001",
- "00000001-0001-0001-0001-000000000002"
], - "profileId": 1,
- "actionSetId": 1,
- "toEnable": true,
- "failures": [
- {
- "policyOverrideId": 1,
- "signatureUuid": "[\"00000001-0001-0001-0001-000000000001\"]",
- "msg": "Policy override not found"
}
]
}
Create a policy override
Security:
Request Body schema: application/json
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "actionSet": {
- "id": 0
}, - "signatureUuid": "string",
- "enabled": true
}
- 200
{- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
Delete a list of policy overrides by signature Uuids
Security:
Request Body schema: application/json
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "signatureUuids": [
- "00000001-0001-0001-0001-000000000001",
- "00000001-0001-0001-0001-000000000002"
]
}
Update a policy override by ID
Security:
Request Body schema: application/json
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "actionSet": {
- "id": 0
}, - "signatureUuid": "string",
- "enabled": true
}
- 200
{- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
List all Digital Vaccine settings
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "digitalvaccinesettings": [
- {
- "id": 0,
- "name": "autodigitalvaccinedownload",
- "enabled": true
}
]
}
Create a new Digital Vaccine setting
Security:
Request Body schema: application/json
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "name": "autodigitalvaccinedownload",
- "enabled": true
}
- 200
{- "id": 0,
- "name": "autodigitalvaccinedownload",
- "enabled": true
}
Update a Digital Vaccine setting by ID
Security:
Request Body schema: application/json
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "name": "autodigitalvaccinedownload",
- "enabled": true
}
- 200
{- "id": 0,
- "name": "autodigitalvaccinedownload",
- "enabled": true
}
Push a Digital Vaccine/Auxiliary Digital Vaccine to an applianceDeprecated
Security:
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "id": 0,
- "applianceId": 0,
- "state": "queued",
- "submitted": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "completionMessage": "string",
- "type": "string",
- "digitalVaccine": {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
}
List all appliance distributions
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "applianceDistributions": [
- {
- "id": 0,
- "applianceId": 0,
- "state": "queued",
- "submitted": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "completionMessage": "string",
- "type": "string",
- "digitalVaccine": {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
}
]
}
Create a distribution to an appliance
Security:
Request Body schema: application/json
Class representing a Appliance DV Distribution
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- Payload
{- "applianceId": 0,
- "type": "string",
- "digitalVaccine": {
- "id": 0
}
}
- 200
{- "id": 0,
- "applianceId": 0,
- "state": "queued",
- "submitted": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "completionMessage": "string",
- "type": "string",
- "digitalVaccine": {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
}
List all profiles
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "profiles": [
- {
- "id": 0,
- "name": "string",
- "modified": "2019-08-24T14:15:22Z"
}
]
}
Describe a profile by ID
Security:
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "id": 0,
- "name": "string",
- "policyOverrides": [
- {
- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
], - "modified": "2019-08-24T14:15:22Z"
}
List or search all policies
Users can use the "query" parameter for keywords search and use the "search" parameter in the basic query language for advanced search where a condition is defined as a "key:value" pair. If both "query" parameter and "search" parameter are used, the policies in the response match both the keywords and advanced search conditions.
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "policies": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "protocol": "string",
- "severity": "LOW",
- "ipsVersion": "string",
- "ngfwVersion": "string",
- "policyDefaults": [
- {
- "recommendedActionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": null,
- "type": null,
- "threshold": null,
- "period": null
}
], - "uuid": "string"
}, - "recommendedActive": true,
- "ipsVersion": "string",
- "ngfwVersion": "string"
}
], - "policyOverrides": [
- {
- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": null,
- "type": null,
- "threshold": null,
- "period": null
}
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
], - "signatureReferences": [
- {
- "type": "string",
- "value": "string"
}
], - "latestThreats": [
- {
- "malwareFamilies": [
- "ZEGOST"
], - "links": [
- {
- "name": "BACKDOOR.WIN32.ZEGOST.ANN",
}
], - "timestamp": 1612915200,
- "reference": "BACKDOOR.WIN32.ZEGOST.ANN"
}
], - "modified": "2019-08-24T14:15:22Z",
- "released": "2019-08-24T14:15:22Z",
- "releasedBuildId": "string",
- "modifiedBuildId": "string",
- "uuid": "string",
- "sourceDigitalVaccineVersion": "string"
}
]
}
Describe a policy by ID
Security:
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "protocol": "string",
- "severity": "LOW",
- "ipsVersion": "string",
- "ngfwVersion": "string",
- "policyDefaults": [
- {
- "recommendedActionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}, - "recommendedActive": true,
- "ipsVersion": "string",
- "ngfwVersion": "string"
}
], - "policyOverrides": [
- {
- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
], - "signatureReferences": [
- {
- "type": "string",
- "value": "string"
}
], - "latestThreats": [
- {
- "malwareFamilies": [
- "ZEGOST"
], - "links": [
- {
- "name": "BACKDOOR.WIN32.ZEGOST.ANN",
}
], - "timestamp": 1612915200,
- "reference": "BACKDOOR.WIN32.ZEGOST.ANN"
}
], - "modified": "2019-08-24T14:15:22Z",
- "released": "2019-08-24T14:15:22Z",
- "releasedBuildId": "string",
- "modifiedBuildId": "string",
- "uuid": "string",
- "sourceDigitalVaccineVersion": "string"
}
List all Digital Vaccines
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "digitalvaccines": [
- {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
]
}
Describe a Digital Vaccine by ID
Security:
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
List all Digital Vaccine inventories
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "digitalvaccineinventories": [
- {
- "active": true,
- "digitalVaccine": {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}, - "type": "digitalvaccine",
- "deviceDigitalVaccineInventories": [
- {
- "deviceId": 0
}
], - "applianceDigitalVaccineInventories": [
- {
- "applianceId": 0
}
], - "updated": "2019-08-24T14:15:22Z"
}
]
}
List all appliance profile inventories
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "applianceprofileinventories": [
- {
- "applianceId": 0,
- "profile": {
- "id": 0,
- "name": "string",
- "policyOverrides": [
- {
- "id": 0,
- "profileId": 0,
- "profileName": "string",
- "actionSet": {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": null,
- "packetTraceLevel": null,
- "packetTraceByteSize": null
}, - "hidden": true,
- "alertSinks": [
- null
], - "uuid": "string"
}, - "signatureUuid": "string",
- "enabled": true
}
], - "modified": "2019-08-24T14:15:22Z"
}, - "updated": "2019-08-24T14:15:22Z"
}
]
}
Describe an appliance distribution by ID
Security:
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "id": 0,
- "applianceId": 0,
- "state": "queued",
- "submitted": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "completionMessage": "string",
- "type": "string",
- "digitalVaccine": {
- "id": 0,
- "type": "digitalvaccine",
- "subType": "string",
- "state": "available",
- "fileSize": 0,
- "version": "string",
- "released": "2019-08-24T14:15:22Z"
}
}
List all action sets
Security:
query Parameters
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
- 200
{- "totalCount": 0,
- "next": "string",
- "actionsets": [
- {
- "name": "string",
- "id": 0,
- "flowControlType": "deny",
- "packetTrace": {
- "packetTracePriority": "HIGH",
- "packetTraceLevel": "FULL",
- "packetTraceByteSize": 0
}, - "hidden": true,
- "alertSinks": [
- {
- "name": "string",
- "type": "managementconsole",
- "threshold": 0,
- "period": 0
}
], - "uuid": "string"
}
]
}