Constants

Get metafields that can be used in the Threat.Zone API

get

Retrieve metafields to use in the Threat.Zone's /scan/sandbox endpoint

Authorizations
AuthorizationstringRequired

Communication key

Responses
chevron-right
200

Successfully retrieved metafields

application/json
metafieldIdstringRequired

Metafield key

Example: timeout
valueone ofRequired

Metafield value

Example: 60
stringOptional
or
booleanOptional
or
numberOptional
get
/public-api/constants/metafields
200

Successfully retrieved metafields

Get all available levels used in Threat.Zone API

get

Retrieve all available levels for a Threat.Zone submission that can be used

Responses
chevron-right
200

Successfully retrieved levels

application/json
valuenumberRequired

Level number

Example: 0
descriptionstringRequired

Level description

Example: Unknown
get
/public-api/constants/levels
200

Successfully retrieved levels

Get all available statuses used in Threat.Zone API

get

Retrieve all available statuses for a submission

Responses
chevron-right
200

Successfully retrieved statuses

application/json
valuenumberRequired

Status number

Example: 1
descriptionstringRequired

Status description

Example: File received
get
/public-api/constants/statuses
200

Successfully retrieved statuses

Get sample metafield to use while sending requests to the /scan/sandbox endpoint

get

Retrieve a sample metafield to use while sending requests to the /scan/sandbox endpoint

Responses
chevron-right
200

Successfully retrieved sample metafield

application/json
metafieldIdstringRequired

Metafield key

Example: timeout
valueone ofRequired

Metafield value

Example: 60
stringOptional
or
booleanOptional
or
numberOptional
get
/public-api/constants/samplemetafield
200

Successfully retrieved sample metafield

Last updated