YARA :: Download · Customer Self-Service

Use this API to download YARA files that have been uploaded to the Apex Central server.

HTTP Request

GET /WebApp/IOCBackend/YARAResource/File HTTP/1.1

Parameters

Important:

The HTTP request body must contain all required parameters.

Name	Type	Description	Value
Required Parameters
FileHashID	String	The file hash ID of the file to download	Example: "5E0129FD99A0A698F8D12A467182DCA263AE4377"

HTTP Request Example

GET /WebApp/IOCBackend/YARAResource/File HTTP/1.1

HTTP Request Body

Specify a JSON object containing the following HTTP header and request body:

HTTP header:

Important:

This API only supports the following Content-Type.
The authorization header is only required for external HTTP requests.

Field Name	Value
Content-Type	application/json;charset=utf-8
Authorization	Bearer {Generated JWT authentication token}

Request body:

?param=
  {
    "FileHashID": 
      "5E0129FD99A0A698F8D12A467182DCA263AE4377"
  }

Response

If successful, this method returns an HTTP status code of "200", result code of "1", and a response body with the following structure:

{
  "Data":  
  {
    "FileName": "taleret.yara",
    "FileContentBase64":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz
      0idXMtYXNjaWkiPz4NCjxpb2MgeG1sbnM6eHNpPSJodHRwOi8vd3d3Lnc
      zLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIgeG1sbnM6eHNkPSJo
      dHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSIgaWQ9ImExM2UyO
      DJkLTY1ZTEtNDI2My05YjMxLTVmOTEyNTE1Mjg4YyIgbGFzdC1tb2RpZm
      llZD0iMjAxMy0xMC0zMFQxOTowNzo0NiIgeG1sbnM9Imh0dHA6Ly9zY2h
      lbWFzLm1hbmRpYW50LmNvbS8yMDEwL2lvYyI+DQogIDxzaG9ydF9kZXNj
      cmlwdGlvbj5DcnlwdG9sb2NrZXIgRGV0ZWN0aW9uIChFWFBFUklNRU5UQ
      UwpPC9zaG9ydF9kZXNjcmlwdGlvbj4NCiAgPGRlc2NyaXB0aW9uPlRoaX
      MgSU9DIGRldGVjdHMgcmVnaXN0cnkgZW50cmllcyBjcmVhdGVkIHdoZW4
      gdGhlIENyeXB0b2xvY2tlciBjcmltZXdhcmUgcnVucy4gUHJlc2VuY2Ug
      b2Ygb25lIG9mIHRoZXNlIHJlZ2lzdHJ5IGtleSBzaG93cyB0aGF0IGEgY
      m94IGhhcyBsaWtlbHkgYmVlbiBpbmZlY3RlZCB3aXRoIHRoZSBDcnlwdG
      9sb2NrZXIgc29mdHdhcmUuPC9kZXNjcmlwdGlvbj4NCiAgPGF1dGhvcmV
      kX2J5Pk1hbmRpYW50PC9hdXRob3JlZF9ieT4NCiAgPGF1dGhvcmVkX2Rh
      dGU+MjAxMy0xMC0yOFQxNDoyNzoxMjwvYXV0aG9yZWRfZGF0ZT4NCiAgP
      GxpbmtzPg0KICAgIDxsaW5rIHJlbD0iZ3JhZGUiPnVudGVzdGVkPC9saW
      5rPg0KICA8L2xpbmtzPg0KICA8ZGVmaW5pdGlvbj4NCiAgICA8SW5kaWN
      hdG9yIG9wZXJhdG9yPSJPUiIgaWQ9IjdlYTYwNWI3LThhYjEtNGUxYy05
      MTI4LTk5OTI2NWNkOWYyMSI+DQogICAgICA8SW5kaWNhdG9ySXRlbSBpZ
      D0iYTcxZWIwZDctYWZlNS00NzA4LThkYmItMzc5YmQ0M2NjOWQ3IiBjb2
      5kaXRpb249ImNvbnRhaW5zIj4NCiAgICAgICAgPENvbnRleHQgZG9jdW1
      lbnQ9IlJlZ2lzdHJ5SXRlbSIgc2VhcmNoPSJSZWdpc3RyeUl0ZW0vUGF0
      aCIgdHlwZT0ibWlyIiAvPg0KICAgICAgICA8Q29udGVudCB0eXBlPSJzd
      HJpbmciPlNvZnR3YXJlXENyeXB0b0xvY2tlclxGaWxlczwvQ29udGVudD
      4NCiAgICAgIDwvSW5kaWNhdG9ySXRlbT4NCiAgICAgIDxJbmRpY2F0b3I
      gb3BlcmF0b3I9IkFORCIgaWQ9ImJmYmVmOGEyLTdmMTktNDAwZC04Yjg5
      LTg3ZjdjNzYwNzhhZSI+DQogICAgICAgIDxJbmRpY2F0b3JJdGVtIGlkP
      SI0MmU5Njk5OC03MTYxLTRmMjItYmI3Ny03MzY2MGUyNjlhNmIiIGNvbm
      RpdGlvbj0iY29udGFpbnMiPg0KICAgICAgICAgIDxDb250ZXh0IGRvY3V
      tZW50PSJSZWdpc3RyeUl0ZW0iIHNlYXJjaD0iUmVnaXN0cnlJdGVtL1Bh
      dGgiIHR5cGU9Im1pciIgLz4NCiAgICAgICAgICA8Q29udGVudCB0eXBlP
      SJzdHJpbmciPkN1cnJlbnRWZXJzaW9uXFJ1bjwvQ29udGVudD4NCiAgIC
      AgICAgPC9JbmRpY2F0b3JJdGVtPg0KICAgICAgICA8SW5kaWNhdG9ySXR
      lbSBpZD0iNWQ1YjgyOTYtMDFjOS00MTQ2LTlhNzQtYWJhNTMxYzU3NDc5
      IiBjb25kaXRpb249ImNvbnRhaW5zIj4NCiAgICAgICAgICA8Q29udGV4d
      CBkb2N1bWVudD0iUmVnaXN0cnlJdGVtIiBzZWFyY2g9IlJlZ2lzdHJ5SX
      RlbS9QYXRoIiB0eXBlPSJtaXIiIC8+DQogICAgICAgICAgPENvbnRlbnQ
      gdHlwZT0ic3RyaW5nIj5DcnlwdG9sb2NrZXI8L0NvbnRlbnQ+DQogICAg
      ICAgIDwvSW5kaWNhdG9ySXRlbT4NCiAgICAgIDwvSW5kaWNhdG9yPg0KI
      CAgIDwvSW5kaWNhdG9yPg0KICA8L2RlZmluaXRpb24+DQo8L2lvYz4="
  },
  "FeatureCtrl":
  {
    "mode": "0"
  },
  "Meta":
  {
    "Result": 1,
    "ErrorCode": 0,
    "ErrorMsg": "Success"
  },
  "PermissionCtrl":
  {
    "permission": "255",
    "elements": "null"
  }
}

Where:

Name	Type	Description
FileName	String	The name of the downloaded file
FileContentBase64	String	The Base64 hash of the file content

If unsuccessful, this method returns an HTTP status code of "400", result code of "0", and one of the following error codes:

HTTP Status Code	Error Code	Description
400	7	Incorrect parameter
400	11	Incorrect input

For more information about API responses and descriptions of response codes, see the following topics: