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.

› › › ›

Create a Comment

edit

Create a Comment

edit

Creates a comment for the given Resource.

Request

edit

POST /api/v1/comments/{resource_type}/{resource_id}

Path parameters

edit

Name	Type	Required	Description
`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].

Request body

edit

(CommentCreateRequest) (required) Data for comment creation

Responses

edit

201

(Comment) The Comment that was just created.

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) 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.no_user_id]): The error codes associated with the response

404

(BasicFailedReply) No Resource of the given type and id exist. (code: comments.resource_does_not_exist)

Headers

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

409

(BasicFailedReply) A Comment already exists with the generated id. Please try again. (code: comments.id_already_exists)

Headers

x-cloud-error-codes (string; allowed values: [comments.id_already_exists]): 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 -XPOST {{hostname}}/api/v1/comments/{resource_type}/{resource_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "message" : "string"
}
'

« List Comments Delete Comment »