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

authorization

AuthorizationstringRequired

Communication key

Responses

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

HTTPcURLJavaScriptPython

GET /public-api/constants/metafields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successfully retrieved metafields

[
  {
    "metafieldId": "timeout",
    "value": 60
  }
]

Get all available levels used in Threat.Zone API

get

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

Responses

200

Successfully retrieved levels

application/json

valuenumberRequired

Level number

Example: 0

descriptionstringRequired

Level description

Example: Unknown

get

/public-api/constants/levels

HTTPcURLJavaScriptPython

GET /public-api/constants/levels HTTP/1.1
Accept: */*

200

Successfully retrieved levels

[
  {
    "value": 0,
    "description": "Unknown"
  }
]

Get all available statuses used in Threat.Zone API

get

Retrieve all available statuses for a submission

Responses

200

Successfully retrieved statuses

application/json

valuenumberRequired

Status number

Example: 1

descriptionstringRequired

Status description

Example: File received

get

/public-api/constants/statuses

HTTPcURLJavaScriptPython

GET /public-api/constants/statuses HTTP/1.1
Accept: */*

200

Successfully retrieved statuses

[
  {
    "value": 1,
    "description": "File received"
  }
]

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

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

HTTPcURLJavaScriptPython

GET /public-api/constants/samplemetafield HTTP/1.1
Accept: */*

200

Successfully retrieved sample metafield

[
  {
    "metafieldId": "timeout",
    "value": 60
  }
]