Help Center/ SecMaster/ API Reference/ API/ Indicator Management/ This API is used to delete an indicator
Updated on 2024-12-25 GMT+08:00
View PDF

This API is used to delete an indicator

Function

This API is used to delete an indicator.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/indicators

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Token of the tenant.

content-type

Yes

String

application/json;charset=UTF-8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

batch_ids

No

Array of strings

List of indicator IDs.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code

message

String

Error Message

data

IndicatorBatchOperateResponse object

Intelligence response parameters
Table 6 IndicatorBatchOperateResponse

Parameter

Type

Description

success_ids

Array of strings

Succeeded IDs.

error_ids

Array of strings

Failed IDs.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.
Table 8 Response body parameters

Parameter

Type

Description

code

String

Error Code

message

String

Error Description

Example Requests

Delete an indicator. Its batch ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f.

{
  "batch_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
}

Example Responses

Status code: 200

Response succeeded.

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "data" : {
    "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
    "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
  }
}

Status Codes

Status Code

Description

200

Response succeeded.

400

Response upon a request failure

Error Codes

See Error Codes.

Parent topic: Indicator Management