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
  • Key Value
    • List Key Value instancesget
    • Create Key Value instancepost
    • Retrieve Key Value instanceget
    • Retrieve Key Value connection infoget
    • Update Key Value instancepatch
    • Delete Key Value instancedel
    • Suspend Key Value instancepost
    • Resume Key Value instancepost
  • Disks
    • List disksget
    • Add diskpost
    • Retrieve diskget
    • Update diskpatch
    • Delete diskdel
    • List snapshotsget
    • Restore snapshotpost

Infra Management

  • Blueprints
    • List Blueprintsget
    • Validate Blueprintpost
    • Retrieve Blueprintget
    • Update Blueprintpatch
    • Disconnect Blueprintdel
    • List Blueprint syncsget
  • Dedicated IPs
    • List dedicated IPsget
    • Create dedicated IP setpost
    • Retrieve dedicated IP setget
    • Update dedicated IP setpatch
    • Delete dedicated IP setdel
  • Environment Groups
    • List environment groupsget
    • Create environment grouppost
    • Retrieve environment groupget
    • Update environment grouppatch
    • Delete environment groupdel
    • Link servicepost
    • Unlink servicedel
    • Retrieve environment variableget
    • Add or update environment variableput
    • Remove environment variabledel
    • Retrieve secret fileget
    • Add or update secret fileput
    • Remove secret filedel
  • Maintenance
    • List maintenance runsget
    • Retrieve maintenance runget
    • Update maintenance runpatch
    • Trigger maintenance runpost
  • Projects & Environments
    • List projectsget
    • Create projectpost
    • Retrieve Projectget
    • Update projectpatch
    • Delete projectdel
    • Create environmentpost
    • List environmentsget
    • Retrieve environmentget
    • Update environmentpatch
    • Delete environmentdel
    • Add resources to environmentpost
    • Remove resources from environmentdel
  • Registry Credentials
    • List registry credentialsget
    • Create registry credentialpost
    • Retrieve registry credentialget
    • Update registry credentialpatch
    • Delete registry credentialdel

Monitoring

  • Logs
    • List logsget
    • Subscribe to new logsget
    • List log label valuesget
    • Retrieve log streamget
    • Update log streamput
    • Delete log streamdel
    • List log stream overridesget
    • Retrieve log stream overrideget
    • Update log stream overrideput
    • Delete log stream overridedel
  • Metrics
    • Retrieve metrics streamget
    • Create or update metrics streamput
    • Delete metrics streamdel
    • Get CPU usageget
    • Get CPU limitget
    • Get CPU targetget
    • Get memory usageget
    • Get memory limitget
    • Get memory targetget
    • Get HTTP request countget
    • Get HTTP latencyget
    • Get bandwidth usageget
    • Get disk usageget
    • Get bandwidth usage breakdown by traffic sourceget
    • Get disk capacityget
    • Get instance countget
    • Get active connection countget
    • Get replica lagget
    • List queryable instance valuesget
    • List queryable status codes and host valuesget
    • List queryable pathsget
    • Get task runs queued countget
    • Get task runs completed countget

Notifications

  • Events
    • Retrieve eventget
  • Notification Settings
    • Retrieve notification settingsget
    • Update notification settingspatch
    • List notification overridesget
    • Retrieve notification override