DELETE tags/{tag}

Deletes a specified tag.

Path

/api/1.1/tags/{tag}

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.

Request parameters

This request has the following parameters:

Request parameters

Name

Parameter type

Description

tag

Path

Name of the tag.

Request body

This request has an empty body.

Request example

The following is an example of a DELETE tags/{tag} request.

DELETE https://192.0.2.57/api/1.1/tags/WIN-TROJAN

Accept: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

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": "Tag successfully deleted"

}

]

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 tags/{tag} request response.

НТТР/1.1 200 ОК

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 150

[

{

"status": "Tag successfully deleted"

}

]

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 removing tag",

"reason": "%REASON%"

}

]

Error object properties are described in the following table.

Error object properties

Property

Value

Description

status

string

Error description.

reason

string

The reason of the error.

This property may be missing.

Error response example

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

НТТР/1.1 404 Tag doesn't exist

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 150

[

{

"status": "An error occurred while removing tag",

"reason": "Tag doesn't exists"

}

]

Page top