Version & Health
Two endpoints provide unauthenticated metadata about the service — useful for liveness checks, version monitoring, and deployment dashboards.
GET /api/version
GET
/api/version
Returns the API profile currently served by this deployment.
Authentication
Not required.
Example
GET /api/version HTTP/1.1
Host: api.kiss.example.com
Response
{ "apiVersion": "2026-04" }
| Field | Meaning |
|---|---|
apiVersion | The current API profile in YYYY-MM format. |
When to call this
- On every run of a long-lived integration, to detect when Kiss has rolled out a new profile.
- In a monitoring dashboard, to surface the current profile to operators.
- In a deployment script, to confirm a target environment is on the expected profile.
See Versioning for the meaning of profile values and how upgrades work.
Status codes
| Status | Cause |
|---|---|
| 200 | Success. |
| 500 | Unexpected server error. |
GET /health
GET
/health
A liveness probe. Returns plain text Healthy with HTTP 200 when the
service is up and able to handle requests.
Authentication
Not required.
Example
GET /health HTTP/1.1
Host: api.kiss.example.com
Response
HTTP/1.1 200 OK
Content-Type: text/plain
Healthy
When to call this
- From your monitoring system, to detect that the service is reachable and responding.
- During an incident, to confirm the public surface is still up.
Status codes
| Status | Cause |
|---|---|
| 200 | Service is healthy. |
| 503 | Service is unhealthy or starting up. |
Rate limiting
Both /api/version and /health are subject to rate limiting. When
called without an Authorization header, requests are bucketed under
a shared anonymous identifier — meaning every unauthenticated caller
of the deployment shares the same quota. Authenticated calls are
counted against the calling customer's bucket.
A health check every 30 to 60 seconds is more than enough for almost any monitoring system. If you must call these endpoints frequently from a process that has credentials, prefer authenticated requests so your traffic doesn't compete with other consumers in the anonymous bucket. See Rate limits.