• Docs
  • Changelog
Sign in
Get started
    • Home
    • Your first deploy
    • Free instances
    • Platform features by plan
    • Use with coding agents
    • FAQ
    • Templates
      • Migrate from…
        • Heroku
        • Railway
    • Compute plans
    • SandboxesBeta
      • Service types
        • Which to use?
        • Static sites
        • Web services
        • Private services
        • Background workers
        • Cron jobs
        • Workflows
        • Multi-service architectures
      • Data storage
        • Render Postgres
        • Render Key Value (Redis®-compatible)
        • Persistent disks
    • How deploys work
    • Supported languages
    • Git providers (GitHub, etc.)
    • Build pipeline
    • Deploy hooks
    • Monorepo support
    • Troubleshooting deploys
      • Previewing changes
        • Single-service previews
        • Preview environments (multi-service)
      • Docker deploys
        • Overview
        • Deploy a registered image
        • Using secrets
      • Runtime
        • Native runtimes
        • Environment variables & secrets
        • Default environment variables
    • Intro to sandboxes
    • Limits & pricing
      • How to…
        • Create & configure sandboxes
        • Execute commands
        • Upload and download files
        • Manage snapshots
      • Use with…
        • Claude Managed Agents
        • Cursor Cloud Agents
        • OpenAI Agents API
      • SDK/CLI reference
        • TypeScript SDK
        • Python SDK
        • CLI commands
    • Intro to workflows
    • Tutorial
    • Limits & pricing
      • How to…
        • Define tasks
        • Define flowsNew
        • Trigger runs
        • Develop locally
      • SDK reference
        • TypeScript SDK
        • Python SDK
      • Example workflows
        • TypeScript examples
        • Python examples
    • Overview
    • Create & connect
    • Database credentials
    • Extensions
    • Version upgrades
    • Logical replication
    • Legacy instance types
      • Database recovery
        • Recovery & backups
        • High availability
      • Database performance
        • Read replicas
        • Connection pooling
        • Admin apps
        • Repacking tables
        • Troubleshooting performance
    • Regions
    • Inbound IP rules
    • Edge caching
    • WebSockets
    • TLS certificates
      • Custom domains
        • Overview
        • Cloudflare
        • Namecheap
        • Other DNS providers
      • Internal traffic
        • Private network
        • Private links
      • Outbound traffic
        • Default IP ranges
        • Dedicated IP addresses
        • Outbound bandwidth
        • Handling network changes
      • Static site config
        • Custom response headers
        • Redirects & rewrites
    • The Render Dashboard
    • SSH / Shell access
    • Projects & environments
      • Service actions
        • Scaling
        • Rollbacks
        • Maintenance mode
        • One-off jobs
      • Infrastructure as code
        • Blueprints overview
        • render.yaml reference
        • Terraform provider
    • In-dashboard metrics
    • Health checks
    • Uptime best practices
      • Logging
        • In-dashboard logs
        • Log streams (syslog/HTTPS)
      • OpenTelemetry (OTel) metrics
        • Provider setup
        • Metrics reference
      • Notifications
        • Webhooks
        • Email / Slack
    • MCP Server
      • Render CLI
        • Overview
        • Command reference
      • REST API
        • Overview
        • API keys
        • API reference
      • Third-party connections
        • OIDC support
        • Datadog
    • Workspaces, members, & roles
    • Login settings
    • Audit logs
      • Organizations
        • Overview
        • SAML SSO
    • DDoS protection
    • Platform maintenance
      • Compliance
        • Overview
        • HIPAA (US health data)
        • HIPAA best practices
        • Shared responsibility model
        • Pentest policy
    • Heroku vs Render
    • Vercel vs Render

The Render API

Manage your Render infrastructure programmatically.

Open the API reference

Render provides a public REST API for managing your services and other resources programmatically.

The API supports almost all of the same functionality available in the Render Dashboard. Among other capabilities, it provides endpoints for managing:

  • All service types (web services, private services, and so on)
  • Managed datastores (Render Postgres and Key Value)
  • Render Workflows (including tasks and runs)
  • Service deploys
  • Environment groups
  • Blueprints
  • Metrics and logs
  • Projects and environments
  • Custom domains
  • One-off jobs
  • Audit logs
  • Additional account settings

To request new API functionality, please submit a feature request.

Setup

1. Create an API key

All Render API requests require an API key.

  1. Go to your Account Settings page in the Render Dashboard and click Create API key.

    The API Keys page in the Render Dashboard

  2. Give your key a name.

  3. Select the workspace your key can access.

  4. Grant your key permissions. For details, see Permissions.

    • You can also set permissions for all workspace resources at once:

      Buttons to change the permissions for all resource types at once in the API key creation form

      • All: Grants every permission your member role allows for every resource.
      • Read only: Grants Read access to every applicable resource.
      • Clear all: Removes all permissions from the key.
  5. Click Generate API key. Your key is shown in full only once:

    The API key created dialog showing the new key with a button to copy it

API keys are secret credentials!

Don't publicly post your API key, commit it to version control, or otherwise share it with anyone outside your organization. If you believe an API key has been compromised, revoke it.

2. Make your first request

To test your key, call a Render API endpoint it has permission to access.

For example, a key with Read access to services can call the List services endpoint. Replace {API_KEY} with your key and run the following:

If your API key is valid, the request returns a 200 response and an array of services.

For details on managing keys and their permissions, see API keys.

API reference

Open the API reference for a comprehensive list of supported endpoints. The reference is interactive, and it provides example usage in multiple programming languages.

API reference page

OpenAPI spec

The Render API is described by an OpenAPI 3.0 spec. The spec is available in JSON format at the following URL:

You can use this spec to generate custom clients and with other tooling.

Render's OpenAPI spec is subject to change.

The API itself will maintain backward compatibility, but details of the describing spec (such as names for endpoints and tags) might change over time. This might affect custom clients or other tools that rely on the spec.

The Render API
  • Setup
    • 1. Create an API key
    • 2. Make your first request
  • API reference
  • OpenAPI spec
All Systems Operational
© Render Inc. All rights reserved.