IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Get Comment

edit

Get Comment

edit

Retrieves a Comment.

Request

edit

GET /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, enterprise_search, allocator, constructor, runner, proxy].

Responses

edit

200

(Comment)

The Comment

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

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

Request example

edit

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

« Delete Comment Update Comment »