For AI agents: visit https://api-docs.render.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Render API
OpenAPI specAPI Reference
Render API
API Reference
OpenAPI specAPI Reference

API Overview

  • Introduction
    • Authentication
    • Pagination
    • Filtering Results
    • Rate Limiting
    • PATCH Requests

Compute

  • Deploys
    • List deploysget
    • Trigger deploypost
    • Retrieve deployget
    • Cancel deploypost
    • Roll back deploypost
  • Services
    • Service object fields
    • List servicesget
    • Create servicepost
    • Retrieve serviceget
    • Update servicepatch
    • Delete servicedel
    • Purge Web Service Cachepost
    • List eventsget
    • Suspend servicepost
    • Resume servicepost
    • Restart servicepost
    • List instancesget
    • Retrieve service outbound IPsget
    • Create service preview (image-backed)post
    • Scaling
      • Scale instance countpost
      • Update autoscaling configput
      • Delete autoscaling configdel
  • Workflows
    • List workflowsget
    • Create a workflowpost
    • Retrieve workflowget
    • Update workflowpatch
    • Delete workflowdel
    • List workflow versionsget
    • Deploy a workflow versionpost
    • Retrieve workflow versionget
    • Tasks & Runs
      • List tasksget
      • Retrieve taskget
      • List task runsget
      • Run taskpost
      • Retrieve task runget
      • Cancel task rundel
      • Stream realtime events (SSE)get
  • Cron Jobs
    • Trigger cron job runpost
    • Cancel running cron jobdel
  • Env Vars / Secrets
    • List environment variablesget
    • Retrieve environment variableget
    • Add or update environment variableput
    • Update environment variablesput
    • Delete environment variabledel
    • List secret filesget
    • Retrieve secret fileget
    • Add or update secret fileput
    • Update secret filesput
    • Delete secret filedel
  • Custom Domains
    • List custom domainsget
    • Add custom domainpost
    • Retrieve custom domainget
    • Delete custom domaindel
    • Verify DNS configurationpost
  • One-Off Jobs
    • List jobsget
    • Create jobpost
    • Retrieve jobget
    • Cancel running jobpost

Static Sites

  • Response Headers
    • List header rulesget
    • Add header rulepost
    • Replace header rulesput
    • Delete header ruledel
  • Redirects & Rewrites
    • List redirect/rewrite rulesget
    • Add redirect/rewrite rulespost
    • Update redirect/rewrite rule prioritypatch
    • Update redirect/rewrite rulesput
    • Delete redirect/rewrite ruledel

Datastores

  • Postgres
    • List Postgres instancesget
    • Create Postgres instancepost
    • Retrieve Postgres instanceget
    • Update Postgres instancepatch
    • Delete Postgres instancedel
    • Retrieve Postgres connection infoget
    • Retrieve point-in-time recovery statusget
    • Trigger point-in-time recoverypost
    • Suspend Postgres instancepost
    • Resume Postgres instancepost
    • Restart Postgres instancepost
    • Failover Postgres instancepost
    • Database exports
      • List Postgres exportsget
      • Create Postgres exportpost
    • Database metrics
      • List live queriesget
      • List database, table, and index sizesget
      • List table scansget
      • List top queriesget
    • PostgreSQL Users
      • List PostgreSQL Usersget
      • Create PostgreSQL Userpost
      • Delete PostgreSQL Userdel