KosmoKrator

data

Render Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Render KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.render.*. Use lua_read_doc("integrations.render") 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 Render workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.render.list_blueprints({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("render"))' --json
kosmo integrations:lua --eval 'print(docs.read("render.list_blueprints"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local render = app.integrations.render
local result = render.list_blueprints({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.render, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.render.default.* or app.integrations.render.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Render, use the narrower mcp:lua command.

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.

Render Lua Reference

Namespace: render

This integration covers Render’s official public OpenAPI registry from https://api-docs.render.com/openapi/render-public-api-1.json. Tools map directly to documented operations for services, deploys, jobs, cron runs, disks, databases, key value stores, projects, environments, env groups, owners, registry credentials, logs, metrics, webhooks, workflows, tasks, maintenance, and Blueprints.

All tools return Render’s JSON response directly. Endpoints that stream or return non-JSON content return { body, content_type }.

Common Patterns

List services:

local services = app.integrations.render.list_services({
  limit = 20
})

Create a deploy:

local deploy = app.integrations.render.create_deploy({
  service_id = "srv-example",
  body = {
    clearCache = "do_not_clear"
  }
})

Cancel a deploy:

app.integrations.render.cancel_deploy({
  service_id = "srv-example",
  deploy_id = "dep-example"
})

Read service environment variables:

local env = app.integrations.render.get_env_vars_for_service({
  service_id = "srv-example",
  limit = 50
})

Create a Postgres export:

local export = app.integrations.render.create_postgres_export({
  postgres_id = "dpg-example",
  body = {
    format = "custom"
  }
})

Query CPU metrics:

local cpu = app.integrations.render.get_cpu({
  resource = "srv-example",
  startTime = "2026-01-01T00:00:00Z",
  endTime = "2026-01-01T01:00:00Z"
})

Tool Families

  • Account and owners: get_current_user, list_owners, retrieve_owner, retrieve_owner_members, owner audit logs, workspace member updates
  • Services: list_services, create_service, get_service, update_service, delete_service, suspend_service, resume_service, restart_service, scale_service, autoscaling, previews, routes, headers, custom domains, env vars, and secret files
  • Deploys and jobs: list_deploys, create_deploy, get_deploy, cancel_deploy, rollback_deploy, list_jobs, post_job, retrieve_job, cancel_job, cron job run tools
  • Datastores: disks and snapshots, Postgres, Redis, key value stores, connection info, database users, exports, recovery, failover, suspend, resume, and restart operations
  • Projects and environments: projects, environments, resources, environment groups, env-group variables, and env-group secret files
  • Logs and metrics: logs, log subscriptions, log streams, metrics streams, CPU, memory, HTTP, bandwidth, disk, instance, task-run, and filter-value metrics
  • Automation and integrations: Blueprints, registry credentials, webhooks and webhook events, workflows, workflow versions, tasks, task runs, and maintenance

For operations with a request body, pass body = { ... } or pass body fields directly when there is no ambiguity. Path and query parameters follow Render’s documented names; snake_case aliases work for camelCase parameters such as service_id, deploy_id, owner_id, start_time, and end_time.

Raw agent markdown 
# Render Lua Reference

Namespace: `render`

This integration covers Render's official public OpenAPI registry from `https://api-docs.render.com/openapi/render-public-api-1.json`. Tools map directly to documented operations for services, deploys, jobs, cron runs, disks, databases, key value stores, projects, environments, env groups, owners, registry credentials, logs, metrics, webhooks, workflows, tasks, maintenance, and Blueprints.

All tools return Render's JSON response directly. Endpoints that stream or return non-JSON content return `{ body, content_type }`.

## Common Patterns

List services:

```lua
local services = app.integrations.render.list_services({
  limit = 20
})
```

Create a deploy:

```lua
local deploy = app.integrations.render.create_deploy({
  service_id = "srv-example",
  body = {
    clearCache = "do_not_clear"
  }
})
```

Cancel a deploy:

```lua
app.integrations.render.cancel_deploy({
  service_id = "srv-example",
  deploy_id = "dep-example"
})
```

Read service environment variables:

```lua
local env = app.integrations.render.get_env_vars_for_service({
  service_id = "srv-example",
  limit = 50
})
```

Create a Postgres export:

```lua
local export = app.integrations.render.create_postgres_export({
  postgres_id = "dpg-example",
  body = {
    format = "custom"
  }
})
```

Query CPU metrics:

```lua
local cpu = app.integrations.render.get_cpu({
  resource = "srv-example",
  startTime = "2026-01-01T00:00:00Z",
  endTime = "2026-01-01T01:00:00Z"
})
```

## Tool Families

- Account and owners: `get_current_user`, `list_owners`, `retrieve_owner`, `retrieve_owner_members`, owner audit logs, workspace member updates
- Services: `list_services`, `create_service`, `get_service`, `update_service`, `delete_service`, `suspend_service`, `resume_service`, `restart_service`, `scale_service`, autoscaling, previews, routes, headers, custom domains, env vars, and secret files
- Deploys and jobs: `list_deploys`, `create_deploy`, `get_deploy`, `cancel_deploy`, `rollback_deploy`, `list_jobs`, `post_job`, `retrieve_job`, `cancel_job`, cron job run tools
- Datastores: disks and snapshots, Postgres, Redis, key value stores, connection info, database users, exports, recovery, failover, suspend, resume, and restart operations
- Projects and environments: projects, environments, resources, environment groups, env-group variables, and env-group secret files
- Logs and metrics: logs, log subscriptions, log streams, metrics streams, CPU, memory, HTTP, bandwidth, disk, instance, task-run, and filter-value metrics
- Automation and integrations: Blueprints, registry credentials, webhooks and webhook events, workflows, workflow versions, tasks, task runs, and maintenance

For operations with a request body, pass `body = { ... }` or pass body fields directly when there is no ambiguity. Path and query parameters follow Render's documented names; snake_case aliases work for camelCase parameters such as `service_id`, `deploy_id`, `owner_id`, `start_time`, and `end_time`.
Metadata-derived Lua example 
local result = app.integrations.render.list_blueprints({})
print(result)

Functions

list_blueprints Read

List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has access to.

Lua path
app.integrations.render.list_blueprints
Full name
render.render_list_blueprints
ParameterTypeRequiredDescription
No parameters.
validate_blueprint Write

Validate a `render.yaml` Blueprint file without creating or modifying any resources. This endpoint checks the syntax and structure of the Blueprint, validates that all required fields are present, and returns a plan indicating the resources that would be created. Requests to this endpoint use `Content-Type: multipart/form-data`. The provided Blueprint file cannot exceed 10MB in size.

Lua path
app.integrations.render.validate_blueprint
Full name
render.render_validate_blueprint
ParameterTypeRequiredDescription
No parameters.
update_workspace_member_role Write

Update the role of an existing workspace member.

Lua path
app.integrations.render.update_workspace_member_role
Full name
render.render_update_workspace_member
ParameterTypeRequiredDescription
No parameters.
remove_workspace_member Write

Remove a user from the specified workspace.

Lua path
app.integrations.render.remove_workspace_member
Full name
render.render_remove_workspace_member
ParameterTypeRequiredDescription
No parameters.
retrieve_blueprint Read

Retrieve the Blueprint with the provided ID.

Lua path
app.integrations.render.retrieve_blueprint
Full name
render.render_retrieve_blueprint
ParameterTypeRequiredDescription
No parameters.
update_blueprint Write

Update the Blueprint with the provided ID.

Lua path
app.integrations.render.update_blueprint
Full name
render.render_update_blueprint
ParameterTypeRequiredDescription
No parameters.
disconnect_blueprint Write

Disconnect the Blueprint with the provided ID. Disconnecting a Blueprint stops automatic resource syncing via the associated `render.yaml` file. It does not _delete_ any services or other resources that were managed by the blueprint.

Lua path
app.integrations.render.disconnect_blueprint
Full name
render.render_disconnect_blueprint
ParameterTypeRequiredDescription
No parameters.
list_blueprint_syncs Read

List syncs for the Blueprint with the provided ID.

Lua path
app.integrations.render.list_blueprint_syncs
Full name
render.render_list_blueprint_syncs
ParameterTypeRequiredDescription
No parameters.
list_disks Read

List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view.

Lua path
app.integrations.render.list_disks
Full name
render.render_list_disks
ParameterTypeRequiredDescription
No parameters.
add_disk Write

Attach a persistent disk to a web service, private service, or background worker. The service must be redeployed for the disk to be attached.

Lua path
app.integrations.render.add_disk
Full name
render.render_add_disk
ParameterTypeRequiredDescription
No parameters.
retrieve_disk Read

Retrieve the persistent disk with the provided ID.

Lua path
app.integrations.render.retrieve_disk
Full name
render.render_retrieve_disk
ParameterTypeRequiredDescription
No parameters.
update_disk Write

Update the persistent disk with the provided ID. The disk's associated service must be deployed and active for updates to take effect. When resizing a disk, the new size must be greater than the current size.

Lua path
app.integrations.render.update_disk
Full name
render.render_update_disk
ParameterTypeRequiredDescription
No parameters.
delete_disk Write

Delete a persistent disk attached to a service. **All data on the disk will be lost.** The disk's associated service will immediately lose access to it.

Lua path
app.integrations.render.delete_disk
Full name
render.render_delete_disk
ParameterTypeRequiredDescription
No parameters.
list_snapshots Read

List snapshots for the persistent disk with the provided ID. Each snapshot is a point-in-time copy of the disk's data.

Lua path
app.integrations.render.list_snapshots
Full name
render.render_list_snapshots
ParameterTypeRequiredDescription
No parameters.
restore_snapshot Write

Restore a persistent disk to an available snapshot. **This operation is irreversible.** It will overwrite the current disk data. It might also trigger a service deploy. Snapshot keys returned from the [List snapshots](https://api-docs.render.com/reference/list-snapshots) endpoint expire after 24 hours. If a snapshot key has expired, query the endpoint again for a new key.

Lua path
app.integrations.render.restore_snapshot
Full name
render.render_restore_snapshot
ParameterTypeRequiredDescription
No parameters.
get_authenticated_user Read

Retrieve the user associated with the provided API key.

Lua path
app.integrations.render.get_authenticated_user
Full name
render.render_get_current_user
ParameterTypeRequiredDescription
No parameters.
list_workspaces Read

List the workspaces that your API key has access to, optionally filtered by name or owner email address.

Lua path
app.integrations.render.list_workspaces
Full name
render.render_list_owners
ParameterTypeRequiredDescription
No parameters.
retrieve_workspace Read

Retrieve the workspace with the provided ID. Workspace IDs start with `tea-`. If you provide a user ID (starts with `own-`), this endpoint returns the user's default workspace.

Lua path
app.integrations.render.retrieve_workspace
Full name
render.render_retrieve_owner
ParameterTypeRequiredDescription
No parameters.
list_workspace_members Read

Retrieves the list of users belonging to the workspace with the provided ID.

Lua path
app.integrations.render.list_workspace_members
Full name
render.render_retrieve_owner_members
ParameterTypeRequiredDescription
No parameters.
list_workspace_audit_logs Read

Retrieve audit logs for a specific workspace with optional filtering and pagination.

Lua path
app.integrations.render.list_workspace_audit_logs
Full name
render.render_list_owner_audit_logs
ParameterTypeRequiredDescription
No parameters.
list_organization_audit_logs Read

Retrieve audit logs for a specific organization with optional filtering and pagination.

Lua path
app.integrations.render.list_organization_audit_logs
Full name
render.render_list_organization_audit_logs
ParameterTypeRequiredDescription
No parameters.
retrieve_notification_settings Read

Retrieve notification settings for the owner with the provided ID. Note that you provide an owner ID to this endpoint, not the ID for a particular resource.

Lua path
app.integrations.render.retrieve_notification_settings
Full name
render.render_retrieve_owner_notification_settings
ParameterTypeRequiredDescription
No parameters.
update_notification_settings Write

Update notification settings for the owner with the provided ID.

Lua path
app.integrations.render.update_notification_settings
Full name
render.render_patch_owner_notification_settings
ParameterTypeRequiredDescription
No parameters.
list_notification_overrides Read

List notification overrides matching the provided filters. If no filters are provided, returns all notification overrides for all workspaces the user belongs to.

Lua path
app.integrations.render.list_notification_overrides
Full name
render.render_list_notification_overrides
ParameterTypeRequiredDescription
No parameters.
retrieve_notification_override Read

Retrieve the notification override for the service with the provided ID. Note that you provide a service ID to this endpoint, not the ID for a particular override.

Lua path
app.integrations.render.retrieve_notification_override
Full name
render.render_retrieve_service_notification_overrides
ParameterTypeRequiredDescription
No parameters.
update_notification_override Write

Update the notification override for the service with the provided ID.

Lua path
app.integrations.render.update_notification_override
Full name
render.render_patch_service_notification_overrides
ParameterTypeRequiredDescription
No parameters.
list_registry_credentials Read

List registry credentials matching the provided filters. If no filters are provided, returns all registry credentials you have permissions to view.

Lua path
app.integrations.render.list_registry_credentials
Full name
render.render_list_registry_credentials
ParameterTypeRequiredDescription
No parameters.
create_registry_credential Write

Create a new registry credential.

Lua path
app.integrations.render.create_registry_credential
Full name
render.render_create_registry_credential
ParameterTypeRequiredDescription
No parameters.
retrieve_registry_credential Read

Retrieve the registry credential with the provided ID.

Lua path
app.integrations.render.retrieve_registry_credential
Full name
render.render_retrieve_registry_credential
ParameterTypeRequiredDescription
No parameters.
update_registry_credential Write

Update the registry credential with the provided ID. Services that use this credential must be redeployed to use updated values.

Lua path
app.integrations.render.update_registry_credential
Full name
render.render_update_registry_credential
ParameterTypeRequiredDescription
No parameters.
delete_registry_credential Write

Delete the registry credential with the provided ID.

Lua path
app.integrations.render.delete_registry_credential
Full name
render.render_delete_registry_credential
ParameterTypeRequiredDescription
No parameters.
list_services Read

List services matching the provided filters. If no filters are provided, returns all services you have permissions to view.

Lua path
app.integrations.render.list_services
Full name
render.render_list_services
ParameterTypeRequiredDescription
No parameters.
create_service Write

Creates a new Render service in the specified workspace with the specified configuration.

Lua path
app.integrations.render.create_service
Full name
render.render_create_service
ParameterTypeRequiredDescription
No parameters.
retrieve_service Read

Retrieve the service with the provided ID.

Lua path
app.integrations.render.retrieve_service
Full name
render.render_get_service
ParameterTypeRequiredDescription
No parameters.
update_service Write

Update the service with the provided ID.

Lua path
app.integrations.render.update_service
Full name
render.render_update_service
ParameterTypeRequiredDescription
No parameters.
delete_service Write

Delete the service with the provided ID.

Lua path
app.integrations.render.delete_service
Full name
render.render_delete_service
ParameterTypeRequiredDescription
No parameters.
purge_web_service_cache Write

Trigger cache purge for the web service if caching is enabled.

Lua path
app.integrations.render.purge_web_service_cache
Full name
render.render_purge_cache
ParameterTypeRequiredDescription
No parameters.
list_deploys Read

List deploys matching the provided filters. If no filters are provided, all deploys for the service are returned.

Lua path
app.integrations.render.list_deploys
Full name
render.render_list_deploys
ParameterTypeRequiredDescription
No parameters.
trigger_deploy Write

Trigger a deploy for the service with the provided ID.

Lua path
app.integrations.render.trigger_deploy
Full name
render.render_create_deploy
ParameterTypeRequiredDescription
No parameters.
retrieve_deploy Read

Retrieve the details of a particular deploy for a particular service.

Lua path
app.integrations.render.retrieve_deploy
Full name
render.render_get_deploy
ParameterTypeRequiredDescription
No parameters.
cancel_deploy Write

Cancel an in-progress deploy for a service. Not supported for cron jobs.

Lua path
app.integrations.render.cancel_deploy
Full name
render.render_cancel_deploy
ParameterTypeRequiredDescription
No parameters.
roll_back_deploy Write

Trigger a rollback to a previous deploy of the specified service. Triggering a rollback with this endpoint does not disable autodeploys for the service. This means an autodeploy might restore changes you had intentionally rolled back. You can toggle autodeploys for your service with the [Update service](https://api-docs.render.com/reference/update-service) endpoint or in the Render Dashboard.

Lua path
app.integrations.render.roll_back_deploy
Full name
render.render_rollback_deploy
ParameterTypeRequiredDescription
No parameters.
list_environment_variables Read

List all environment variables for the service with the provided ID.

Lua path
app.integrations.render.list_environment_variables
Full name
render.render_get_env_vars_for_service
ParameterTypeRequiredDescription
No parameters.
update_environment_variables Write

Replace all environment variables for a service with the provided list of environment variables.

Lua path
app.integrations.render.update_environment_variables
Full name
render.render_update_env_vars_for_service
ParameterTypeRequiredDescription
No parameters.
retrieve_environment_variable Read

Retrieve a particular environment variable for a particular service. This only applies to environment variables set directly on the service, not to environment variables in a linked environment group.

Lua path
app.integrations.render.retrieve_environment_variable
Full name
render.render_retrieve_env_var
ParameterTypeRequiredDescription
No parameters.
add_or_update_environment_variable Write

Add or update a particular environment variable for a particular service. This only applies to environment variables set directly on the service, not to environment variables in a linked environment group.

Lua path
app.integrations.render.add_or_update_environment_variable
Full name
render.render_update_env_var
ParameterTypeRequiredDescription
No parameters.
delete_environment_variable Write

Delete a particular environment variable from a particular service. This only applies to environment variables set directly on the service, not to environment variables in a linked environment group.

Lua path
app.integrations.render.delete_environment_variable
Full name
render.render_delete_env_var
ParameterTypeRequiredDescription
No parameters.
list_secret_files Read

List all secret files for the service with the provided ID.

Lua path
app.integrations.render.list_secret_files
Full name
render.render_list_secret_files_for_service
ParameterTypeRequiredDescription
No parameters.
update_secret_files Write

Replace all secret files for a service with the provided list of secret files. **Any of the service's existing secret files not included in this request will be deleted.** This only applies to secret files set directly on the service, not to secret files in a linked environment group.

Lua path
app.integrations.render.update_secret_files
Full name
render.render_update_secret_files_for_service
ParameterTypeRequiredDescription
No parameters.
retrieve_secret_file Read

Retrieve a particular secret file for a particular service. This only applies to secret files set directly on the service, not to secret files in a linked environment group.

Lua path
app.integrations.render.retrieve_secret_file
Full name
render.render_retrieve_secret_file
ParameterTypeRequiredDescription
No parameters.
add_or_update_secret_file Write

Add or update a particular secret file for a particular service. This only applies to secret files set directly on the service, not to secret files in a linked environment group.

Lua path
app.integrations.render.add_or_update_secret_file
Full name
render.render_add_or_update_secret_file
ParameterTypeRequiredDescription
No parameters.
delete_secret_file Write

Delete a particular secret file from a particular service. This only applies to secret files set directly on the service, not to secret files in a linked environment group.

Lua path
app.integrations.render.delete_secret_file
Full name
render.render_delete_secret_file
ParameterTypeRequiredDescription
No parameters.
list_events Read

List recent events that occurred for the service with the provided ID.

Lua path
app.integrations.render.list_events
Full name
render.render_list_events
ParameterTypeRequiredDescription
No parameters.
list_header_rules Read

List a particular service's response header rules that match the provided filters. If no filters are provided, all rules for the service are returned.

Lua path
app.integrations.render.list_header_rules
Full name
render.render_list_headers
ParameterTypeRequiredDescription
No parameters.
add_header_rule Write

Add a response header rule to the service with the provided ID.

Lua path
app.integrations.render.add_header_rule
Full name
render.render_add_headers
ParameterTypeRequiredDescription
No parameters.
replace_header_rules Write

Replace all header rules for a particular service with the provided list. **This deletes all existing header rules for the service that aren't included in the request.**

Lua path
app.integrations.render.replace_header_rules
Full name
render.render_update_headers
ParameterTypeRequiredDescription
No parameters.
delete_header_rule Write

Delete a particular response header rule for a particular service.

Lua path
app.integrations.render.delete_header_rule
Full name
render.render_delete_header
ParameterTypeRequiredDescription
No parameters.
list_redirect_rewrite_rules Read

List a particular service's redirect/rewrite rules that match the provided filters. If no filters are provided, all rules for the service are returned.

Lua path
app.integrations.render.list_redirect_rewrite_rules
Full name
render.render_list_routes
ParameterTypeRequiredDescription
No parameters.
add_redirect_rewrite_rules Write

Add redirect/rewrite rules to the service with the provided ID.

Lua path
app.integrations.render.add_redirect_rewrite_rules
Full name
render.render_add_route
ParameterTypeRequiredDescription
No parameters.
update_redirect_rewrite_rule_priority Write

Update the priority for a particular redirect/rewrite rule. To apply redirect/rewrite rules to an incoming request, Render starts from the rule with priority `0` and applies the first encountered rule that matches the request's path (if any). Render increments the priority of other rules by `1` as necessary to make space for the updated rule.

Lua path
app.integrations.render.update_redirect_rewrite_rule_priority
Full name
render.render_patch_route
ParameterTypeRequiredDescription
No parameters.
update_redirect_rewrite_rules Write

Replace all redirect/rewrite rules for a particular service with the provided list. **This deletes all existing redirect/rewrite rules for the service that aren't included in the request.** Rule priority is assigned according to list order (the first rule in the list has the highest priority).

Lua path
app.integrations.render.update_redirect_rewrite_rules
Full name
render.render_put_routes
ParameterTypeRequiredDescription
No parameters.
delete_redirect_rewrite_rule Write

Delete a particular redirect/rewrite rule for a particular service.

Lua path
app.integrations.render.delete_redirect_rewrite_rule
Full name
render.render_delete_route
ParameterTypeRequiredDescription
No parameters.
list_custom_domains Read

List a particular service's custom domains that match the provided filters. If no filters are provided, all custom domains for the service are returned.

Lua path
app.integrations.render.list_custom_domains
Full name
render.render_list_custom_domains
ParameterTypeRequiredDescription
No parameters.
add_custom_domain Write

Add a custom domain to the service with the provided ID.

Lua path
app.integrations.render.add_custom_domain
Full name
render.render_create_custom_domain
ParameterTypeRequiredDescription
No parameters.
retrieve_custom_domain Read

Retrieve a particular custom domain for a particular service.

Lua path
app.integrations.render.retrieve_custom_domain
Full name
render.render_retrieve_custom_domain
ParameterTypeRequiredDescription
No parameters.
delete_custom_domain Write

Delete a custom domain for a service given the service id and custom domain id or name.

Lua path
app.integrations.render.delete_custom_domain
Full name
render.render_delete_custom_domain
ParameterTypeRequiredDescription
No parameters.
verify_dns_configuration Write

Verify the DNS configuration for a custom domain.

Lua path
app.integrations.render.verify_dns_configuration
Full name
render.render_refresh_custom_domain
ParameterTypeRequiredDescription
No parameters.
suspend_service Write

Suspend the service with the provided ID.

Lua path
app.integrations.render.suspend_service
Full name
render.render_suspend_service
ParameterTypeRequiredDescription
No parameters.
resume_service Write

Resume the service with the provided ID (if it's currently suspended).

Lua path
app.integrations.render.resume_service
Full name
render.render_resume_service
ParameterTypeRequiredDescription
No parameters.
restart_service Write

Restart the service with the provided ID. Not supported for cron jobs.

Lua path
app.integrations.render.restart_service
Full name
render.render_restart_service
ParameterTypeRequiredDescription
No parameters.
scale_instance_count Write

[Scale](https://render.com/docs/scaling#manual-scaling) the service with the provided ID to a fixed number of instances. Render ignores this value as long as autoscaling is enabled for the service.

Lua path
app.integrations.render.scale_instance_count
Full name
render.render_scale_service
ParameterTypeRequiredDescription
No parameters.
update_autoscaling_config Write

Update the [autoscaling](https://render.com/docs/scaling#autoscaling) config for the service with the provided ID.

Lua path
app.integrations.render.update_autoscaling_config
Full name
render.render_autoscale_service
ParameterTypeRequiredDescription
No parameters.
delete_autoscaling_config Write

Delete the autoscaling config for a service given the service id.

Lua path
app.integrations.render.delete_autoscaling_config
Full name
render.render_delete_autoscaling_config
ParameterTypeRequiredDescription
No parameters.
create_service_preview_image_backed Write

Create a preview instance for an image-backed service. The preview uses the settings of the base service (referenced by `serviceId`), except settings overridden via provided parameters. View all active previews from your service's Previews tab in the Render Dashboard. Note that you can't create previews for Git-backed services using the Render API.

Lua path
app.integrations.render.create_service_preview_image_backed
Full name
render.render_preview_service
ParameterTypeRequiredDescription
No parameters.
list_jobs Read

List jobs for the provided service that match the provided filters. If no filters are provided, all jobs for the service are returned.

Lua path
app.integrations.render.list_jobs
Full name
render.render_list_jobs
ParameterTypeRequiredDescription
No parameters.
create_job Write

Create a one-off job using the provided service. For details, see [One-Off Jobs](https://render.com/docs/one-off-jobs).

Lua path
app.integrations.render.create_job
Full name
render.render_post_job
ParameterTypeRequiredDescription
No parameters.
retrieve_job Read

Retrieve the details of a particular one-off job for a particular service.

Lua path
app.integrations.render.retrieve_job
Full name
render.render_retrieve_job
ParameterTypeRequiredDescription
No parameters.
cancel_running_job Write

Cancel a particular one-off job for a particular service.

Lua path
app.integrations.render.cancel_running_job
Full name
render.render_cancel_job
ParameterTypeRequiredDescription
No parameters.
list_instances Read

List instances for the provided service.

Lua path
app.integrations.render.list_instances
Full name
render.render_list_instances
ParameterTypeRequiredDescription
No parameters.
trigger_cron_job_run Write

Trigger a run for a cron job and cancel any active runs.

Lua path
app.integrations.render.trigger_cron_job_run
Full name
render.render_run_cron_job
ParameterTypeRequiredDescription
No parameters.
cancel_running_cron_job Write

Cancel a currently running cron job.

Lua path
app.integrations.render.cancel_running_cron_job
Full name
render.render_cancel_cron_job_run
ParameterTypeRequiredDescription
No parameters.
retrieve_event Read

Retrieve the details of a particular event

Lua path
app.integrations.render.retrieve_event
Full name
render.render_retrieve_event
ParameterTypeRequiredDescription
No parameters.
list_logs Read

List logs matching the provided filters. Logs are paginated by start and end timestamps. There are more logs to fetch if `hasMore` is true in the response. Provide the `nextStartTime` and `nextEndTime` timestamps as the `startTime` and `endTime` query parameters to fetch the next page of logs. You can query for logs across multiple resources, but all resources must be in the same region and bel...

Lua path
app.integrations.render.list_logs
Full name
render.render_list_logs
ParameterTypeRequiredDescription
No parameters.
subscribe_new_logs Read

Open a websocket connection to subscribe to logs matching the provided filters. Logs are streamed in real-time as they are generated. You can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner.

Lua path
app.integrations.render.subscribe_new_logs
Full name
render.render_subscribe_logs
ParameterTypeRequiredDescription
No parameters.
list_log_label_values Read

List all values for a given log label in the logs matching the provided filters.

Lua path
app.integrations.render.list_log_label_values
Full name
render.render_list_logs_values
ParameterTypeRequiredDescription
No parameters.
retrieve_log_stream Read

Returns log stream information for the specified workspace.

Lua path
app.integrations.render.retrieve_log_stream
Full name
render.render_get_owner_log_stream
ParameterTypeRequiredDescription
No parameters.
update_log_stream Write

Updates log stream information for the specified workspace. All logs for resources owned by this workspace will be sent to this log stream unless overridden by individual resources.

Lua path
app.integrations.render.update_log_stream
Full name
render.render_update_owner_log_stream
ParameterTypeRequiredDescription
No parameters.
delete_log_stream Write

Removes the log stream for the specified workspace.

Lua path
app.integrations.render.delete_log_stream
Full name
render.render_delete_owner_log_stream
ParameterTypeRequiredDescription
No parameters.
list_log_stream_overrides Read

Lists log stream overrides for the provided workspace that match the provided filters. These overrides take precedence over the workspace's default log stream.

Lua path
app.integrations.render.list_log_stream_overrides
Full name
render.render_list_resource_log_streams
ParameterTypeRequiredDescription
No parameters.
retrieve_log_stream_override Read

Returns log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream.

Lua path
app.integrations.render.retrieve_log_stream_override
Full name
render.render_get_resource_log_stream
ParameterTypeRequiredDescription
No parameters.
update_log_stream_override Write

Updates log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream.

Lua path
app.integrations.render.update_log_stream_override
Full name
render.render_update_resource_log_stream
ParameterTypeRequiredDescription
No parameters.
delete_log_stream_override Write

Removes the log stream override for the specified resource. After deletion, the resource will use the workspace's default log stream setting.

Lua path
app.integrations.render.delete_log_stream_override
Full name
render.render_delete_resource_log_stream
ParameterTypeRequiredDescription
No parameters.
retrieve_metrics_stream Read

Returns metrics stream information for the specified workspace.

Lua path
app.integrations.render.retrieve_metrics_stream
Full name
render.render_get_owner_metrics_stream
ParameterTypeRequiredDescription
No parameters.
create_or_update_metrics_stream Write

Creates or updates the metrics stream for the specified workspace.

Lua path
app.integrations.render.create_or_update_metrics_stream
Full name
render.render_upsert_owner_metrics_stream
ParameterTypeRequiredDescription
No parameters.
delete_metrics_stream Write

Deletes the metrics stream for the specified workspace.

Lua path
app.integrations.render.delete_metrics_stream
Full name
render.render_delete_owner_metrics_stream
ParameterTypeRequiredDescription
No parameters.
get_cpu_usage Read

Get CPU usage for one or more resources.

Lua path
app.integrations.render.get_cpu_usage
Full name
render.render_get_cpu
ParameterTypeRequiredDescription
No parameters.
get_cpu_limit Read

Get the CPU limit for one or more resources.

Lua path
app.integrations.render.get_cpu_limit
Full name
render.render_get_cpu_limit
ParameterTypeRequiredDescription
No parameters.
get_cpu_target Read

Get CPU target for one or more resources.

Lua path
app.integrations.render.get_cpu_target
Full name
render.render_get_cpu_target
ParameterTypeRequiredDescription
No parameters.
get_memory_usage Read

Get memory usage for one or more resources.

Lua path
app.integrations.render.get_memory_usage
Full name
render.render_get_memory
ParameterTypeRequiredDescription
No parameters.
get_memory_limit Read

Get the memory limit for one or more resources.

Lua path
app.integrations.render.get_memory_limit
Full name
render.render_get_memory_limit
ParameterTypeRequiredDescription
No parameters.
get_memory_target Read

Get memory target for one or more resources.

Lua path
app.integrations.render.get_memory_target
Full name
render.render_get_memory_target
ParameterTypeRequiredDescription
No parameters.
get_http_request_count Read

Get the HTTP request count for one or more resources.

Lua path
app.integrations.render.get_http_request_count
Full name
render.render_get_http_requests
ParameterTypeRequiredDescription
No parameters.
get_http_latency Read

Get HTTP latency metrics for one or more resources.

Lua path
app.integrations.render.get_http_latency
Full name
render.render_get_http_latency
ParameterTypeRequiredDescription
No parameters.
get_bandwidth_usage Read

Get bandwidth usage for one or more resources.

Lua path
app.integrations.render.get_bandwidth_usage
Full name
render.render_get_bandwidth
ParameterTypeRequiredDescription
No parameters.
get_bandwidth_usage_breakdown_by_traffic_source Read

Get bandwidth usage for one or more resources broken down by traffic source (HTTP, WebSocket, NAT, PrivateLink). Returns hourly data points with traffic source breakdown. Traffic source data is available from March 9, 2025 onwards. Queries for earlier dates will return a 400 Bad Request error.

Lua path
app.integrations.render.get_bandwidth_usage_breakdown_by_traffic_source
Full name
render.render_get_bandwidth_sources
ParameterTypeRequiredDescription
No parameters.
get_disk_usage Read

Get persistent disk usage for one or more resources.

Lua path
app.integrations.render.get_disk_usage
Full name
render.render_get_disk_usage
ParameterTypeRequiredDescription
No parameters.
get_disk_capacity Read

Get persistent disk capacity for one or more resources.

Lua path
app.integrations.render.get_disk_capacity
Full name
render.render_get_disk_capacity
ParameterTypeRequiredDescription
No parameters.
get_instance_count Read

Get the instance count for one or more resources.

Lua path
app.integrations.render.get_instance_count
Full name
render.render_get_instance_count
ParameterTypeRequiredDescription
No parameters.
get_active_connection_count Read

Get the number of active connections for one or more Postgres databases or Redis instances.

Lua path
app.integrations.render.get_active_connection_count
Full name
render.render_get_active_connections
ParameterTypeRequiredDescription
No parameters.
get_replica_lag Read

Get seconds of replica lag of a Postgres replica.

Lua path
app.integrations.render.get_replica_lag
Full name
render.render_get_replication_lag
ParameterTypeRequiredDescription
No parameters.
list_queryable_instance_values Read

List instance values to filter by for one or more resources.

Lua path
app.integrations.render.list_queryable_instance_values
Full name
render.render_list_application_filter_values
ParameterTypeRequiredDescription
No parameters.
list_queryable_status_codes_and_host_values Read

List status codes and host values to filter by for one or more resources.

Lua path
app.integrations.render.list_queryable_status_codes_and_host_values
Full name
render.render_list_http_filter_values
ParameterTypeRequiredDescription
No parameters.
list_queryable_paths Read

The path suggestions are based on the most recent 5000 log lines as filtered by the provided filters

Lua path
app.integrations.render.list_queryable_paths
Full name
render.render_list_path_filter_values
ParameterTypeRequiredDescription
No parameters.
get_task_runs_queued_count Read

Get the total number of task runs queued for one or more tasks.

Lua path
app.integrations.render.get_task_runs_queued_count
Full name
render.render_get_task_runs_queued
ParameterTypeRequiredDescription
No parameters.
get_task_runs_completed_count Read

Get the total number of task runs completed for one or more tasks. Optionally filter by state (succeeded/failed) or aggregate by state.

Lua path
app.integrations.render.get_task_runs_completed_count
Full name
render.render_get_task_runs_completed
ParameterTypeRequiredDescription
No parameters.
list_key_value_instances Read

List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are returned.

Lua path
app.integrations.render.list_key_value_instances
Full name
render.render_list_key_value
ParameterTypeRequiredDescription
No parameters.
create_key_value_instance Write

Create a new Key Value instance.

Lua path
app.integrations.render.create_key_value_instance
Full name
render.render_create_key_value
ParameterTypeRequiredDescription
No parameters.
retrieve_key_value_instance Read

Retrieve a Key Value instance by ID.

Lua path
app.integrations.render.retrieve_key_value_instance
Full name
render.render_retrieve_key_value
ParameterTypeRequiredDescription
No parameters.
update_key_value_instance Write

Update a Key Value instance by ID.

Lua path
app.integrations.render.update_key_value_instance
Full name
render.render_update_key_value
ParameterTypeRequiredDescription
No parameters.
delete_key_value_instance Write

Delete a Key Value instance by ID.

Lua path
app.integrations.render.delete_key_value_instance
Full name
render.render_delete_key_value
ParameterTypeRequiredDescription
No parameters.
retrieve_key_value_connection_info Read

Retrieve connection info for a Key Value instance by ID. Connection info includes sensitive information.

Lua path
app.integrations.render.retrieve_key_value_connection_info
Full name
render.render_retrieve_key_value_connection_info
ParameterTypeRequiredDescription
No parameters.
suspend_key_value_instance Write

Suspend a Key Value instance by ID.

Lua path
app.integrations.render.suspend_key_value_instance
Full name
render.render_suspend_key_value
ParameterTypeRequiredDescription
No parameters.
resume_key_value_instance Write

Resume a Key Value instance by ID.

Lua path
app.integrations.render.resume_key_value_instance
Full name
render.render_resume_key_value
ParameterTypeRequiredDescription
No parameters.
list_redis_instances Read

List Redis instances matching the provided filters. If no filters are provided, all Redis instances are returned. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.list_redis_instances
Full name
render.render_list_redis
ParameterTypeRequiredDescription
No parameters.
create_redis_instance Write

Create a new Redis instance. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.create_redis_instance
Full name
render.render_create_redis
ParameterTypeRequiredDescription
No parameters.
retrieve_redis_instance Read

Retrieve a Redis instance by ID. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.retrieve_redis_instance
Full name
render.render_retrieve_redis
ParameterTypeRequiredDescription
No parameters.
update_redis_instance Write

Update a Redis instance by ID. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.update_redis_instance
Full name
render.render_update_redis
ParameterTypeRequiredDescription
No parameters.
delete_redis_instance Write

Delete a Redis instance by ID. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.delete_redis_instance
Full name
render.render_delete_redis
ParameterTypeRequiredDescription
No parameters.
retrieve_redis_connection_info Read

Retrieve connection info for a Redis instance by ID. Connection info includes sensitive information. This API is deprecated in favor of the Key Value API.

Lua path
app.integrations.render.retrieve_redis_connection_info
Full name
render.render_retrieve_redis_connection_info
ParameterTypeRequiredDescription
No parameters.
list_postgres_instances Read

List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.

Lua path
app.integrations.render.list_postgres_instances
Full name
render.render_list_postgres
ParameterTypeRequiredDescription
No parameters.
create_postgres_instance Write

Create a new Postgres instance.

Lua path
app.integrations.render.create_postgres_instance
Full name
render.render_create_postgres
ParameterTypeRequiredDescription
No parameters.
retrieve_postgres_instance Read

Retrieve a Postgres instance by ID.

Lua path
app.integrations.render.retrieve_postgres_instance
Full name
render.render_retrieve_postgres
ParameterTypeRequiredDescription
No parameters.
update_postgres_instance Write

Update a Postgres instance by ID.

Lua path
app.integrations.render.update_postgres_instance
Full name
render.render_update_postgres
ParameterTypeRequiredDescription
No parameters.
delete_postgres_instance Write

Delete a Postgres instance by ID. This operation is irreversible, and all data will be lost.

Lua path
app.integrations.render.delete_postgres_instance
Full name
render.render_delete_postgres
ParameterTypeRequiredDescription
No parameters.
retrieve_postgres_connection_info Read

Retrieve connection info for a Postgres instance by ID. Connection info includes sensitive information.

Lua path
app.integrations.render.retrieve_postgres_connection_info
Full name
render.render_retrieve_postgres_connection_info
ParameterTypeRequiredDescription
No parameters.
retrieve_point_time_recovery_status Read

Retrieve information on the availability of Postgres point-in-time recovery for a Postgres instance by ID.

Lua path
app.integrations.render.retrieve_point_time_recovery_status
Full name
render.render_retrieve_postgres_recovery_info
ParameterTypeRequiredDescription
No parameters.
trigger_point_time_recovery Write

Trigger [point-in-time recovery](https://render.com/docs/postgresql-backups) on the Postgres instance with the provided ID.

Lua path
app.integrations.render.trigger_point_time_recovery
Full name
render.render_recover_postgres
ParameterTypeRequiredDescription
No parameters.
suspend_postgres_instance Write

Suspend a Postgres instance by ID.

Lua path
app.integrations.render.suspend_postgres_instance
Full name
render.render_suspend_postgres
ParameterTypeRequiredDescription
No parameters.
resume_postgres_instance Write

Resume a Postgres instance by ID.

Lua path
app.integrations.render.resume_postgres_instance
Full name
render.render_resume_postgres
ParameterTypeRequiredDescription
No parameters.
restart_postgres_instance Write

Restart a Postgres instance by ID.

Lua path
app.integrations.render.restart_postgres_instance
Full name
render.render_restart_postgres
ParameterTypeRequiredDescription
No parameters.
failover_postgres_instance Write

Failover a [highly available Postgres](https://render.com/docs/postgresql-high-availability) instance.

Lua path
app.integrations.render.failover_postgres_instance
Full name
render.render_failover_postgres
ParameterTypeRequiredDescription
No parameters.
list_postgres_exports Read

List [exports](https://render.com/docs/postgresql-backups#logical-backups) for a Postgres instance by ID. Returns a URL to download the export.

Lua path
app.integrations.render.list_postgres_exports
Full name
render.render_list_postgres_export
ParameterTypeRequiredDescription
No parameters.
create_postgres_export Write

Create an [export](https://render.com/docs/postgresql-backups#logical-backups) of a Postgres instance by ID.

Lua path
app.integrations.render.create_postgres_export
Full name
render.render_create_postgres_export
ParameterTypeRequiredDescription
No parameters.
list_postgresql_users Read

List PostgreSQL users for the Render Postgres instance with the provided ID.

Lua path
app.integrations.render.list_postgresql_users
Full name
render.render_list_postgres_users
ParameterTypeRequiredDescription
No parameters.
create_postgresql_user Write

Create a new PostgreSQL user for the Render Postgres instance with the provided ID. This becomes the database's new "default" user.

Lua path
app.integrations.render.create_postgresql_user
Full name
render.render_create_postgres_user
ParameterTypeRequiredDescription
No parameters.
delete_postgresql_user Write

Delete a PostgreSQL user from the Render Postgres instance with the provided ID.

Lua path
app.integrations.render.delete_postgresql_user
Full name
render.render_delete_postgres_user
ParameterTypeRequiredDescription
No parameters.
list_projects Read

List projects matching the provided filters. If no filters are provided, all projects are returned.

Lua path
app.integrations.render.list_projects
Full name
render.render_list_projects
ParameterTypeRequiredDescription
No parameters.
create_project Write

Create a new project.

Lua path
app.integrations.render.create_project
Full name
render.render_create_project
ParameterTypeRequiredDescription
No parameters.
retrieve_project Read

Retrieve the project with the provided ID.

Lua path
app.integrations.render.retrieve_project
Full name
render.render_retrieve_project
ParameterTypeRequiredDescription
No parameters.
update_project Write

Update the details of a project. To update the details of a particular _environment_ in the project, instead use the [Update environment](https://api-docs.render.com/reference/update-environment) endpoint.

Lua path
app.integrations.render.update_project
Full name
render.render_update_project
ParameterTypeRequiredDescription
No parameters.
delete_project Write

Delete the project with the provided ID. Requires _all_ of the project's environments to be empty (i.e., they must contain no services or other resources). Otherwise, deletion fails with a `409` response. To delete a non-empty project, do one of the following: - First move or delete all contained services and other resources. - Delete the project in the [Render Dashboard](https://dashboard.rend...

Lua path
app.integrations.render.delete_project
Full name
render.render_delete_project
ParameterTypeRequiredDescription
No parameters.
create_environment Write

Create a new environment belonging to the project with the provided ID.

Lua path
app.integrations.render.create_environment
Full name
render.render_create_environment
ParameterTypeRequiredDescription
No parameters.
list_environments Read

List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned.

Lua path
app.integrations.render.list_environments
Full name
render.render_list_environments
ParameterTypeRequiredDescription
No parameters.
retrieve_environment Read

Retrieve the environment with the provided ID.

Lua path
app.integrations.render.retrieve_environment
Full name
render.render_retrieve_environment
ParameterTypeRequiredDescription
No parameters.
update_environment Write

Update the details of the environment with the provided ID.

Lua path
app.integrations.render.update_environment
Full name
render.render_update_environment
ParameterTypeRequiredDescription
No parameters.
delete_environment Write

Delete the environment with the provided ID. Requires the environment to be empty (i.e., it must contain no services or other resources). Otherwise, deletion fails with a `409` response. To delete a non-empty environment, do one of the following: - First move or delete all contained services and other resources. - Delete the environment in the [Render Dashboard](https://dashboard.render.com).

Lua path
app.integrations.render.delete_environment
Full name
render.render_delete_environment
ParameterTypeRequiredDescription
No parameters.
add_resources_environment Write

Add resources to the environment with the provided ID.

Lua path
app.integrations.render.add_resources_environment
Full name
render.render_add_resources_to_environment
ParameterTypeRequiredDescription
No parameters.
remove_resources_from_environment Write

Remove resources from the environment with the provided ID.

Lua path
app.integrations.render.remove_resources_from_environment
Full name
render.render_remove_resources_from_environment
ParameterTypeRequiredDescription
No parameters.
list_environment_groups Read

List environment groups matching the provided filters. If no filters are provided, all environment groups are returned.

Lua path
app.integrations.render.list_environment_groups
Full name
render.render_list_env_groups
ParameterTypeRequiredDescription
No parameters.
create_environment_group Write

Create a new environment group.

Lua path
app.integrations.render.create_environment_group
Full name
render.render_create_env_group
ParameterTypeRequiredDescription
No parameters.
retrieve_environment_group Read

Retrieve an environment group by ID.

Lua path
app.integrations.render.retrieve_environment_group
Full name
render.render_retrieve_env_group
ParameterTypeRequiredDescription
No parameters.
update_environment_group Write

Update the attributes of an environment group.

Lua path
app.integrations.render.update_environment_group
Full name
render.render_update_env_group
ParameterTypeRequiredDescription
No parameters.
delete_environment_group Write

Delete the environment group with the provided ID, including all environment variables and secret files it contains.

Lua path
app.integrations.render.delete_environment_group
Full name
render.render_delete_env_group
ParameterTypeRequiredDescription
No parameters.
retrieve_environment_variable Read

Retrieve a particular environment variable in a particular environment group.

Lua path
app.integrations.render.retrieve_environment_variable
Full name
render.render_retrieve_env_group_env_var
ParameterTypeRequiredDescription
No parameters.
add_or_update_environment_variable Write

Add or update a particular environment variable in a particular environment group.

Lua path
app.integrations.render.add_or_update_environment_variable
Full name
render.render_update_env_group_env_var
ParameterTypeRequiredDescription
No parameters.
remove_environment_variable Write

Remove a particular environment variable from a particular environment group.

Lua path
app.integrations.render.remove_environment_variable
Full name
render.render_delete_env_group_env_var
ParameterTypeRequiredDescription
No parameters.
retrieve_secret_file Read

Retrieve a particular secret file in a particular environment group.

Lua path
app.integrations.render.retrieve_secret_file
Full name
render.render_retrieve_env_group_secret_file
ParameterTypeRequiredDescription
No parameters.
add_or_update_secret_file Write

Add or update a particular secret file in an particular environment group.

Lua path
app.integrations.render.add_or_update_secret_file
Full name
render.render_update_env_group_secret_file
ParameterTypeRequiredDescription
No parameters.
remove_secret_file Write

Remove a particular secret file from a particular environment group.

Lua path
app.integrations.render.remove_secret_file
Full name
render.render_delete_env_group_secret_file
ParameterTypeRequiredDescription
No parameters.
list_maintenance_runs Read

List scheduled and/or recent maintenance runs for specified resources.

Lua path
app.integrations.render.list_maintenance_runs
Full name
render.render_list_maintenance
ParameterTypeRequiredDescription
No parameters.
retrieve_maintenance_run Read

Retrieve the maintenance run with the provided ID.

Lua path
app.integrations.render.retrieve_maintenance_run
Full name
render.render_retrieve_maintenance
ParameterTypeRequiredDescription
No parameters.
update_maintenance_run Write

Update the maintenance run with the provided ID. Updates from this endpoint are asynchronous. To check your update's status, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint.

Lua path
app.integrations.render.update_maintenance_run
Full name
render.render_update_maintenance
ParameterTypeRequiredDescription
No parameters.
trigger_maintenance_run Write

Trigger the scheduled maintenance run with the provided ID. Triggering maintenance is asynchronous. To check whether maintenance has started, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint. As maintenance progresses, the run's `state` will change from `scheduled` to other values, such as `in_progress` and `succeeded`.

Lua path
app.integrations.render.trigger_maintenance_run
Full name
render.render_trigger_maintenance
ParameterTypeRequiredDescription
No parameters.
create_webhook Write

Create a new webhook.

Lua path
app.integrations.render.create_webhook
Full name
render.render_create_webhook
ParameterTypeRequiredDescription
No parameters.
list_webhooks Read

List webhooks

Lua path
app.integrations.render.list_webhooks
Full name
render.render_list_webhooks
ParameterTypeRequiredDescription
No parameters.
retrieve_webhook Read

Retrieve the webhook with the provided ID

Lua path
app.integrations.render.retrieve_webhook
Full name
render.render_retrieve_webhook
ParameterTypeRequiredDescription
No parameters.
update_webhook Write

Update the webhook with the provided ID.

Lua path
app.integrations.render.update_webhook
Full name
render.render_update_webhook
ParameterTypeRequiredDescription
No parameters.
delete_webhook Write

Delete the webhook with the provided ID.

Lua path
app.integrations.render.delete_webhook
Full name
render.render_delete_webhook
ParameterTypeRequiredDescription
No parameters.
list_webhook_events Read

Retrieve a list of events that have been sent to this webhook, with optional filtering by timestamp.

Lua path
app.integrations.render.list_webhook_events
Full name
render.render_list_webhook_events
ParameterTypeRequiredDescription
No parameters.
list_workflows Read

List workflows that match the provided filters. If no filters are provided, all workflows accessible by the authenticated user are returned.

Lua path
app.integrations.render.list_workflows
Full name
render.render_list_workflows
ParameterTypeRequiredDescription
No parameters.
create_workflow Write

Create a new workflow service with the specified configuration.

Lua path
app.integrations.render.create_workflow
Full name
render.render_create_workflow
ParameterTypeRequiredDescription
No parameters.
retrieve_workflow Read

Retrieve the workflow service with the provided ID.

Lua path
app.integrations.render.retrieve_workflow
Full name
render.render_get_workflow
ParameterTypeRequiredDescription
No parameters.
update_workflow Write

Update the workflow service with the provided ID.

Lua path
app.integrations.render.update_workflow
Full name
render.render_update_workflow
ParameterTypeRequiredDescription
No parameters.
delete_workflow Write

Delete the workflow service with the provided ID.

Lua path
app.integrations.render.delete_workflow
Full name
render.render_delete_workflow
ParameterTypeRequiredDescription
No parameters.
list_workflow_versions Read

List known versions of the workflow service with the provided ID.

Lua path
app.integrations.render.list_workflow_versions
Full name
render.render_list_workflow_versions
ParameterTypeRequiredDescription
No parameters.
deploy_workflow_version Write

Creates and deploys a new version of a workflow.

Lua path
app.integrations.render.deploy_workflow_version
Full name
render.render_create_workflow_version
ParameterTypeRequiredDescription
No parameters.
retrieve_workflow_version Read

Retrieve the specific workflow service version with the provided ID.

Lua path
app.integrations.render.retrieve_workflow_version
Full name
render.render_get_workflow_version
ParameterTypeRequiredDescription
No parameters.
list_tasks Read

List workflow tasks that match the provided filters. If no filters are provided, all task definitions accessible by the authenticated user are returned.

Lua path
app.integrations.render.list_tasks
Full name
render.render_list_tasks
ParameterTypeRequiredDescription
No parameters.
retrieve_task Read

Retrieve the workflow task with the provided ID.

Lua path
app.integrations.render.retrieve_task
Full name
render.render_get_task
ParameterTypeRequiredDescription
No parameters.
list_task_runs Read

List task runs that match the provided filters. If no filters are provided, all task runs accessible by the authenticated user are returned.

Lua path
app.integrations.render.list_task_runs
Full name
render.render_list_task_runs
ParameterTypeRequiredDescription
No parameters.
run_task Write

Kicks off a run of the workflow task with the provided ID, passing the provided input data.

Lua path
app.integrations.render.run_task
Full name
render.render_create_task
ParameterTypeRequiredDescription
No parameters.
stream_realtime_events_sse Read

Establishes a unidirectional event stream. The server sends events as lines formatted per the SSE spec. Clients SHOULD set `Accept: text/event-stream` and keep the connection open.

Lua path
app.integrations.render.stream_realtime_events_sse
Full name
render.render_stream_task_runs_events
ParameterTypeRequiredDescription
No parameters.
retrieve_task_run Read

Retrieve the workflow task run with the provided ID.

Lua path
app.integrations.render.retrieve_task_run
Full name
render.render_get_task_run
ParameterTypeRequiredDescription
No parameters.
cancel_task_run Write

Cancel a running task run with the provided ID.

Lua path
app.integrations.render.cancel_task_run
Full name
render.render_cancel_task_run
ParameterTypeRequiredDescription
No parameters.