Add disk. Attach a persistent disk to a web service, private service, or background worker. The service must be redeployed for the disk to be attached. Calls POST /disks on the Render Public API.

Add header rule. Add a response header rule to the service with the provided ID. Calls POST /services/{serviceId}/headers on the Render Public API.

Add or update secret file. 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. Calls PUT /services/{serviceId}/secret-files/{envVarKey} on the Render Public API.

Add resources to environment. Add resources to the environment with the provided ID. Calls POST /environments/{environmentId}/resources on the Render Public API.

Add redirect/rewrite rules. Add redirect/rewrite rules to the service with the provided ID. Calls POST /services/{serviceId}/routes on the Render Public API.

Update autoscaling config. Update the autoscaling config for the service with the provided ID. Calls PUT /services/{serviceId}/autoscaling on the Render Public API.

Cancel running cron job. Cancel a currently running cron job. Calls DELETE /cron-jobs/{cronJobId}/runs on the Render Public API.

Cancel deploy. Cancel an in-progress deploy for a service. Not supported for cron jobs. Calls POST /services/{serviceId}/deploys/{deployId}/cancel on the Render Public API.

Cancel running job. Cancel a particular one-off job for a particular service. Calls POST /services/{serviceId}/jobs/{jobId}/cancel on the Render Public API.

Cancel task run. Cancel a running task run with the provided ID. Calls DELETE /task-runs/{taskRunId} on the Render Public API.

Add custom domain. Add a custom domain to the service with the provided ID. Calls POST /services/{serviceId}/custom-domains on the Render Public API.

Create dedicated IP set. Create a dedicated IP set. Provisioning an IP set is asynchronous. The response returns immediately with status: CREATING and ips: []. When provisioning completes, status changes to RUNNING and ips contains your assigned addresses. If environmentIds is omitted or empty, this IP set applies to all services in the workspace in the selected region. Otherwise, it applies only to services in the listed environments in that region. Calls POST /dedicated-ips on the Render Public API.

Trigger deploy. Trigger a deploy for the service with the provided ID. Calls POST /services/{serviceId}/deploys on the Render Public API. 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.

Create environment group. Create a new environment group. Calls POST /env-groups on the Render Public API.

Create environment. Create a new environment belonging to the project with the provided ID. Calls POST /environments on the Render Public API.

Create job. Create a one-off job using the provided service. For details, see One-Off Jobs. Calls POST /services/{serviceId}/jobs on the Render Public API. 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.

Create Key Value instance. Create a new Key Value instance. Calls POST /key-value on the Render Public API. 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.

Create Postgres instance. Create a new Postgres instance. Calls POST /postgres on the Render Public API. 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.

Create Postgres export. Create an export of a Postgres instance by ID. Calls POST /postgres/{postgresId}/export on the Render Public API.

Create PostgreSQL User. Create a new PostgreSQL user for the Render Postgres instance with the provided ID. This becomes the database's new "default" user. Calls POST /postgres/{postgresId}/credentials on the Render Public API.

Create project. Create a new project. Calls POST /projects on the Render Public API.

[DEPRECATED by Render] Create Redis instance. Create a new Redis instance. This API is deprecated in favor of the Key Value API. Calls POST /redis on the Render Public API.

Create registry credential. Create a new registry credential. Calls POST /registrycredentials on the Render Public API.

Create service. Creates a new Render service in the specified workspace with the specified configuration. Calls POST /services on the Render Public API. 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. A private registry is referenced by registryCredentialId inside the top-level image, not inside serviceDetails — create the credential first with render_create_registry_credential. 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. 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-abc123","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"}}} Example — the same cron job from a prebuilt image, with no repo to build: {"type":"cron_job","name":"nightly-report","ownerId":"tea-abc123","image":{"ownerId":"tea-abc123","imagePath":"docker.io/acme/reports:latest"},"serviceDetails":{"runtime":"image","schedule":"0 3 * * *","plan":"starter","region":"oregon","envSpecificDetails":{"dockerCommand":"python report.py"}}} Example — a Node web service built from a repo: {"type":"web_service","name":"api","ownerId":"tea-abc123","repo":"https://github.com/acme/api","branch":"main","serviceDetails":{"runtime":"node","plan":"starter","region":"oregon","envSpecificDetails":{"buildCommand":"npm ci","startCommand":"node server.js"}}}

Run task. Kicks off a run of the workflow task with the provided ID, passing the provided input data. Calls POST /task-runs on the Render Public API.

Create a webhook. Create a new webhook. Calls POST /webhooks on the Render Public API.

Create a workflow. Create a new workflow service with the specified configuration. Calls POST /workflows on the Render Public API.

Deploy a workflow version. Creates and deploys a new version of a workflow. Calls POST /workflowversions on the Render Public API.

Delete autoscaling config. Delete the autoscaling config for a service given the service id. Calls DELETE /services/{serviceId}/autoscaling on the Render Public API.

Delete custom domain. Delete a custom domain for a service given the service id and custom domain id or name. Calls DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID} on the Render Public API.

Delete dedicated IP set. Delete the dedicated IP set with the provided ID. Calls DELETE /dedicated-ips/{dedicatedIpId} on the Render Public API.

Delete disk. 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. Calls DELETE /disks/{diskId} on the Render Public API.

Delete environment group. Delete the environment group with the provided ID, including all environment variables and secret files it contains. Calls DELETE /env-groups/{envGroupId} on the Render Public API.

Remove environment variable. Remove a particular environment variable from a particular environment group. Calls DELETE /env-groups/{envGroupId}/env-vars/{envVarKey} on the Render Public API.

Remove secret file. Remove a particular secret file from a particular environment group. Calls DELETE /env-groups/{envGroupId}/secret-files/{envVarKey} on the Render Public API.

Delete environment variable. 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. Calls DELETE /services/{serviceId}/env-vars/{envVarKey} on the Render Public API.

Delete environment. 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. Calls DELETE /environments/{environmentId} on the Render Public API.

Delete header rule. Delete a particular response header rule for a particular service. Calls DELETE /services/{serviceId}/headers/{headerId} on the Render Public API.

Delete Key Value instance. Delete a Key Value instance by ID. Calls DELETE /key-value/{redisId} on the Render Public API.

Delete log stream. Removes the log stream for the specified workspace. Calls DELETE /logs/streams/owner/{ownerId} on the Render Public API.

Delete metrics stream. Deletes the metrics stream for the specified workspace. Calls DELETE /metrics-stream/{ownerId} on the Render Public API.

Delete Postgres instance. Delete a Postgres instance by ID. This operation is irreversible, and all data will be lost. Calls DELETE /postgres/{postgresId} on the Render Public API.

Delete PostgreSQL User. Delete a PostgreSQL user from the Render Postgres instance with the provided ID. Calls DELETE /postgres/{postgresId}/credentials/{username} on the Render Public API.

Delete project. 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. Calls DELETE /projects/{projectId} on the Render Public API.

[DEPRECATED by Render] Delete Redis instance. Delete a Redis instance by ID. This API is deprecated in favor of the Key Value API. Calls DELETE /redis/{redisId} on the Render Public API.

Delete registry credential. Delete the registry credential with the provided ID. Calls DELETE /registrycredentials/{registryCredentialId} on the Render Public API.

Delete log stream override. Removes the log stream override for the specified resource. After deletion, the resource will use the workspace's default log stream setting. Calls DELETE /logs/streams/resource/{resourceId} on the Render Public API.

Delete redirect/rewrite rule. Delete a particular redirect/rewrite rule for a particular service. Calls DELETE /services/{serviceId}/routes/{routeId} on the Render Public API.

Delete secret file. 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. Calls DELETE /services/{serviceId}/secret-files/{envVarKey} on the Render Public API.

Delete service. Delete the service with the provided ID. Calls DELETE /services/{serviceId} on the Render Public API.

Delete a webhook. Delete the webhook with the provided ID. Calls DELETE /webhooks/{webhookId} on the Render Public API.

Delete workflow. Delete the workflow service with the provided ID. Calls DELETE /workflows/{workflowId} on the Render Public API.

Disconnect Blueprint. 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. Calls DELETE /blueprints/{blueprintId} on the Render Public API.

Failover Postgres instance. Failover a highly available Postgres instance. Calls POST /postgres/{postgresId}/failover on the Render Public API.

Resolves a service name — including a partial or approximate one — to a single Render service, returning its id plus close alternatives. Use this first whenever the user names a service instead of giving an id; every other service tool needs the id.

Get active connection count. Get the number of active connections for one or more Postgres databases or Redis instances. Calls GET /metrics/active-connections on the Render Public API.

Get bandwidth usage. Get bandwidth usage for one or more resources. Calls GET /metrics/bandwidth on the Render Public API.

Get bandwidth usage breakdown by traffic source. 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. Calls GET /metrics/bandwidth-sources on the Render Public API.

Get CPU usage. Get CPU usage for one or more resources. Calls GET /metrics/cpu on the Render Public API.

Get CPU limit. Get the CPU limit for one or more resources. Calls GET /metrics/cpu-limit on the Render Public API.

Get CPU target. Get CPU target for one or more resources. Calls GET /metrics/cpu-target on the Render Public API.

Get disk capacity. Get persistent disk capacity for one or more resources. Calls GET /metrics/disk-capacity on the Render Public API.

Get disk usage. Get persistent disk usage for one or more resources. Calls GET /metrics/disk-usage on the Render Public API.

List environment variables. List all environment variables for the service with the provided ID. Calls GET /services/{serviceId}/env-vars on the Render Public API.

Get HTTP latency. Get HTTP latency metrics for one or more resources. Calls GET /metrics/http-latency on the Render Public API.

Get HTTP request count. Get the HTTP request count for one or more resources. Calls GET /metrics/http-requests on the Render Public API.

Get instance count. Get the instance count for one or more resources. Calls GET /metrics/instance-count on the Render Public API.

Get memory usage. Get memory usage for one or more resources. Calls GET /metrics/memory on the Render Public API.

Get memory limit. Get the memory limit for one or more resources. Calls GET /metrics/memory-limit on the Render Public API.

Get memory target. Get memory target for one or more resources. Calls GET /metrics/memory-target on the Render Public API.

Retrieve log stream. Returns log stream information for the specified workspace. Calls GET /logs/streams/owner/{ownerId} on the Render Public API.

Retrieve metrics stream. Returns metrics stream information for the specified workspace. Calls GET /metrics-stream/{ownerId} on the Render Public API.

Get replica lag. Get seconds of replica lag of a Postgres replica. Calls GET /metrics/replication-lag on the Render Public API.

Retrieve log stream override. Returns log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream. Calls GET /logs/streams/resource/{resourceId} on the Render Public API.

Retrieve task. Retrieve the workflow task with the provided ID. Calls GET /tasks/{taskId} on the Render Public API.

Retrieve task run. Retrieve the workflow task run with the provided ID. Calls GET /task-runs/{taskRunId} on the Render Public API.

Get task runs completed count. Get the total number of task runs completed for one or more tasks. Optionally filter by state (succeeded/failed) or aggregate by state. Calls GET /metrics/task-runs-completed on the Render Public API.

Get task runs queued count. Get the total number of task runs queued for one or more tasks. Calls GET /metrics/task-runs-queued on the Render Public API.

Get the authenticated user. Retrieve the user associated with the provided API key. Calls GET /users on the Render Public API.

Retrieve workflow. Retrieve the workflow service with the provided ID. Calls GET /workflows/{workflowId} on the Render Public API.

Retrieve workflow version. Retrieve the specific workflow service version with the provided ID. Calls GET /workflowversions/{workflowVersionId} on the Render Public API.

Link service. Link a particular service to a particular environment group. The linked service will have access to the environment variables and secret files in the group. Calls POST /env-groups/{envGroupId}/services/{serviceId} on the Render Public API.

List queryable instance values. List instance values to filter by for one or more resources. Calls GET /metrics/filters/application on the Render Public API.

List Blueprint syncs. List syncs for the Blueprint with the provided ID. Calls GET /blueprints/{blueprintId}/syncs on the Render Public API.

List Blueprints. List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has access to. Calls GET /blueprints on the Render Public API.

List custom domains. 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. Calls GET /services/{serviceId}/custom-domains on the Render Public API.

List dedicated IPs. List dedicated IP sets for a workspace. Calls GET /dedicated-ips on the Render Public API.

List deploys. List deploys matching the provided filters. If no filters are provided, all deploys for the service are returned. Calls GET /services/{serviceId}/deploys on the Render Public API.

List disks. List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view. Calls GET /disks on the Render Public API.

List environment groups. List environment groups matching the provided filters. If no filters are provided, all environment groups are returned. Calls GET /env-groups on the Render Public API.

List environments. List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned. Calls GET /environments on the Render Public API.

List events. List recent events that occurred for the service with the provided ID. Calls GET /services/{serviceId}/events on the Render Public API.

List header rules. 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. Calls GET /services/{serviceId}/headers on the Render Public API.

List queryable status codes and host values. List status codes and host values to filter by for one or more resources. Calls GET /metrics/filters/http on the Render Public API.

List instances. List instances for the provided service. Calls GET /services/{serviceId}/instances on the Render Public API.

List jobs. List jobs for the provided service that match the provided filters. If no filters are provided, all jobs for the service are returned. Calls GET /services/{serviceId}/jobs on the Render Public API.

List Key Value instances. List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are returned. Calls GET /key-value on the Render Public API.

List logs. 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 belong to the same owner. Calls GET /logs on the Render Public API. 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.

List log label values. List all values for a given log label in the logs matching the provided filters. Calls GET /logs/values on the Render Public API.

List maintenance runs. List scheduled and/or recent maintenance runs for specified resources. Calls GET /maintenance on the Render Public API.