Create a Comment

POST /comments/{resource_type}/{resource_id}

Auth

Creates a comment for the given Resource.

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.

Request body

Data for comment creation

message string required: The message for the Comment.

Responses

The Comment that was just created.

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)

Your current session does not have a user id associated with it. (code: comments.no_user_id)

application/json

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

application/json

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

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/comments/${RESOURCE_TYPE}/${RESOURCE_ID}" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "string"
  }'

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

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

Generated from the API spec

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

Generated from the API spec