STIX :: GetInfo · Customer Self-Service

Use this API to query the extraction status of STIX files that have been uploaded to the Apex Central server.

HTTP Request

GET /WebApp/IOCBackend/STIXResource/ExtractingInfo HTTP/1.1

Parameters

Important:

The HTTP request body must contain all required parameters.

Name	Type	Description
Required Parameters
FileHashIDList	String	Indicates the file hash IDs of the uploaded files to query

HTTP Request Example

GET /WebApp/IOCBackend/STIXResource/ExtractingInfo HTTP/1.1

HTTP Request Body

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

HTTP header:

Note:

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=
  {
    "FileHashIDList": 
      ["2A15F09D5C2779DEE7D42BE0F7959688E5329A16",
       "5E0129FD99A0A698F8D12A467182DCA263AE4377"]
  }

Response

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

{
  "Data":
  [
    {
      "FileHashID": "2A15F09D5C2779DEE7D42BE0F7959688E5329A16",
      "UDSOIDs": ["0x36e77307362d14b49b9d61f24b221082",
                  "0x7414d0e3d68c409a62f72472b3b7bec2"]
    },
    {
      "FileHashID": "5E0129FD99A0A698F8D12A467182DCA263AE4377",
      "UDSOIDs": []
    }
  ],
  "FeatureCtrl":
  {
    "mode": "0"
  },
  "Meta":
  {
    "Result": 1,
    "ErrorCode": 0,
    "ErrorMsg": "Success"
  },
  "PermissionCtrl":
  {
    "permission": "255",
    "elements": "null"
  }
}

Where:

Name	Type	Description
FileHashID	String	The file hash ID of the uploaded file
UDSOIDs	String	The SLF_Key of the user-defined suspicious objects extracted from the uploaded file

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: