List Comments

GET /comments/{resource_type}/{resource_id}
Basic auth Api key

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

Path parameters

  • resource_type string Required

    The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, integrations_server, allocator, constructor, runner, proxy].

  • resource_id string Required

    Id of the Resource that a Comment belongs to.

Responses

  • 200 application/json

    The Comments

    Hide response attribute Show response attribute object
    • values array[object] Required

      The list of comments

      A persisted Comment along with its metadata

      Hide values attributes Show values attributes object
      • comment object Required

        A persisted Comment

        Hide comment attributes Show comment attributes object
        • id string Required

          The id of this Comment

        • user_id string Required

          The user id of the user who wrote this Comment

        • message string Required

          The message content of this Comment

      • metadata object Required

        Metadata of an entity

        Hide metadata attributes Show metadata attributes object
        • created_time string(date-time) Required

          Creation time

        • modified_time string(date-time) Required

          Modification time

        • version string Required

          Version
GET /comments/{resource_type}/{resource_id} 
curl \
 --request GET 'https://{{hostname}}/api/v1/comments/{resource_type}/{resource_id}' \
 --user "username:password"