analytics
StatusCake Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the StatusCake KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.statuscake.*.
Use lua_read_doc("integrations.statuscake") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
StatusCake workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.statuscake.list_contact_groups({}))' --json kosmo integrations:lua --eval 'print(docs.read("statuscake"))' --json
kosmo integrations:lua --eval 'print(docs.read("statuscake.list_contact_groups"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local statuscake = app.integrations.statuscake
local result = statuscake.list_contact_groups({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.statuscake, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.statuscake.default.* or app.integrations.statuscake.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need StatusCake, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
StatusCake Lua Tools
Namespace: statuscake
Generated from the official StatusCake Swagger spec linked from the developer portal. Configure api_key; runtime requests send Authorization: Bearer <api_key>.
Coverage
- Paths: 18
- Tools: 36
- Read tools: 18
- Write tools: 18
Usage Notes
- Path and query parameters use snake_case tool keys and are sent with official API names.
- Create/update request payloads go in
bodyand are sent as form-encoded fields, matching the Swaggerapplication/x-www-form-urlencodeddeclaration. - Empty optional query parameters are omitted.
Example Lua
local uptime = statuscake.statuscake_list_uptime_tests({ page = 1, limit = 25 })
local locations = statuscake.statuscake_list_uptime_monitoring_locations({})Raw agent markdown
# StatusCake Lua Tools
Namespace: `statuscake`
Generated from the official StatusCake Swagger spec linked from the developer portal. Configure `api_key`; runtime requests send `Authorization: Bearer <api_key>`.
## Coverage
- Paths: 18
- Tools: 36
- Read tools: 18
- Write tools: 18
## Usage Notes
- Path and query parameters use snake_case tool keys and are sent with official API names.
- Create/update request payloads go in `body` and are sent as form-encoded fields, matching the Swagger `application/x-www-form-urlencoded` declaration.
- Empty optional query parameters are omitted.
## Example Lua
```lua
local uptime = statuscake.statuscake_list_uptime_tests({ page = 1, limit = 25 })
local locations = statuscake.statuscake_list_uptime_monitoring_locations({})
``` local result = app.integrations.statuscake.list_contact_groups({})
print(result) Functions
list_contact_groups Read
Returns a list of contact groups for an account. Official StatusCake endpoint: GET /contact-groups.
- Lua path
app.integrations.statuscake.list_contact_groups- Full name
statuscake.statuscake_list_contact_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_contact_group Write
Creates a contact group with the given parameters. Official StatusCake endpoint: POST /contact-groups.
- Lua path
app.integrations.statuscake.create_contact_group- Full name
statuscake.statuscake_create_contact_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_contact_group Read
Returns a contact group with the given id. Official StatusCake endpoint: GET /contact-groups/{group_id}.
- Lua path
app.integrations.statuscake.get_contact_group- Full name
statuscake.statuscake_get_contact_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_contact_group Write
Updates a contact group with the given parameters. Official StatusCake endpoint: PUT /contact-groups/{group_id}.
- Lua path
app.integrations.statuscake.update_contact_group- Full name
statuscake.statuscake_update_contact_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_contact_group Write
Deletes a contact group with the given id. Official StatusCake endpoint: DELETE /contact-groups/{group_id}.
- Lua path
app.integrations.statuscake.delete_contact_group- Full name
statuscake.statuscake_delete_contact_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_heartbeat_tests Read
Returns a list of heartbeat checks for an account. Official StatusCake endpoint: GET /heartbeat.
- Lua path
app.integrations.statuscake.list_heartbeat_tests- Full name
statuscake.statuscake_list_heartbeat_tests
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_heartbeat_test Write
Creates a heartbeat check with the given parameters. Official StatusCake endpoint: POST /heartbeat.
- Lua path
app.integrations.statuscake.create_heartbeat_test- Full name
statuscake.statuscake_create_heartbeat_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_heartbeat_test Read
Returns a heartbeat check with the given id. Official StatusCake endpoint: GET /heartbeat/{test_id}.
- Lua path
app.integrations.statuscake.get_heartbeat_test- Full name
statuscake.statuscake_get_heartbeat_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_heartbeat_test Write
Updates a heartbeat check with the given parameters. Official StatusCake endpoint: PUT /heartbeat/{test_id}.
- Lua path
app.integrations.statuscake.update_heartbeat_test- Full name
statuscake.statuscake_update_heartbeat_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_heartbeat_test Write
Deletes a heartbeat check with the given id. Official StatusCake endpoint: DELETE /heartbeat/{test_id}.
- Lua path
app.integrations.statuscake.delete_heartbeat_test- Full name
statuscake.statuscake_delete_heartbeat_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_maintenance_windows Read
Returns a list of maintenance windows for an account. Official StatusCake endpoint: GET /maintenance-windows.
- Lua path
app.integrations.statuscake.list_maintenance_windows- Full name
statuscake.statuscake_list_maintenance_windows
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_maintenance_window Write
Creates a maintenance window with the given parameters. Official StatusCake endpoint: POST /maintenance-windows.
- Lua path
app.integrations.statuscake.create_maintenance_window- Full name
statuscake.statuscake_create_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_maintenance_window Read
Returns a maintenance window with the given id. Official StatusCake endpoint: GET /maintenance-windows/{window_id}.
- Lua path
app.integrations.statuscake.get_maintenance_window- Full name
statuscake.statuscake_get_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_maintenance_window Write
Updates a maintenance window with the given parameters. Official StatusCake endpoint: PUT /maintenance-windows/{window_id}.
- Lua path
app.integrations.statuscake.update_maintenance_window- Full name
statuscake.statuscake_update_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_maintenance_window Write
Deletes a maintenance window with the given id. Official StatusCake endpoint: DELETE /maintenance-windows/{window_id}.
- Lua path
app.integrations.statuscake.delete_maintenance_window- Full name
statuscake.statuscake_delete_maintenance_window
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_pagespeed_tests Read
Returns a list of pagespeed checks for an account. Official StatusCake endpoint: GET /pagespeed.
- Lua path
app.integrations.statuscake.list_pagespeed_tests- Full name
statuscake.statuscake_list_pagespeed_tests
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_pagespeed_test Write
Creates a pagespeed check with the given parameters. Official StatusCake endpoint: POST /pagespeed.
- Lua path
app.integrations.statuscake.create_pagespeed_test- Full name
statuscake.statuscake_create_pagespeed_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_pagespeed_test Read
Returns a pagespeed check with the given id. Official StatusCake endpoint: GET /pagespeed/{test_id}.
- Lua path
app.integrations.statuscake.get_pagespeed_test- Full name
statuscake.statuscake_get_pagespeed_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_pagespeed_test Write
Updates a pagespeed check with the given parameters. Official StatusCake endpoint: PUT /pagespeed/{test_id}.
- Lua path
app.integrations.statuscake.update_pagespeed_test- Full name
statuscake.statuscake_update_pagespeed_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_pagespeed_test Write
Deletes a pagespeed check with the given id. Official StatusCake endpoint: DELETE /pagespeed/{test_id}.
- Lua path
app.integrations.statuscake.delete_pagespeed_test- Full name
statuscake.statuscake_delete_pagespeed_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_pagespeed_test_history Read
Returns a list of pagespeed check history results for a given id, detailing the runs performed on the StatusCake testing infrastruture. The returned results are a paginated series. Alongside the response data is a `links` object referencing the current respons
- Lua path
app.integrations.statuscake.list_pagespeed_test_history- Full name
statuscake.statuscake_list_pagespeed_test_history
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ssl_tests Read
Returns a list of SSL checks for an account. Official StatusCake endpoint: GET /ssl.
- Lua path
app.integrations.statuscake.list_ssl_tests- Full name
statuscake.statuscake_list_ssl_tests
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_ssl_test Write
Creates an SSL check with the given parameters. Official StatusCake endpoint: POST /ssl.
- Lua path
app.integrations.statuscake.create_ssl_test- Full name
statuscake.statuscake_create_ssl_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ssl_test Read
Returns an SSL check with the given id. Official StatusCake endpoint: GET /ssl/{test_id}.
- Lua path
app.integrations.statuscake.get_ssl_test- Full name
statuscake.statuscake_get_ssl_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_ssl_test Write
Updates an SSL check with the given parameters. Official StatusCake endpoint: PUT /ssl/{test_id}.
- Lua path
app.integrations.statuscake.update_ssl_test- Full name
statuscake.statuscake_update_ssl_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_ssl_test Write
Deletes an SSL check with the given id. Official StatusCake endpoint: DELETE /ssl/{test_id}.
- Lua path
app.integrations.statuscake.delete_ssl_test- Full name
statuscake.statuscake_delete_ssl_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_uptime_tests Read
Returns a list of uptime checks for an account. Official StatusCake endpoint: GET /uptime.
- Lua path
app.integrations.statuscake.list_uptime_tests- Full name
statuscake.statuscake_list_uptime_tests
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_uptime_test Write
Creates an uptime check with the given parameters. Official StatusCake endpoint: POST /uptime.
- Lua path
app.integrations.statuscake.create_uptime_test- Full name
statuscake.statuscake_create_uptime_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_uptime_test Read
Returns an uptime check with the given id. Official StatusCake endpoint: GET /uptime/{test_id}.
- Lua path
app.integrations.statuscake.get_uptime_test- Full name
statuscake.statuscake_get_uptime_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_uptime_test Write
Updates an uptime check with the given parameters. Official StatusCake endpoint: PUT /uptime/{test_id}.
- Lua path
app.integrations.statuscake.update_uptime_test- Full name
statuscake.statuscake_update_uptime_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_uptime_test Write
Deletes an uptime check with the given id. Official StatusCake endpoint: DELETE /uptime/{test_id}.
- Lua path
app.integrations.statuscake.delete_uptime_test- Full name
statuscake.statuscake_delete_uptime_test
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_uptime_test_history Read
Returns a list of uptime check history results for a given id, detailing the runs performed on the StatusCake testing infrastruture. The returned results are a paginated series. Alongside the response data is a `links` object referencing the current response d
- Lua path
app.integrations.statuscake.list_uptime_test_history- Full name
statuscake.statuscake_list_uptime_test_history
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_uptime_test_periods Read
Returns a list of uptime check periods for a given id, detailing the creation time of the period, when it ended and the duration. The returned results are a paginated series. Alongside the response data is a `links` object referencing the current response docu
- Lua path
app.integrations.statuscake.list_uptime_test_periods- Full name
statuscake.statuscake_list_uptime_test_periods
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_uptime_test_alerts Read
Returns a list of uptime check alerts for a given id. The returned results are a paginated series. Alongside the response data is a `links` object referencing the current response document, `self`, and the next page in the series, `next`. Official StatusCake
- Lua path
app.integrations.statuscake.list_uptime_test_alerts- Full name
statuscake.statuscake_list_uptime_test_alerts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_uptime_monitoring_locations Read
Returns a list of locations detailing server information for uptime monitoring servers. This information can be used to create further checks using the API. Official StatusCake endpoint: GET /uptime-locations.
- Lua path
app.integrations.statuscake.list_uptime_monitoring_locations- Full name
statuscake.statuscake_list_uptime_monitoring_locations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_pagespeed_monitoring_locations Read
Returns a list of locations detailing server information for pagespeed monitoring servers. This information can be used to create further checks using the API. Official StatusCake endpoint: GET /pagespeed-locations.
- Lua path
app.integrations.statuscake.list_pagespeed_monitoring_locations- Full name
statuscake.statuscake_list_pagespeed_monitoring_locations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||