Workflow tools 5
Always available, in any toolset configuration.
| Tool | Description |
|---|---|
render_find_service |
Resolves a service name — including a partial or approximate one — to a single Render service, returning its id plus close alternatives. |
render_recent_logs |
Fetches recent log lines for a service, resolving the service name and workspace id for you. |
render_service_status |
One-call triage for a service: its configuration, latest deploys, running instances and most recent error-level logs. |
render_toolsets |
Lists every Render toolset with its tool count and whether it is currently enabled. |
render_wait_for_deploy |
Polls a deploy until it reaches a terminal state (live, build_failed, update_failed, canceled, deactivated) or the timeout expires. |
services 42
Services, deploys, custom domains, one-off jobs, cron job runs and events.
| Tool | Description |
|---|---|
render_add_or_update_secret_file |
Add or update secret file. |
render_autoscale_service |
Update autoscaling config. |
render_cancel_cron_job_run |
Cancel running cron job. |
render_cancel_deploy |
Cancel deploy. |
render_cancel_job |
Cancel running job. |
render_create_custom_domain |
Add custom domain. |
render_create_deploy |
Trigger deploy. Usage: Omit `commitId`/`imageUrl` to deploy the branch tip or the current image. `clearCache`: `clear` forces a rebuild from scratch and is the first thing to try when a build fails for no visible reason. Returns as soon as the deploy is queued, so follow with render_wait_for_deploy rather than polling render_retrieve_deploy. |
render_create_job |
Create job. Usage: Starts a one-off job on an existing service, reusing its image and environment. This is not how you create a cron job — a cron job is a service (render_create_service with `type`:`cron_job`), and render_run_cron_job triggers one off-schedule. |
render_create_service |
Create service. Usage: Pick the `serviceDetails` branch whose title matches `type`: `static_site`→staticSiteDetailsPOST, `web_service`→webServiceDetailsPOST, `private_service`→privateServiceDetailsPOST, `background_worker`→backgroundWorkerDetailsPOST, `cron_job`→cronJobDetailsPOST. Source comes from either `repo` (+`branch`) for a build, or `image` for a prebuilt container — never both. Inside `serviceDetails`, `envSpecificDetails` follows `runtime`: use the dockerDetails branch (`dockerfilePath`, `dockerContext`, `dockerCommand`) when `runtime` is `docker`, and the nativeEnvironmentDetails branch (`buildCommand`, `startCommand`) for every language runtime. Example — a cron job that builds from a Dockerfile and runs every day at 03:00 UTC: {"type":"cron_job","name":"nightly-report","ownerId":"tea-…", "repo":"https://github.com/acme/reports","branch":"main", "serviceDetails":{"runtime":"docker","schedule":"0 3 * * *","plan":"starter","region":"oregon", "envSpecificDetails":{"dockerfilePath":"./Dockerfile","dockerContext":".","dockerCommand":"python report.py"}}}. For a cron job running a prebuilt image, drop `repo`/`branch`, set `image` to {"ownerId":"tea-…","imagePath":"docker.io/acme/reports:latest"}, keep `runtime`:`image`, and give `envSpecificDetails` only the `dockerCommand` to run. `schedule` is a standard five-field cron expression in UTC and is required for cron jobs. Creating a service starts a first deploy; follow with render_wait_for_deploy. |
render_delete_autoscaling_config |
Delete autoscaling config. |
render_delete_custom_domain |
Delete custom domain. |
render_delete_env_var |
Delete environment variable. |
render_delete_secret_file |
Delete secret file. |
render_delete_service |
Delete service. |
render_get_env_vars_for_service |
List environment variables. |
render_list_custom_domains |
List custom domains. |
render_list_deploys |
List deploys. |
render_list_events |
List events. |
render_list_instances |
List instances. |
render_list_jobs |
List jobs. |
render_list_secret_files_for_service |
List secret files. |
render_list_services |
List services. Usage: Filters are ANDed, and `name` matches as a substring rather than exactly. When the user named one service, render_find_service resolves it in a single call and handles approximate names; reach for this tool to enumerate or filter in bulk. |
render_preview_service |
Create service preview (image-backed). |
render_purge_cache |
Purge Web Service Cache. |
render_refresh_custom_domain |
Verify DNS configuration. |
render_restart_service |
Restart service. |
render_resume_service |
Resume service. |
render_retrieve_custom_domain |
Retrieve custom domain. |
render_retrieve_deploy |
Retrieve deploy. |
render_retrieve_env_var |
Retrieve environment variable. |
render_retrieve_event |
Retrieve event. |
render_retrieve_job |
Retrieve job. |
render_retrieve_secret_file |
Retrieve secret file. |
render_retrieve_service |
Retrieve service. |
render_rollback_deploy |
Roll back deploy. Usage: `deployId` must be a previously successful deploy of this same service — list candidates with render_list_deploys and pick one whose status is `live`. |
render_run_cron_job |
Trigger cron job run. Usage: Triggers an immediate, out-of-schedule run. `cronJobId` is the cron job service's own id (`srv-…`, or `crn-…` on older workspaces) — resolve it with render_find_service. This does not change the schedule; use render_update_service for that. |
render_scale_service |
Scale instance count. Usage: Sets a fixed instance count and turns off autoscaling. To scale on load instead, use render_autoscale_service. |
render_suspend_service |
Suspend service. |
render_update_env_var |
Add or update environment variable. |
render_update_env_vars_for_service |
Update environment variables. Usage: This replaces the service's entire environment variable set: anything absent from `body` is deleted. To change one variable, read the current set with render_get_env_vars_for_service and send it back with your edit applied, or use render_update_env_var for a single key. Applying changes restarts the service. |
render_update_secret_files_for_service |
Update secret files. Usage: Replaces the full set of secret files; omitted files are deleted. Read the current set with render_list_secret_files_for_service first. |
render_update_service |
Update service. Usage: `serviceDetails` branches are the PATCH variants of the same five service types, and the branch must still match the service's existing `type` — a service cannot change type. Send only the fields you are changing; omitted fields keep their current values. Changing a cron job's `schedule` or a service's build settings does not itself deploy — call render_create_deploy afterwards when the change needs a rebuild. |
metrics 23
CPU, memory, bandwidth, HTTP, disk and connection metrics, plus metrics streams.
| Tool | Description |
|---|---|
render_delete_owner_metrics_stream |
Delete metrics stream. |
render_get_active_connections |
Get active connection count. |
render_get_bandwidth |
Get bandwidth usage. |
render_get_bandwidth_sources |
Get bandwidth usage breakdown by traffic source. |
render_get_cpu |
Get CPU usage. |
render_get_cpu_limit |
Get CPU limit. |
render_get_cpu_target |
Get CPU target. |
render_get_disk_capacity |
Get disk capacity. |
render_get_disk_usage |
Get disk usage. |
render_get_http_latency |
Get HTTP latency. |
render_get_http_requests |
Get HTTP request count. |
render_get_instance_count |
Get instance count. |
render_get_memory |
Get memory usage. |
render_get_memory_limit |
Get memory limit. |
render_get_memory_target |
Get memory target. |
render_get_owner_metrics_stream |
Retrieve metrics stream. |
render_get_replication_lag |
Get replica lag. |
render_get_task_runs_completed |
Get task runs completed count. |
render_get_task_runs_queued |
Get task runs queued count. |
render_list_application_filter_values |
List queryable instance values. |
render_list_http_filter_values |
List queryable status codes and host values. |
render_list_path_filter_values |
List queryable paths. |
render_upsert_owner_metrics_stream |
Create or update metrics stream. |
postgres 21
Postgres instances, users, exports, recovery and query insights.
| Tool | Description |
|---|---|
render_create_postgres |
Create Postgres instance. Usage: `version` is a major version as a string (e.g. "16"). Plans and their disk sizes come from render_list_postgres_sizes. The generated password appears only in the creation response; afterwards, read credentials with render_retrieve_postgres_connection_info. |
render_create_postgres_export |
Create Postgres export. |
render_create_postgres_user |
Create PostgreSQL User. |
render_delete_postgres |
Delete Postgres instance. |
render_delete_postgres_user |
Delete PostgreSQL User. |
render_failover_postgres |
Failover Postgres instance. |
render_list_postgres |
List Postgres instances. |
render_list_postgres_export |
List Postgres exports. |
render_list_postgres_processes |
List live queries. |
render_list_postgres_sizes |
List database, table, and index sizes. |
render_list_postgres_table_scans |
List table scans. |
render_list_postgres_top_queries |
List top queries. |
render_list_postgres_users |
List PostgreSQL Users. |
render_recover_postgres |
Trigger point-in-time recovery. |
render_restart_postgres |
Restart Postgres instance. |
render_resume_postgres |
Resume Postgres instance. |
render_retrieve_postgres |
Retrieve Postgres instance. |
render_retrieve_postgres_connection_info |
Retrieve Postgres connection info. |
render_retrieve_postgres_recovery_info |
Retrieve point-in-time recovery status. |
render_suspend_postgres |
Suspend Postgres instance. |
render_update_postgres |
Update Postgres instance. |
workflows 15
Render Workflows and workflow tasks (public beta).
| Tool | Description |
|---|---|
render_cancel_task_run |
Cancel task run. |
render_create_task |
Run task. |
render_create_workflow |
Create a workflow. |
render_create_workflow_version |
Deploy a workflow version. |
render_delete_workflow |
Delete workflow. |
render_get_task |
Retrieve task. |
render_get_task_run |
Retrieve task run. |
render_get_workflow |
Retrieve workflow. |
render_get_workflow_version |
Retrieve workflow version. |
render_list_task_runs |
List task runs. |
render_list_tasks |
List tasks. |
render_list_workflow_versions |
List workflow versions. |
render_list_workflows |
List workflows. |
render_stream_task_runs_events |
Stream realtime events (SSE). |
render_update_workflow |
Update workflow. |
env-groups 13
Environment groups, their variables and secret files.
| Tool | Description |
|---|---|
render_create_env_group |
Create environment group. |
render_delete_env_group |
Delete environment group. |
render_delete_env_group_env_var |
Remove environment variable. |
render_delete_env_group_secret_file |
Remove secret file. |
render_link_service_to_env_group |
Link service. |
render_list_env_groups |
List environment groups. |
render_retrieve_env_group |
Retrieve environment group. |
render_retrieve_env_group_env_var |
Retrieve environment variable. |
render_retrieve_env_group_secret_file |
Retrieve secret file. |
render_unlink_service_from_env_group |
Unlink service. |
render_update_env_group |
Update environment group. |
render_update_env_group_env_var |
Add or update environment variable. |
render_update_env_group_secret_file |
Add or update secret file. |
projects 12
Projects and environments.
| Tool | Description |
|---|---|
render_add_resources_to_environment |
Add resources to environment. |
render_create_environment |
Create environment. |
render_create_project |
Create project. |
render_delete_environment |
Delete environment. |
render_delete_project |
Delete project. |
render_list_environments |
List environments. |
render_list_projects |
List projects. |
render_remove_resources_from_environment |
Remove resources from environment. |
render_retrieve_environment |
Retrieve environment. |
render_retrieve_project |
Retrieve Project. |
render_update_environment |
Update environment. |
render_update_project |
Update project. |
webhooks 11
Webhooks and notification settings/overrides.
| Tool | Description |
|---|---|
render_create_webhook |
Create a webhook. |
render_delete_webhook |
Delete a webhook. |
render_list_notification_overrides |
List notification overrides. |
render_list_webhook_events |
List webhook events. |
render_list_webhooks |
List webhooks. |
render_patch_owner_notification_settings |
Update notification settings. |
render_patch_service_notification_overrides |
Update notification override. |
render_retrieve_owner_notification_settings |
Retrieve notification settings. |
render_retrieve_service_notification_overrides |
Retrieve notification override. |
render_retrieve_webhook |
Retrieve a webhook. |
render_update_webhook |
Update a webhook. |
logs 10
Log queries, label discovery and log stream configuration.
| Tool | Description |
|---|---|
render_delete_owner_log_stream |
Delete log stream. |
render_delete_resource_log_stream |
Delete log stream override. |
render_get_owner_log_stream |
Retrieve log stream. |
render_get_resource_log_stream |
Retrieve log stream override. |
render_list_logs |
List logs. Usage: Requires an `ownerId` and a `resource` array of ids. For the common case — recent logs for one service — render_recent_logs takes a service name and fills both in. |
render_list_logs_values |
List log label values. |
render_list_resource_log_streams |
List log stream overrides. |
render_subscribe_logs |
Subscribe to new logs. |
render_update_owner_log_stream |
Update log stream. |
render_update_resource_log_stream |
Update log stream override. |
static-sites 9
Header rules and redirect/rewrite routes for static sites.
| Tool | Description |
|---|---|
render_add_headers |
Add header rule. |
render_add_route |
Add redirect/rewrite rules. |
render_delete_header |
Delete header rule. |
render_delete_route |
Delete redirect/rewrite rule. |
render_list_headers |
List header rules. |
render_list_routes |
List redirect/rewrite rules. |
render_patch_route |
Update redirect/rewrite rule priority. |
render_put_routes |
Update redirect/rewrite rules. |
render_update_headers |
Replace header rules. |
deprecated 8
Legacy Redis endpoints that Render has superseded by the Key Value API.
| Tool | Description |
|---|---|
render_create_redis |
[DEPRECATED by Render] Create Redis instance. |
render_delete_redis |
[DEPRECATED by Render] Delete Redis instance. |
render_list_redis |
[DEPRECATED by Render] List Redis instances. |
render_resume_redis |
[DEPRECATED by Render] Resume Redis instance. |
render_retrieve_redis |
[DEPRECATED by Render] Retrieve Redis instance. |
render_retrieve_redis_connection_info |
[DEPRECATED by Render] Retrieve Redis connection info. |
render_suspend_redis |
[DEPRECATED by Render] Suspend Redis instance. |
render_update_redis |
[DEPRECATED by Render] Update Redis instance. |
key-value 8
Key Value (Redis-compatible) instances and connection info.
| Tool | Description |
|---|---|
render_create_key_value |
Create Key Value instance. Usage: Key Value is Render's Redis-compatible store and supersedes the `deprecated` toolset's Redis endpoints. Read credentials with render_retrieve_key_value_connection_info; the connection string is not returned by list or retrieve. |
render_delete_key_value |
Delete Key Value instance. |
render_list_key_value |
List Key Value instances. |
render_resume_key_value |
Resume Key Value instance. |
render_retrieve_key_value |
Retrieve Key Value instance. |
render_retrieve_key_value_connection_info |
Retrieve Key Value connection info. |
render_suspend_key_value |
Suspend Key Value instance. |
render_update_key_value |
Update Key Value instance. |
workspaces 8
Workspaces, members, the authenticated user and audit logs.
| Tool | Description |
|---|---|
render_get_user |
Get the authenticated user. |
render_list_organization_audit_logs |
List organization audit logs. |
render_list_owner_audit_logs |
List workspace audit logs. |
render_list_owners |
List workspaces. Usage: Returns the workspaces (`tea-…` ids) your API key can reach. Set RENDER_WORKSPACE_ID to the one you use so every tool needing an `ownerId` stops asking. |
render_remove_workspace_member |
Remove workspace member. |
render_retrieve_owner |
Retrieve workspace. |
render_retrieve_owner_members |
List workspace members. |
render_update_workspace_member |
Update workspace member role. |
disks 7
Persistent disks and their snapshots.
| Tool | Description |
|---|---|
render_add_disk |
Add disk. |
render_delete_disk |
Delete disk. |
render_list_disks |
List disks. |
render_list_snapshots |
List snapshots. |
render_restore_snapshot |
Restore snapshot. |
render_retrieve_disk |
Retrieve disk. |
render_update_disk |
Update disk. |
blueprints 6
Blueprints and Blueprint syncs.
| Tool | Description |
|---|---|
render_disconnect_blueprint |
Disconnect Blueprint. |
render_list_blueprint_syncs |
List Blueprint syncs. |
render_list_blueprints |
List Blueprints. |
render_retrieve_blueprint |
Retrieve Blueprint. |
render_update_blueprint |
Update Blueprint. |
render_validate_blueprint |
Validate Blueprint. Usage: Pass the `render.yaml` contents as text in `file` — a path is not read for you. Validate before render_update_blueprint, which syncs whatever is in the repository. |
network 5
Dedicated outbound IP sets.
| Tool | Description |
|---|---|
render_create_dedicated_ip |
Create dedicated IP set. |
render_delete_dedicated_ip |
Delete dedicated IP set. |
render_list_dedicated_ips |
List dedicated IPs. |
render_retrieve_dedicated_ip |
Retrieve dedicated IP set. |
render_update_dedicated_ip |
Update dedicated IP set. |
registry 5
Container registry credentials.
| Tool | Description |
|---|---|
render_create_registry_credential |
Create registry credential. |
render_delete_registry_credential |
Delete registry credential. |
render_list_registry_credentials |
List registry credentials. |
render_retrieve_registry_credential |
Retrieve registry credential. |
render_update_registry_credential |
Update registry credential. |
maintenance 4
Scheduled maintenance runs.
| Tool | Description |
|---|---|
render_list_maintenance |
List maintenance runs. |
render_retrieve_maintenance |
Retrieve maintenance run. |
render_trigger_maintenance |
Trigger maintenance run. |
render_update_maintenance |
Update maintenance run. |