canonical: https://jentic.com/apis/controller.kloudfox.com/kloudfox # Controller Kloudfox KloudFox Controller API Jentic publishes the only available OpenAPI specification for KloudFox Controller API, keeping it validated and agent-ready. The KloudFox Controller API offers 84 endpoints for uptime monitoring, incident response, scheduled maintenance, public status pages, and user account management. It covers monitor lifecycle (HTTP, SSL, response-time graphs), incident creation and resolution, maintenance windows, hosted status page customisation, third-party notification integrations, and team subuser administration. Authentication is JWT bearer tokens issued via `/api/token`, with refresh support for long-running agents. ## For AI agents Create and configure uptime monitors, manage incidents and maintenance windows, and publish status pages on KloudFox. Agents authenticate with JWT bearer tokens and can run end-to-end monitoring workflows. ## Scope Does not handle log aggregation, application performance tracing, or on-call paging escalations - use for uptime monitoring, incidents, and status pages only. ## Capabilities - Create HTTP and SSL monitors and pause or resume them with `/monitor/update_status` - Open, update, and close incidents tied to specific monitors via the /incident endpoints - Schedule maintenance windows so monitor checks pause cleanly during deploys - Publish branded status pages and attach monitor groups to display uptime history - Wire alerts to Slack, email, webhooks, and other channels via /integration endpoints - Invite and manage subusers with role-based access for shared monitoring teams - Pull response-time stats and SSL certificate metadata for monitored endpoints ## Use cases ### Production API Uptime Monitoring Continuously monitor production HTTP endpoints from KloudFox, capturing response time, SSL certificate health, and downtime events. The `/monitor/create` and `/monitor/configure` endpoints let teams onboard a new service in minutes, while `/monitor/graph/stats` surfaces latency trends. Suited to engineering teams running between five and several hundred public-facing services who need a single dashboard for availability data. Example prompt: Create a monitor for https://api.example.com with a 60-second check interval and verify it returns HTTP 200 ### Incident Response Automation Trigger incident records when monitors fail, attach affected services, and post updates as remediation progresses. The /incident endpoints let agents open, update, and resolve incidents while /integration routes notifications to Slack or webhooks. This shortens MTTR by eliminating manual incident bookkeeping during outages and keeps the public status page in sync with reality. Example prompt: When monitor 1234 reports down, create an incident titled 'API outage' with severity high and post a Slack notification ### Public Status Page Publishing Run a branded status page showing uptime history, active incidents, and scheduled maintenance windows for customers. The /statuspage and /maintenance endpoints handle page configuration and event scheduling, while monitor groups bundle related services. Useful for SaaS companies that want a customer-facing transparency layer without building one from scratch. Example prompt: Create a status page named 'API Status' bound to monitor group 7, then schedule a maintenance window from 02:00 to 03:00 UTC ### Agent-Managed Site Reliability via Jentic Let an AI agent run KloudFox end-to-end through Jentic: discover the right operation by intent, load the schema, and execute calls without hard-coding endpoint paths. Agents can ingest an alert payload, decide whether to open an incident, schedule mitigation maintenance, and post status page updates. Through Jentic the JWT is held in the vault, so the agent never sees the raw token. Example prompt: Search Jentic for 'create an uptime monitor', load the KloudFox schema, then create a monitor for https://shop.example.com and confirm it is active ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/token` | Obtain a JWT bearer token | | POST | `/monitor/create` | Create a new uptime monitor | | GET | `/monitor/list` | List monitors on the account | | GET | `/monitor/graph/stats` | Get response-time stats for a monitor | | GET | `/monitor/get_ssl_info` | Get SSL certificate info for a monitor | | GET | `/monitor/update_status` | Pause or resume monitoring | ## Key resources - **Auth** — Obtain and refresh JWT bearer tokens used for all subsequent calls - **Monitor** — Create, configure, list, pause, and delete uptime monitors - **Incident** — Open, update, and resolve incidents linked to monitors - **Maintenance** — Schedule and manage maintenance windows that suppress alerts - **StatusPage** — Configure and publish customer-facing status pages - **Integration** — Connect notification channels such as Slack, email, and webhooks - **User** — Register, authenticate, and manage user profiles and subusers ## Why Jentic - **Setup:** Wiring the KloudFox Controller API by hand means obtaining a JWT bearer token from its token endpoint, refreshing it, and mapping the monitor, incident, and status-page calls yourself. Through Jentic you install once, import the KloudFox Controller API from the API Directory, store the credentials once, and your agent calls it. - **Permission scoping:** The KloudFox Controller API identifies its monitors in the request body rather than the URL path, so you limit the agent to the operations it needs, such as listing monitors or reading uptime stats, and it can call nothing outside that set. Operations you leave out, such as creating a monitor or updating its status, stay unavailable to the agent. - **Credential handling:** Your KloudFox JWT bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list uptime monitors' or 'check a monitor's SSL info', and Jentic returns the matching KloudFox operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **UptimeRobot API** — Uptime monitoring with incident records and public status pages, similar scope to KloudFox. - **Statuspage API** — Dedicated status page hosting that pairs with external monitors for incident publishing. - **PagerDuty API** — On-call scheduling and escalation that consumes incident events from monitors like KloudFox. ## FAQ ### Why is there no official OpenAPI spec for KloudFox Controller API? KloudFox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call KloudFox Controller API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the KloudFox Controller API use? The API uses JWT bearer tokens. Call POST `/api/token` with credentials to obtain a token, then send it as Authorization: Bearer on every other call. POST `/api/token/refresh` extends a token's lifetime. Through Jentic the JWT is stored encrypted in the vault and never enters the agent's prompt context. ### Can I create uptime monitors programmatically with the KloudFox Controller API? Yes. POST `/monitor/create` accepts the URL, check interval, and monitor type, while POST `/monitor/configure` sets thresholds and assertions. `/monitor/list` returns existing monitors and `/monitor/update_status` pauses or resumes a check without deleting it. ### What are the rate limits for the KloudFox Controller API? Rate limits are not declared in the OpenAPI spec. Treat the API as soft-limited per JWT and back off on HTTP 429 responses. Contact support@kloudfox.com for documented limits applicable to your plan. ### How do I publish a status page through Jentic? Run jentic search for 'publish a status page', load the returned KloudFox operation under /statuspage, then execute it with your monitor group ID and branding. The execute step issues the JWT-authenticated POST automatically. ### Can the KloudFox Controller API schedule maintenance windows that suppress incident alerts? Yes. The /maintenance endpoints create scheduled windows tied to specific monitors or monitor groups. During the window, KloudFox stops generating incidents for the affected monitors so deploys do not flood the on-call channel. ### Is the KloudFox Controller API free? KloudFox offers paid plans managed under the /plans endpoints. The OpenAPI spec does not enumerate pricing tiers - see https://kloudfox.com or contact support@kloudfox.com for current plan limits and pricing. ### Can I limit what my agent is allowed to do with the KloudFox Controller API? Yes. Because you run Jentic One yourself, your own rules decide which KloudFox operations the agent may call, so you can grant it read-only access such as listing monitors with `/monitor/list` or reading uptime stats from `/monitor/graph/stats.` Operations you leave out, such as `/monitor/create` or `/monitor/update_status`, stay unavailable to the agent, and the same applies to incident and status-page calls. Since KloudFox identifies each monitor in the request body rather than the URL path, you scope the agent to the exact operation set it needs and nothing else.