DELETE suppliers/{supplier}/indicators

Deletes the specified indicators from a supplier.

Only indicators from suppliers created with the REST API can be deleted with this request.

Path

/api/%API_VERSION%/suppliers/{supplier}/indicators

Method

DELETE

Request headers

This request has the following headers.

Request headers

Name	Value	Description
Authorization	string (base 64)	Authentication string.
Accept	application/json	Response content type.
Content-Type	application/json	Request content type. You can also specify the utf-8 charset type. Example: Content-Type: application/json; charset=utf-8
Content-Length	integer	Request body size, in bytes. The maximum body size for this request is 64 MB (67108864).

Request parameters

This request has the following parameters:

Request parameters

Name	Parameter type	Description
supplier	Path	Name of the supplier.

Request body

This request body contains a JSON array of indicator objects.

[

{

"indicator":"%INDICATOR_VALUE_1%",

},

...

{

"indicator":"%INDICATOR_VALUE_N%",

}

]

Indicator object properties are described in the following table.

Indicator object properties

Property	Value	Mandatory	Description
indicator	string	Yes	An indicator that must be deleted. You can specify the following indicator types: MD5 hash SHA1 hash SHA256 hash IP address URL

Request example

The following is an example of a DELETE suppliers/{supplier}/indicators request.

DELETE https://192.0.2.57/api/1.1/suppliers/ExampleSupplier/indicators Accept: application/json Content-Type: application/json Authorization: Basic dXNlcjpwYXNzd29yZA== Content-Length: 77   [ {"indicator":"tux.example.com"}, {"indicator":"malicious.example.com"} ]

Response headers

The response has the following headers.

Response headers

Name	Value	Description
Content-Type	application/json	Response content type.
Content-Length	integer	Response body size, in bytes.

Response body

The response body contains a JSON object with a status of the operation.

[

{

"status": "All indicators were successfully deleted from the database"

}

]

Status object properties are described in the following table.

Status object properties

Property	Value	Description
status	string	Status of the operation.

Response example

The following is an example of a DELETE suppliers/{supplier}/indicators request response.

НТТР/1.1 201 ОК Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 74 [{"status": "All indicators were successfully deleted from the database"}]

Partial success response

This response is generated when not all indicators were successfully deleted.

The response body contains the partial success object with the status of the operation and an array of indicator error objects:

[

{

"status": "An error occurred while deleting some of the indicators from the database",

"error_indicators":[

{

"indicator": "%INDICATOR_VALUE_1%",

"reason": "%REASON%"

},

...

{

"indicator": "%INDICATOR_VALUE_N%",

"reason": "%REASON%"

}

]

}

]

Partial success object properties are described in the following table.

Partial success object properties

Property	Value	Description
status	string	Status of the operation.
error_indicators	Indicator error objects	Array of information about indicators that were not deleted.

Indicator error object properties are described in the following table.

Indicator error object properties

Property	Value	Description
indicator	string	Indicator that was not deleted.
reason	string	Cause of the error. This property may not be present in the response.

Partial success response example

The following is an example of a partial success response for the DELETE suppliers/{supplier}/indicators request.

НТТР/1.1 202 Partial success Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 251 [{"status": "An error occurred while deleting some of the indicators from the database","error_indicators":[{"indicator":"bad.example.com", "reason": "Indicator doesn't exist"},{"indicator":"bad2\.example.com", "reason": "Invalid indicator format"}]}]

Error responses

For more information about possible response statuses, see section "Response statuses".

An error response contains a JSON object with the error description.

[

{

"status": "An error occurred while deleting indicators from the database",

}

]

Error object properties are described in the following table.

Error object properties

Property	Value	Description
status	string	Error description.

Error response example

The following is an example of a PUT suppliers/{supplier} error response.

ННТТР/1.1 500 Internal Server Error Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 77   [{"status": "An error occurred while deleting indicators from the database"}]

Page top