Policy

Update a list of policy override of a profile by IDs

put/profiles/{id}/policyoverrides
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
actionSetId
required
integer <int64>

ID of the action set to apply on the overrides

signatureUuids
required
Array of strings

ID of filters

toEnable
required
boolean

Flag to enable/disable the override

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "signatureUuids": [
    ],
  • "actionSetId": 1,
  • "toEnable": true
}
Response samples
application/json
{
  • "signatureUuids": [
    ],
  • "profileId": 1,
  • "actionSetId": 1,
  • "toEnable": true,
  • "failures": [
    ]
}

Create a policy override

post/profiles/{id}/policyoverrides
Request
path Parameters
id
required
integer <int64>

Profile Id

header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
required
object (ActionSetInfo)

Class representing an Action Set

enabled
required
boolean
signatureUuid
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "actionSet": {
    },
  • "signatureUuid": "string",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "profileId": 0,
  • "profileName": "string",
  • "actionSet": {
    },
  • "signatureUuid": "string",
  • "enabled": true
}

Delete a list of policy overrides by signature Uuids

delete/profiles/{id}/policyoverrides
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
signatureUuids
required
Array of strings

ID of filters

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "signatureUuids": [
    ]
}

Update a policy override by ID

post/policyoverrides/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
required
object (ActionSetInfo)

Class representing an Action Set

enabled
required
boolean
signatureUuid
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "actionSet": {
    },
  • "signatureUuid": "string",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "profileId": 0,
  • "profileName": "string",
  • "actionSet": {
    },
  • "signatureUuid": "string",
  • "enabled": true
}

Delete a policy override by ID

delete/policyoverrides/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

List all Digital Vaccine settings

get/digitalvaccinesettings
Request
query Parameters
cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "digitalvaccinesettings": [
    ]
}

Create a new Digital Vaccine setting

post/digitalvaccinesettings
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
enabled
required
boolean
name
required
string
Enum: "autodigitalvaccinedownload" "autodigitalvaccinedistribute" "autodigitalvaccineactivate" "autoauxiliarydigitalvaccinedownload" "autoauxiliarydigitalvaccinedistribute" "autoauxiliarydigitalvaccineactivate"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "name": "autodigitalvaccinedownload",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "name": "autodigitalvaccinedownload",
  • "enabled": true
}

Update a Digital Vaccine setting by ID

post/digitalvaccinesettings/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
enabled
required
boolean
name
required
string
Enum: "autodigitalvaccinedownload" "autodigitalvaccinedistribute" "autodigitalvaccineactivate" "autoauxiliarydigitalvaccinedownload" "autoauxiliarydigitalvaccinedistribute" "autoauxiliarydigitalvaccineactivate"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "name": "autodigitalvaccinedownload",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "name": "autodigitalvaccinedownload",
  • "enabled": true
}

Push a Digital Vaccine/Auxiliary Digital Vaccine to an applianceDeprecated

post/digitalvaccines/{dvId}/appliances/{applianceId}/distribute
Request
path Parameters
applianceId
required
integer <int64>
dvId
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "id": 0,
  • "applianceId": 0,
  • "state": "queued",
  • "submitted": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "completionMessage": "string",
  • "type": "string",
  • "digitalVaccine": {
    }
}

List all appliance distributions

get/appliancedistributions
Request
query Parameters
applianceId
integer <int64>

Short id of the appliance

cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

type
string

Distribution type

Enum: "profile" "digitalvaccine" "auxiliarydigitalvaccine"
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "applianceDistributions": [
    ]
}

Create a distribution to an appliance

post/appliancedistributions
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
One of:

Class representing a Appliance DV Distribution

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "applianceId": 0,
  • "type": "string",
  • "digitalVaccine": {
    }
}
Response samples
application/json
{
  • "id": 0,
  • "applianceId": 0,
  • "state": "queued",
  • "submitted": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "completionMessage": "string",
  • "type": "string",
  • "digitalVaccine": {
    }
}

List all profiles

get/profiles
Request
query Parameters
cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "profiles": [
    ]
}

Describe a profile by ID

get/profiles/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "id": 0,
  • "name": "string",
  • "policyOverrides": [
    ],
  • "modified": "2019-08-24T14:15:22Z"
}

List or search all policies

get/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.

Request
query Parameters
cursor
string
Default: ""

"next" value from previous request

expand
string
Default: "all"

Expand all detailed information, such as policy overrides and latest threats, in the response

ignoreVersion
boolean
Default: true

Ignore the differences of the appliance versions in the response

limit
integer <int32> <= 1000
Default: 10

How many results to return per page

query
string
Default: ""

The query string for keywords search in the policy metadata. Multiple terms and phrases are supported

Example: query=wanacry or "ransomware binary"
search
string
Default: ""

The query language string for advanced search. Available key:value pairs are customized:true/false, filterState:enabled/disabled, flowControl:block/permit/trust, logEvent:enabled/disabled, latestThreat:true/false. In addition, the date released and the date modified can be searched by the date range with the epoch timestamps in milliseconds, and the following keys can be specified with keywords or phrases to search by specific fields: name, protocol, description, severity. To build a compound query, "and" can be used to combine multiple conditions. Any unknown condition is considered to be a part of keywords with "query" parameter.

Example: search=customized:true and filterState:enabled and severity:critical and released:[1414454400000 TO 1425081600000] and sunburst
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "policies": [
    ]
}

Describe a policy by ID

get/policies/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "severity": "LOW",
  • "ipsVersion": "string",
  • "ngfwVersion": "string",
  • "policyDefaults": [
    ],
  • "policyOverrides": [
    ],
  • "signatureReferences": [
    ],
  • "latestThreats": [],
  • "modified": "2019-08-24T14:15:22Z",
  • "released": "2019-08-24T14:15:22Z",
  • "releasedBuildId": "string",
  • "modifiedBuildId": "string",
  • "uuid": "string",
  • "sourceDigitalVaccineVersion": "string"
}

List all Digital Vaccines

get/digitalvaccines
Request
query Parameters
cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "digitalvaccines": [
    ]
}

Describe a Digital Vaccine by ID

get/digitalvaccines/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "id": 0,
  • "type": "digitalvaccine",
  • "subType": "string",
  • "state": "available",
  • "fileSize": 0,
  • "version": "string",
  • "released": "2019-08-24T14:15:22Z"
}

List all Digital Vaccine inventories

get/digitalvaccineinventories
Request
query Parameters
applianceId
integer <int64>
cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "digitalvaccineinventories": [
    ]
}

List all appliance profile inventories

get/applianceprofileinventories
Request
query Parameters
applianceId
integer <int64>
cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many results to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "applianceprofileinventories": [
    ]
}

Describe an appliance distribution by ID

get/appliancedistributions/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "id": 0,
  • "applianceId": 0,
  • "state": "queued",
  • "submitted": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "completionMessage": "string",
  • "type": "string",
  • "digitalVaccine": {
    }
}

Delete an appliance distribution by ID

delete/appliancedistributions/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

List all action sets

get/actionsets
Request
query Parameters
allowedOnly
boolean
Default: true

Only list allowed action sets

cursor
string
Default: ""

"next" value from previous request

limit
integer <int32>
Default: 10

How many items to return per page

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "actionsets": [
    ]
}

Delete a list of policy overrides by IDsDeprecated

delete/policyoverrides
Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
policyOverrideIds
required
Array of integers <int64>

ID of policy overrides

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "policyOverrideIds": [
    ]
}