Get Comment

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

Auth

Retrieves a Comment.

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.
comment_id string required: Id of a Comment

Responses

The Comment

application/json

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

Response headers

x-cloud-resource-version string: The resource version, which is used to avoid update conflicts with concurrent operations
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)

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

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/comments/${RESOURCE_TYPE}/${RESOURCE_ID}/${COMMENT_ID}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "id": "string",
  "user_id": "string",
  "message": "string"
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec