> For the complete documentation index, see [llms.txt](https://islamu.gitbook.io/islamu-event/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://islamu.gitbook.io/islamu-event/api-reference/readme/interactive-endpoints.md).

# Interactive Endpoints

Environment-specific OpenAPI, Swagger, Scalar, health, and metrics guidance.

## OpenAPI, Swagger, and Scalar

Development and Testing environments can expose:

* Swagger UI at `/swagger`;
* Scalar at its mapped development/testing route;
* generated OpenAPI JSON at `/openapi/islamu-event.json`.

The local development API commonly uses `https://localhost:7039`. Docker Compose runs Production at `http://localhost:7039`, where interactive descriptions are not exposed by default.

{% hint style="warning" %}
Do not advertise an unfiltered development document as a public production integrator contract. Production exposure is an explicit operator decision and must pass authentication/authorization, tenant, TLS, rate-limit, metadata, and information-disclosure review.
{% endhint %}

The governed build artifact is `schemas/openapi-islamu-event.json`. Server code is the source; OpenAPI inventory and generated NSwag clients are outputs and must not be hand-edited.

## Operational endpoints

### `/alive`

Use for process liveness. It should answer whether the process can serve, not whether every dependency is ready.

### `/health`

Use for readiness and dependency-specific health. Relevant checks may cover databases, privacy-erasure authority, Keycloak, authorization, SMTP, webhooks, Listmonk, and other enabled providers.

A safe health payload does not reveal credentials, connection strings, filesystem paths, object keys, bucket names, private endpoints, access keys, provider payloads, or PII.

### `/metrics`

Use for monitoring with bounded identity-free dimensions. Never attach tenant/user identifiers, secrets, provider IDs, admission material, or unbounded error text as labels.

## External provider health

Cerbos also exposes `/_cerbos/health` and `/_cerbos/metrics`. Outgoing webhooks expose mode-specific application readiness. Provider health proves reachability/readiness, not that every tenant policy, credential, template, or business workflow is correct.

## Production exposure checklist

* terminate and verify TLS;
* restrict interactive descriptions to intended operators/integrators;
* enforce normal authentication, authorization, tenant, and rate-limit policy;
* redact operational details;
* test from outside the trusted network;
* record exact API version and generated artifact revision;
* monitor access and remove temporary exposure after diagnosis.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://islamu.gitbook.io/islamu-event/api-reference/readme/interactive-endpoints.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.