Render API

Service · Implementation & integration · Engineering & development by Render

Manage your Render infrastructure programmatically.

A public REST API for developers to programmatically manage Render services, databases, and workflows. It enables automated deployments and custom infrastructure tooling through a standard OpenAPI-compliant interface.

Launched
2022-02-01

Category: API Management

Delivery
Online REST API
Protocol
REST
Specification
OpenAPI 3.0
Authentication
API Key
Response Format
JSON
Base URL
https://api.render.com/v1
  • RESTful interface for programmatic infrastructure management
  • OpenAPI 3.0 specification for custom client generation
  • Supports all service types, databases, and workflows
  • Interactive documentation with multi-language examples

Overview

The Render API is a public REST interface that allows developers and businesses to manage their cloud infrastructure programmatically. It solves the problem of manual infrastructure management by enabling teams to integrate Render's capabilities directly into their own scripts, CI/CD pipelines, and internal tools. The API supports nearly all functionality available in the Render Dashboard, including the management of web services, private services, Postgres databases, and Key Value stores. Developers can also use it to orchestrate Render Workflows, manage service deploys, and retrieve real-time metrics and logs. By providing an OpenAPI 3.0 specification and interactive documentation, Render ensures that teams can quickly build multi-tenant platforms or automated governance tools.

Core Management Capabilities

  • RESTful Infrastructure Management: The RESTful interface allows developers to create or update sites, apps, and databases with standard HTTP requests.
  • Service Orchestration: Developers can manage all service types including web services, private services, and background workers programmatically.
  • Managed Datastore Control: The API provides endpoints to provision and manage Render Postgres and Key Value datastores.
  • Workflow Automation: Teams can manage Render Workflows, including defining tasks and triggering runs, through the API.
  • Deployment Operations: The API supports managing service deploys, rollbacks, and one-off jobs without using the dashboard.

Developer Experience and Tooling

  • OpenAPI 3.0 Specification: The API is described by an OpenAPI 3.0 specification available in JSON format for generating custom clients.
  • Interactive Reference: An interactive API reference provides example usage in multiple programming languages for rapid integration.
  • Observability and Monitoring: Developers can retrieve real-time metrics and logs for services programmatically for custom observability tools.
  • Configuration and Governances: The API supports managing environment groups, custom domains, and projects to maintain infrastructure as code.

What's included

  • Service management, database provisioning, workflow orchestration, deploy management, metrics and logs access, audit log retrieval

How it works

  • Create an API key in the Render Dashboard, authenticate requests via the Authorization header, and call endpoints using the RESTful interface.

Use cases

  • DevOps teams automate service provisioning and deployment pipelines within their existing CI/CD workflows.
  • Software companies build multi-tenant cloud platforms by programmatically spinning up isolated environments for their own customers.
  • Engineers create custom internal dashboards by retrieving real-time metrics and logs directly from the Render API.
  • Infrastructure teams manage complex multi-service architectures using scripts to update environment variables and custom domains.

Specifications

Delivery
Online REST API
Prerequisites
A Render account and an API key generated from Account Settings
Protocol
REST
Specification
OpenAPI 3.0
Authentication
API Key
Response Format
JSON
Base URL
https://api.render.com/v1

How it works

  1. Create an API Key: Generate a secret API key from the Account Settings page in the Render Dashboard to authenticate your requests.
  2. Explore Endpoints: Use the interactive API reference or the OpenAPI 3.0 spec to identify the endpoints needed for your scripts or pipelines.
  3. Integrate and Automate: Send HTTP requests to the API using your key in the authorization header to manage services, databases, or retrieve logs.

FAQ

How do I authenticate with the Render API?

All Render API requests require authentication via an API key, which is managed from the Account Settings page in the Render Dashboard.

Is there an OpenAPI specification available?

Yes, Render provides an OpenAPI 3.0 specification in JSON format that can be used to generate custom clients and integrate with other tooling.

What resources can I manage through the API?

The API supports managing all service types, Postgres and Key Value datastores, workflows, deploys, environment groups, blueprints, metrics, logs, and audit logs.

How can I revoke an API key if it is compromised?

You can revoke an API key immediately from the Account Settings page by clicking the menu for the specific key and selecting Revoke.

Open the API reference

Added by AntSpace from public sources (render.com).

Related

More services by Render