Docs
Elastic Cloud Enterprise Reference [2.4] » RESTful API » API reference » Comments
« Clusters - Search Deployment - CRUD »

Comments

List Comments

Retrieves all the comments for a given Resource, in reverse modified time order.

Request

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

Path parameters

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].

Responses

200

(CommentsWithMetas) The Comments

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

Request example

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

Create a Comment

Creates a comment for the given Resource.

Request

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

Path parameters

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

(CommentCreateRequest) (required) Data for comment creation

Responses

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

curl -XPOST {{hostname}}/api/v1/comments/{resource_type}/{resource_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "message" : "string"
}
'

Delete Comment

Deletes a Comment.

Request

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

Path parameters

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

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

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

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

Get Comment

Retrieves a Comment.

Request

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

Path parameters

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].

Responses

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

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

Request example

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

Update Comment

Updates a Comment.

Request

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

Path parameters

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

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)

Request body

(CommentUpdateRequest) (required) The Comment update data.

Responses

200

(Comment) Comment updated 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

curl -XPUT {{hostname}}/api/v1/comments/{resource_type}/{resource_id}/{comment_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "message" : "string"
}
'
« Clusters - Search Deployment - CRUD »