Use this API to delete STIX files from the Apex Central server.
HTTP Request
DELETE /WebApp/IOCBackend/STIXResource/File HTTP/1.1
Parameters
The HTTP request body must contain all required parameters.
Name |
Type |
Description |
---|---|---|
Required Parameters |
||
FileHashIDList |
String |
Indicates the file hash IDs of the files to delete |
HTTP Request Example
DELETE /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= { "FileHashIDList": ["2A15F09D5C2779DEE7D42BE0F7959688E5329A16", "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": [ { "FileHashID": "2A15F09D5C2779DEE7D42BE0F7959688E5329A16", "DeletedStatus": 1 }, } "FileHashID": "5E0129FD99A0A698F8D12A467182DCA263AE4377", "DeletedStatus": -1 } ], "FeatureCtrl": { "mode": "0" }, "Meta": { "Result": 1, "ErrorCode": 0, "ErrorMsg": "Success" }, "PermissionCtrl": { "permission": "255", "elements": "null" } }
Where:
Name |
Type |
Description |
Value |
---|---|---|---|
FileHashID |
String |
Indicates the file hash ID of the deleted file |
Example: "2A15F09D5C2779DEE7D42BE0F7959688E5329A16" |
DeletedStatus |
Integer |
Indicates the deletion status of the specified 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 |
11 |
Incorrect input |
For more information about API responses and descriptions of response codes, see the following topics: