STIX :: Download · Customer Self-Service

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

HTTP Request

GET /WebApp/IOCBackend/STIXResource/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/STIXResource/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": "command-and-control-ip-list.xml",
    "FileContentBase64":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz
       0idXMtYXNjaWkiPz4NCjxpb2MgeG1sbnM6eHNpPSJodHRwOi8vd3d3Ln
       czLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIgeG1sbnM6eHNkPS
       JodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSIgaWQ9ImExM2
       UyODJkLTY1ZTEtNDI2My05YjMxLTVmOTEyNTE1Mjg4YyIgbGFzdC1tb2
       RpZmllZD0iMjAxMy0xMC0zMFQxOTowNzo0NiIgeG1sbnM9Imh0dHA6Ly
       9zY2hlbWFzLm1hbmRpYW50LmNvbS8yMDEwL2lvYyI+DQogIDxzaG9ydF
       9kZXNjcmlwdGlvbj5DcnlwdG9sb2NrZXIgRGV0ZWN0aW9uIChFWFBFUk
       lNRU5UQUwpPC9zaG9ydF9kZXNjcmlwdGlvbj4NCiAgPGRlc2NyaXB0aW
       9uPlRoaXMgSU9DIGRldGVjdHMgcmVnaXN0cnkgZW50cmllcyBjcmVhdG
       VkIHdoZW4gdGhlIENyeXB0b2xvY2tlciBjcmltZXdhcmUgcnVucy4gUH
       Jlc2VuY2Ugb2Ygb25lIG9mIHRoZXNlIHJlZ2lzdHJ5IGtleSBzaG93cy
       B0aGF0IGEgYm94IGhhcyBsaWtlbHkgYmVlbiBpbmZlY3RlZCB3aXRoIH
       RoZSBDcnlwdG9sb2NrZXIgc29mdHdhcmUuPC9kZXNjcmlwdGlvbj4NCi
       AgPGF1dGhvcmVkX2J5Pk1hbmRpYW50PC9hdXRob3JlZF9ieT4NCiAgPG
       F1dGhvcmVkX2RhdGU+MjAxMy0xMC0yOFQxNDoyNzoxMjwvYXV0aG9yZW
       RfZGF0ZT4NCiAgPGxpbmtzPg0KICAgIDxsaW5rIHJlbD0iZ3JhZGUiPn
       VudGVzdGVkPC9saW5rPg0KICA8L2xpbmtzPg0KICA8ZGVmaW5pdGlvbj
       4NCiAgICA8SW5kaWNhdG9yIG9wZXJhdG9yPSJPUiIgaWQ9IjdlYTYwNW
       I3LThhYjEtNGUxYy05MTI4LTk5OTI2NWNkOWYyMSI+DQogICAgICA8SW
       5kaWNhdG9ySXRlbSBpZD0iYTcxZWIwZDctYWZlNS00NzA4LThkYmItMz
       c5YmQ0M2NjOWQ3IiBjb25kaXRpb249ImNvbnRhaW5zIj4NCiAgICAgIC
       AgPENvbnRleHQgZG9jdW1lbnQ9IlJlZ2lzdHJ5SXRlbSIgc2VhcmNoPS
       JSZWdpc3RyeUl0ZW0vUGF0aCIgdHlwZT0ibWlyIiAvPg0KICAgICAgIC
       A8Q29udGVudCB0eXBlPSJzdHJpbmciPlNvZnR3YXJlXENyeXB0b0xvY2
       tlclxGaWxlczwvQ29udGVudD4NCiAgICAgIDwvSW5kaWNhdG9ySXRlbT
       4NCiAgICAgIDxJbmRpY2F0b3Igb3BlcmF0b3I9IkFORCIgaWQ9ImJmYm
       VmOGEyLTdmMTktNDAwZC04Yjg5LTg3ZjdjNzYwNzhhZSI+DQogICAgIC
       AgIDxJbmRpY2F0b3JJdGVtIGlkPSI0MmU5Njk5OC03MTYxLTRmMjItYm
       I3Ny03MzY2MGUyNjlhNmIiIGNvbmRpdGlvbj0iY29udGFpbnMiPg0KIC
       AgICAgICAgIDxDb250ZXh0IGRvY3VtZW50PSJSZWdpc3RyeUl0ZW0iIH
       NlYXJjaD0iUmVnaXN0cnlJdGVtL1BhdGgiIHR5cGU9Im1pciIgLz4NCi
       AgICAgICAgICA8Q29udGVudCB0eXBlPSJzdHJpbmciPkN1cnJlbnRWZX
       JzaW9uXFJ1bjwvQ29udGVudD4NCiAgICAgICAgPC9JbmRpY2F0b3JJdG
       VtPg0KICAgICAgICA8SW5kaWNhdG9ySXRlbSBpZD0iNWQ1YjgyOTYtMD
       FjOS00MTQ2LTlhNzQtYWJhNTMxYzU3NDc5IiBjb25kaXRpb249ImNvbn
       RhaW5zIj4NCiAgICAgICAgICA8Q29udGV4dCBkb2N1bWVudD0iUmVnaX
       N0cnlJdGVtIiBzZWFyY2g9IlJlZ2lzdHJ5SXRlbS9QYXRoIiB0eXBlPS
       JtaXIiIC8+DQogICAgICAgICAgPENvbnRlbnQgdHlwZT0ic3RyaW5nIj
       5DcnlwdG9sb2NrZXI8L0NvbnRlbnQ+DQogICAgICAgIDwvSW5kaWNhdG
       9ySXRlbT4NCiAgICAgIDwvSW5kaWNhdG9yPg0KICAgIDwvSW5kaWNhdG
       9yPg0KICA8L2RlZmluaXRpb24+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: