Cotal
DocsAPI Reference

Read feedback intake health

GET
/health

Return readiness of the running feedback HTTP listener. No tester key is required.

Response Body

The listener is running.

application/json
  1. response
ok*unknown
Example Request
curl -X GET 'http://127.0.0.1:8787/health'
Example Response200
{  "ok": true}

See the HTTP interface overview for authentication and access requirements.

Complete HTTP contract

Endpoint

GET /health

Return readiness of the running feedback HTTP listener. No tester key is required.

Parameters

No operation parameters.

Responses

HTTP 200

The listener is running.

Content type: application/json.

{
  "type": "object",
  "properties": {
    "ok": {
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}

Authentication and access: HTTP interface of the reference feedback intake service. The default listener is 127.0.0.1:8787 and the operator can configure host and port. Health is unauthenticated. Feedback requires a provisioned tester key. The service persists an accepted record before publishing it to the feedback channel. A 202 with published false still means the record was stored. This implementation reference does not establish a hosted public feedback product.

The body limit defaults to 65536 bytes and is configurable with --max-bytes. The rate limit defaults to 30 authenticated admissions per tester per fixed minute, configurable with --rate-limit. Failed body validation still consumes an admission. Query strings are accepted because dispatch uses the URL pathname. Unknown paths and methods return JSON 404. The handler does not enforce Content-Type or Origin and sends no CORS promise.

OpenAPI specification contains the referenced response schemas. Complete Markdown reference.