API Keys
Grant fine-grained access to a workspace's resources.
All requests to the Render API must authenticate using an API key. API keys limit access to resources within a specific workspace, so you can grant each key only the permissions it needs.
If your workspace belongs to an organization, you can also create audit log API keys to read audit logs for your org and all of its workspaces.
Setup
1. Create an API key
-
Go to your Account Settings page in the Render Dashboard and click Create API key.

-
Give your key a name.
-
Select the workspace your key can access.
-
Grant your key permissions. For details, see Permissions.
-
You can also set permissions for all workspace resources at once:

- 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.
-
-
Click Generate API key. Your key is shown in full only once:

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.
Change key permissions
To change an existing key's permissions:
-
Go to your Account Settings page in the Render Dashboard and scroll down to the API Keys section.
-
Click the gear icon next to the key you want to update:

-
Change your key's permissions, then click Save changes.
Revoke an API key
Revoking an API key takes effect immediately.
If you're still using the key, replace it before revoking it.
To revoke an API key:
-
Go to your Account Settings page in the Render Dashboard and scroll down to the API Keys section.
-
Click the trashcan icon next to the key you want to revoke:

-
Follow the on-screen instructions to confirm.
Permissions
Your member role in the selected workspace determines which permissions you can grant an API key.
The following tables list the permissions you can grant a key for each resource type.
Services
| Permission | Action | Read | Write | Read & write |
|---|---|---|---|---|
|
Web and private services, static sites, background workers, and cron jobs |
View services and their configuration | 🟢 | ➖ | 🟢 |
|
Create, update, and delete services | ❌ | ➖ | 🟢 | |
|
Manage preview environments and one-off jobs | ❌ | ➖ | 🟢 | |
|
Environment variables and secret files |
View environment variables and secret files | 🟢 | ❌ | 🟢 |
|
Set environment variable and secret file values | ❌ | 🟢 | 🟢 |
Workflows
| Permission | Action | Read | Write | Read & write | Run |
|---|---|---|---|---|---|
|
Workflows |
View workflows, versions, and task-run inputs and results | 🟢 | ➖ | 🟢 | ➖ |
|
Create, update, and delete workflows, and create versions | ❌ | ➖ | 🟢 | ➖ | |
|
Workflow secrets |
View workflow environment variables and secret files | 🟢 | ❌ | 🟢 | ➖ |
|
Set workflow environment variable and secret file values | ❌ | 🟢 | 🟢 | ➖ | |
|
Run workflow tasks |
Trigger and cancel task runs and flow runs | ➖ | ➖ | ➖ | 🟢 |
Sandboxes
Render Sandboxes is in public beta.
APIs, defaults, and limits might change during the beta period.
| Permission | Action | Read | Write | Read & write | Execute |
|---|---|---|---|---|---|
|
Sandbox lifecycle and snapshots |
View sandboxes, sandbox groups, and snapshots | 🟢 | ➖ | 🟢 | ➖ |
|
View execution history and credential settings | 🟢 | ➖ | 🟢 | ➖ | |
|
Create and terminate sandboxes | ❌ | ➖ | 🟢 | ➖ | |
|
Create, update, and delete sandbox groups | ❌ | ➖ | 🟢 | ➖ | |
|
Create and delete snapshots | ❌ | ➖ | 🟢 | ➖ | |
|
Sandbox execution and file transfer |
Run commands in sandboxes | ➖ | ➖ | ➖ | 🟢 |
|
Upload and download files | ➖ | ➖ | ➖ | 🟢 | |
|
Manage sandbox credentials |
Create, update, and delete credentials | ➖ | 🟢 | ➖ | ➖ |
Deploys
| Permission | Action | Read | Run |
|---|---|---|---|
|
Deployment information |
View deploys, their status, and history | 🟢 | 🟢 |
|
Run deployments |
Trigger and cancel deploys | ❌ | 🟢 |
|
Trigger rollbacks | ❌ | 🟢 |
Monitoring
| Permission | Action | Read |
|---|---|---|
|
Read resource logs, metrics, events, and export settings |
View service events | 🟢 |
|
View service metrics | 🟢 | |
|
View service logs | 🟢 | |
|
View log forwarding and metrics stream settings | 🟢 |
Postgres
| Permission | Action | Read | Write | Read & write |
|---|---|---|---|---|
|
Postgres instances |
View databases and their configuration | 🟢 | ➖ | 🟢 |
|
Create, update, and delete databases | ❌ | ➖ | 🟢 | |
|
Postgres credentials and connection details |
View connection strings and credentials | 🟢 | ❌ | 🟢 |
|
Create and delete database credentials | ❌ | 🟢 | 🟢 | |
|
Postgres exports and backups |
View and download exports and backups | 🟢 | ➖ | 🟢 |
|
Create exports and backups | ❌ | ➖ | 🟢 |
Key Value
| Permission | Action | Read | Read & write |
|---|---|---|---|
|
Key Value instances |
View instances and their configuration | 🟢 | 🟢 |
|
Create, update, and delete instances | ❌ | 🟢 | |
|
Read Key Value connection details |
View connection URLs and credentials | 🟢 | ➖ |
Object storage
Object storage is in early access.
During this period, object storage is continuing to evolve and might introduce breaking changes.
| Permission | Action | Read | Read & write |
|---|---|---|---|
|
Objects and blobs |
View and download objects | 🟢 | 🟢 |
|
Upload and delete objects | ❌ | 🟢 |
Build sources
Build reuse is in limited early access.
During this period, build reuse is continuing to evolve and might introduce breaking changes.
| Permission | Action | Read | Write | Read & write |
|---|---|---|---|---|
|
Build sources and builds |
View build sources, their configuration, and their builds | 🟢 | ➖ | 🟢 |
|
Create, update, and delete build sources | ❌ | ➖ | 🟢 | |
|
Trigger builds | ❌ | ➖ | 🟢 | |
|
Build-source environment variables and secret files |
View build-source environment variables and secret files | 🟢 | ❌ | 🟢 |
|
Set build-source environment variable and secret file values | ❌ | 🟢 | 🟢 |
Workspaces
| Permission | Action | Read | Read & write |
|---|---|---|---|
|
Members, notifications, webhooks, and log and metric streams |
View workspace members | 🟢 | 🟢 |
| 🟢 | 🟢 | ||
|
View webhooks | 🟢 | 🟢 | |
|
View log and metric stream settings | 🟢 | 🟢 | |
|
Update member roles and remove members | ❌ | 🟢 | |
|
Update notification settings | ❌ | 🟢 | |
|
Create, update, and delete webhooks | ❌ | 🟢 | |
|
Update log and metric stream settings | ❌ | 🟢 |
Projects
| Permission | Action | Read | Read & write |
|---|---|---|---|
|
Projects and environments |
View projects and environments | 🟢 | 🟢 |
|
Create, update, and delete projects and environments | ❌ | 🟢 | |
|
Move resources into or out of an environment | ❌ | 🟢 | |
|
Configure protected environments and cross-environment traffic blocking | ❌ | 🟢 |
Environment groups
| Permission | Action | Read | Write | Read & write |
|---|---|---|---|---|
|
Environment groups |
View environment groups | 🟢 | ➖ | 🟢 |
|
Create, update, and delete environment groups | ❌ | ➖ | 🟢 | |
|
Environment group variables and secret files |
View environment group variable and secret file values | 🟢 | ❌ | 🟢 |
|
Set environment group variable and secret file values | ❌ | 🟢 | 🟢 |
Blueprints
| Permission | Action | Read | Read & write |
|---|---|---|---|
|
Blueprints |
View Blueprint configuration | 🟢 | 🟢 |
|
Update and disconnect Blueprints | ❌ | 🟢 |
Audit logs
Want to view audit logs for every workspace in your org?
Create an audit log API key.
| Permission | Read |
|---|---|
|
Read workspace audit logs | 🟢 |
Audit log API keys
Audit log API keys have read-only access to audit logs for your organization and all of its workspaces.
Org Owners can create an audit log API key by doing the following:
-
In the Render Dashboard, open the workspace dropdown at the top of the left pane and select your org.
-
Click Settings in the left pane and scroll down to the Logs section.
-
Under Audit Log API Keys, click Create API key:

-
Copy your new key. It's shown in full only once.
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.
FAQ
What happens to my classic API keys?
They continue to work as usual. API keys you created before Render rolled out scoped API keys are called classic keys:

They have the same permissions as your member role in every workspace you belong to.
To follow the principle of least privilege, we recommend replacing your classic keys with scoped API keys.
Can scoped API keys access multiple workspaces?
No. Each scoped API key can only access the workspace you create it in.
What happens to an API key if my member role changes?
Your key's access adjusts to match your new member role.