It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › › ›

Delete Comment

edit

Delete Comment

edit

Deletes a Comment.

Request

edit

DELETE /api/v1/comments/{resource_type}/{resource_id}/{comment_id}

Path parameters

edit

Name	Type	Required	Description
`comment_id`	`string`	Y	Id of a Comment
`resource_id`	`string`	Y	Id of the Resource that a Comment belongs to.
`resource_type`	`string`	Y	The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprisesearch, sitesearch, allocator, constructor, runner, proxy].

Query parameters

edit

Name	Type	Required	Description
`version`	`integer`	N	If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Responses

edit

200

(EmptyResponse) Comment deleted successfully.

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

401

(BasicFailedReply) * The Comment does not belong to you. (code: comments.unauthorised) * Your current session does not have a user id associated with it. (code: comments.no_user_id)

Headers

x-cloud-error-codes (string; allowed values: [comments.unauthorised, comments.no_user_id]): The error codes associated with the response

404

(BasicFailedReply) The Comment you want does not exist. (code: comments.comment_does_not_exist)

Headers

x-cloud-error-codes (string; allowed values: [comments.comment_does_not_exist]): The error codes associated with the response

409

(BasicFailedReply) The version you sent does not match the persisted version. (code: comments.version_conflict)

Headers

x-cloud-error-codes (string; allowed values: [comments.version_conflict]): The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XDELETE https://{{hostname}}/api/v1/comments/{resource_type}/{resource_id}/{comment_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Create a Comment Get Comment »