Render
Render is a cloud platform for building and running applications and websites with automatic Git-based deployments. It provides managed infrastructure for web services, static sites, background workers, cron jobs, private services, PostgreSQL databases, Redis/Key-Value stores, and persistent disks. The Render API enables programmatic control of all platform resources including service deployments, scaling, environment configuration, custom domains, blueprints, logging, metrics, and workflow automation.
APIs
Render API
The Render Public API enables full programmatic management of Render services, databases, and infrastructure. It supports deploying web services, static sites, background worker...
Collections
Render Public API
OPENGraphQL
Pricing Plans
Rate Limits
FinOps
Render Finops
FINOPSFeatures
Event Specifications
Render Webhooks
AsyncAPI 2.6 description of Render's outbound webhook surface. Render delivers event notifications by issuing HTTP POST requests with a JSON body to a subscriber URL configured ...
ASYNCAPISemantic Vocabularies
API Governance Rules
JSON Structure
Example Payloads
Resources
Sources
opencollection: 1.0.0
info:
name: Render Public API
version: 1.0.0
request:
auth:
type: bearer
token: '{{bearerToken}}'
items:
- info:
name: Blueprints
type: folder
items:
- info:
name: List Blueprints
type: http
http:
method: GET
url: https://api.render.com/v1/blueprints
params:
- name: ownerId
value: ''
type: query
description: The ID of the workspaces to return resources for
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key
has access to.
'
- info:
name: Validate Blueprint
type: http
http:
method: POST
url: https://api.render.com/v1/blueprints/validate
body:
type: multipart-form
data:
- name: ownerId
type: text
value: ''
- name: file
type: text
value: ''
docs: 'Validate a `render.yaml` Blueprint file without creating or modifying any resources. This endpoint checks the syntax
and structure of the Blueprint, validates that all required fields are present, and returns a plan indicating the resources
that would be created.
Requests to this endpoint use `Content-Type: multipart/form-data`. The provided Blueprint file cannot exceed 10MB in
size.
'
- info:
name: Retrieve Blueprint
type: http
http:
method: GET
url: https://api.render.com/v1/blueprints/:blueprintId
params:
- name: blueprintId
value: ''
type: path
description: The ID of the Blueprint
docs: 'Retrieve the Blueprint with the provided ID.
'
- info:
name: Update Blueprint
type: http
http:
method: PATCH
url: https://api.render.com/v1/blueprints/:blueprintId
params:
- name: blueprintId
value: ''
type: path
description: The ID of the Blueprint
body:
type: json
data: '{}'
docs: 'Update the Blueprint with the provided ID.
'
- info:
name: Disconnect Blueprint
type: http
http:
method: DELETE
url: https://api.render.com/v1/blueprints/:blueprintId
params:
- name: blueprintId
value: ''
type: path
description: The ID of the Blueprint
docs: 'Disconnect the Blueprint with the provided ID.
Disconnecting a Blueprint stops automatic resource syncing via the associated `render.yaml` file. It does not _delete_
any services or other resources that were managed by the blueprint.
'
- info:
name: List Blueprint syncs
type: http
http:
method: GET
url: https://api.render.com/v1/blueprints/:blueprintId/syncs
params:
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List syncs for the Blueprint with the provided ID.
'
- info:
name: Workspaces
type: folder
items:
- info:
name: Update workspace member role
type: http
http:
method: PATCH
url: https://api.render.com/v1/owners/:ownerId/members/:userId
params:
- name: ownerId
value: ''
type: path
description: The ID of the workspace to return resources for
- name: userId
value: ''
type: path
description: The ID of the user (Render object ID with a `usr-` prefix).
body:
type: json
data: '{}'
docs: 'Update the role of an existing workspace member.
'
- info:
name: Remove workspace member
type: http
http:
method: DELETE
url: https://api.render.com/v1/owners/:ownerId/members/:userId
params:
- name: ownerId
value: ''
type: path
description: The ID of the workspace to return resources for
- name: userId
value: ''
type: path
description: The ID of the user (Render object ID with a `usr-` prefix).
docs: 'Remove a user from the specified workspace.
'
- info:
name: List workspaces
type: http
http:
method: GET
url: https://api.render.com/v1/owners
params:
- name: name
value: ''
type: query
description: Only return workspaces with one of the provided names. Only exact matches are returned.
- name: email
value: ''
type: query
description: Only return workspaces owned by one of the provided email addresses.
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List the workspaces that your API key has access to, optionally filtered by name or owner email address.
'
- info:
name: Retrieve workspace
type: http
http:
method: GET
url: https://api.render.com/v1/owners/:ownerId
params:
- name: ownerId
value: ''
type: path
description: The ID of the user or team
docs: 'Retrieve the workspace with the provided ID.
Workspace IDs start with `tea-`. If you provide a user ID (starts with `own-`), this endpoint returns the user''s default
workspace.
'
- info:
name: List workspace members
type: http
http:
method: GET
url: https://api.render.com/v1/owners/:ownerId/members
params:
- name: ownerId
value: ''
type: path
description: The ID of the team
docs: 'Retrieves the list of users belonging to the workspace with the provided ID.
'
- info:
name: Disks
type: folder
items:
- info:
name: List disks
type: http
http:
method: GET
url: https://api.render.com/v1/disks
params:
- name: ownerId
value: ''
type: query
description: The ID of the workspaces to return resources for
- name: diskId
value: ''
type: query
description: Filter by disk IDs
- name: name
value: ''
type: query
description: Filter by name
- name: createdBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
- name: createdAfter
value: '2021-02-17T08:15:30Z'
type: query
description: Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
- name: updatedBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
- name: updatedAfter
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
- name: serviceId
value: ''
type: query
description: Filter for resources by service ID
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions
to view.
'
- info:
name: Add disk
type: http
http:
method: POST
url: https://api.render.com/v1/disks
body:
type: json
data: '{}'
docs: 'Attach a persistent disk to a web service, private service, or background worker.
The service must be redeployed for the disk to be attached.
'
- info:
name: Retrieve disk
type: http
http:
method: GET
url: https://api.render.com/v1/disks/:diskId
params:
- name: diskId
value: ''
type: path
description: The ID of the disk
docs: 'Retrieve the persistent disk with the provided ID.
'
- info:
name: Update disk
type: http
http:
method: PATCH
url: https://api.render.com/v1/disks/:diskId
params:
- name: diskId
value: ''
type: path
description: The ID of the disk
body:
type: json
data: '{}'
docs: 'Update the persistent disk with the provided ID.
The disk''s associated service must be deployed and active for updates to take effect.
When resizing a disk, the new size must be greater than the current size.
'
- info:
name: Delete disk
type: http
http:
method: DELETE
url: https://api.render.com/v1/disks/:diskId
params:
- name: diskId
value: ''
type: path
description: The ID of the disk
docs: 'Delete a persistent disk attached to a service.
**All data on the disk will be lost.** The disk''s associated service will immediately lose access to it.
'
- info:
name: List snapshots
type: http
http:
method: GET
url: https://api.render.com/v1/disks/:diskId/snapshots
params:
- name: diskId
value: ''
type: path
description: The ID of the disk
docs: 'List snapshots for the persistent disk with the provided ID. Each snapshot is a point-in-time copy of the disk''s
data.
'
- info:
name: Restore snapshot
type: http
http:
method: POST
url: https://api.render.com/v1/disks/:diskId/snapshots/restore
params:
- name: diskId
value: ''
type: path
description: The ID of the disk
body:
type: json
data: '{}'
docs: 'Restore a persistent disk to an available snapshot.
**This operation is irreversible.** It will overwrite the current disk data. It might also trigger a service deploy.
Snapshot keys returned from the [List snapshots](https://api-docs.render.com/reference/list-snapshots) endpoint expire
after 24 hours. If a snapshot key has expired, query the endpoint again for a new key.
'
- info:
name: Users
type: folder
items:
- info:
name: Get the authenticated user
type: http
http:
method: GET
url: https://api.render.com/v1/users
docs: 'Retrieve the user associated with the provided API key.
'
- info:
name: Audit Logs
type: folder
items:
- info:
name: List workspace audit logs
type: http
http:
method: GET
url: https://api.render.com/v1/owners/:ownerId/audit-logs
params:
- name: ownerId
value: ''
type: path
description: The ID of the workspace to return resources for
- name: startTime
value: ''
type: query
description: Start time for filtering audit logs (ISO 8601 format)
- name: endTime
value: ''
type: query
description: End time for filtering audit logs (ISO 8601 format)
- name: direction
value: ''
type: query
description: 'The direction to query logs for. Backward will return most recent logs first.
Forward will start with the oldest logs in the time range.
'
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'Retrieve audit logs for a specific workspace with optional filtering and pagination.
'
- info:
name: List organization audit logs
type: http
http:
method: GET
url: https://api.render.com/v1/organizations/:orgId/audit-logs
params:
- name: orgId
value: ''
type: path
description: The unique identifier of the organization
- name: startTime
value: ''
type: query
description: Start time for filtering audit logs (ISO 8601 format)
- name: endTime
value: ''
type: query
description: End time for filtering audit logs (ISO 8601 format)
- name: direction
value: ''
type: query
description: 'The direction to query logs for. Backward will return most recent logs first.
Forward will start with the oldest logs in the time range.
'
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'Retrieve audit logs for a specific organization with optional filtering and pagination.
'
- info:
name: Notification Settings
type: folder
items:
- info:
name: Retrieve notification settings
type: http
http:
method: GET
url: https://api.render.com/v1/notification-settings/owners/:ownerId
params:
- name: ownerId
value: ''
type: path
description: The ID of the workspace to return resources for
docs: 'Retrieve notification settings for the owner with the provided ID.
Note that you provide an owner ID to this endpoint, not the ID for a particular resource.
'
- info:
name: Update notification settings
type: http
http:
method: PATCH
url: https://api.render.com/v1/notification-settings/owners/:ownerId
params:
- name: ownerId
value: ''
type: path
description: The ID of the workspace to return resources for
body:
type: json
data: '{}'
docs: 'Update notification settings for the owner with the provided ID.
'
- info:
name: List notification overrides
type: http
http:
method: GET
url: https://api.render.com/v1/notification-settings/overrides
params:
- name: ownerId
value: ''
type: query
description: The ID of the workspaces to return resources for
- name: serviceId
value: ''
type: query
description: Filter for resources by service ID
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List notification overrides matching the provided filters. If no filters are provided, returns all notification
overrides for all workspaces the user belongs to.
'
- info:
name: Retrieve notification override
type: http
http:
method: GET
url: https://api.render.com/v1/notification-settings/overrides/services/:serviceId
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
docs: 'Retrieve the notification override for the service with the provided ID.
Note that you provide a service ID to this endpoint, not the ID for a particular override.
'
- info:
name: Update notification override
type: http
http:
method: PATCH
url: https://api.render.com/v1/notification-settings/overrides/services/:serviceId
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
body:
type: json
data: '{}'
docs: 'Update the notification override for the service with the provided ID.
'
- info:
name: Registry Credentials
type: folder
items:
- info:
name: List registry credentials
type: http
http:
method: GET
url: https://api.render.com/v1/registrycredentials
params:
- name: name
value: ''
type: query
description: Filter for the name of a credential
- name: username
value: ''
type: query
description: Filter for the username of a credential
- name: type
value: ''
type: query
description: Filter for the registry type for the credential
- name: createdBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for services created before a certain time (specified as an ISO 8601 timestamp)
- name: createdAfter
value: '2021-02-17T08:15:30Z'
type: query
description: Filter for services created after a certain time (specified as an ISO 8601 timestamp)
- name: updatedBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for services updated before a certain time (specified as an ISO 8601 timestamp)
- name: updatedAfter
value: '2021-02-17T08:15:30Z'
type: query
description: Filter for services updated after a certain time (specified as an ISO 8601 timestamp)
- name: ownerId
value: ''
type: query
description: The ID of the workspaces to return resources for
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List registry credentials matching the provided filters. If no filters are provided, returns all registry credentials
you have permissions to view.
'
- info:
name: Create registry credential
type: http
http:
method: POST
url: https://api.render.com/v1/registrycredentials
body:
type: json
data: '{}'
docs: Create a new registry credential.
- info:
name: Retrieve registry credential
type: http
http:
method: GET
url: https://api.render.com/v1/registrycredentials/:registryCredentialId
params:
- name: registryCredentialId
value: ''
type: path
description: The ID of the registry credential
docs: Retrieve the registry credential with the provided ID.
- info:
name: Update registry credential
type: http
http:
method: PATCH
url: https://api.render.com/v1/registrycredentials/:registryCredentialId
params:
- name: registryCredentialId
value: ''
type: path
description: The ID of the registry credential
body:
type: json
data: '{}'
docs: Update the registry credential with the provided ID. Services that use this credential must be redeployed to use
updated values.
- info:
name: Delete registry credential
type: http
http:
method: DELETE
url: https://api.render.com/v1/registrycredentials/:registryCredentialId
params:
- name: registryCredentialId
value: ''
type: path
description: The ID of the registry credential
docs: Delete the registry credential with the provided ID.
- info:
name: Services
type: folder
items:
- info:
name: List services
type: http
http:
method: GET
url: https://api.render.com/v1/services
params:
- name: name
value: ''
type: query
description: Filter by name
- name: type
value: ''
type: query
description: Filter for types of services
- name: environmentId
value: ''
type: query
description: Filter for resources that belong to an environment
- name: env
value: ''
type: query
description: Filter for environments (runtimes) of services (deprecated; use `runtime` instead)
- name: region
value: ''
type: query
description: Filter by resource region
- name: suspended
value: ''
type: query
description: Filter resources based on whether they're suspended or not suspended
- name: createdBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
- name: createdAfter
value: '2021-02-17T08:15:30Z'
type: query
description: Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
- name: updatedBefore
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
- name: updatedAfter
value: '2021-06-17T08:15:30Z'
type: query
description: Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
- name: ownerId
value: ''
type: query
description: The ID of the workspaces to return resources for
- name: includePreviews
value: ''
type: query
description: Include previews in the response
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List services matching the provided filters. If no filters are provided, returns all services you have permissions
to view.
'
- info:
name: Create service
type: http
http:
method: POST
url: https://api.render.com/v1/services
body:
type: json
data: '{}'
docs: 'Creates a new Render service in the specified workspace with the specified configuration.
'
- info:
name: Retrieve service
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
docs: 'Retrieve the service with the provided ID.
'
- info:
name: Update service
type: http
http:
method: PATCH
url: https://api.render.com/v1/services/:serviceId
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
body:
type: json
data: '{}'
docs: 'Update the service with the provided ID.
'
- info:
name: Delete service
type: http
http:
method: DELETE
url: https://api.render.com/v1/services/:serviceId
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
docs: 'Delete the service with the provided ID.
'
- info:
name: Purge Web Service Cache
type: http
http:
method: POST
url: https://api.render.com/v1/services/:serviceId/cache/purge
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
docs: 'Trigger cache purge for the web service if caching is enabled.
'
- info:
name: List environment variables
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId/env-vars
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List all environment variables for the service with the provided ID.
'
- info:
name: Update environment variables
type: http
http:
method: PUT
url: https://api.render.com/v1/services/:serviceId/env-vars
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
body:
type: json
data: '{}'
docs: Replace all environment variables for a service with the provided list of environment variables.
- info:
name: Retrieve environment variable
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: envVarKey
value: ''
type: path
description: The name of the environment variable
docs: 'Retrieve a particular environment variable for a particular service.
This only applies to environment variables set directly on the service, not to environment variables in a linked environment
group.
'
- info:
name: Add or update environment variable
type: http
http:
method: PUT
url: https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: envVarKey
value: ''
type: path
description: The name of the environment variable
body:
type: json
data: '{}'
docs: 'Add or update a particular environment variable for a particular service.
This only applies to environment variables set directly on the service, not to environment variables in a linked environment
group.
'
- info:
name: Delete environment variable
type: http
http:
method: DELETE
url: https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: envVarKey
value: ''
type: path
description: The name of the environment variable
docs: 'Delete a particular environment variable from a particular service.
This only applies to environment variables set directly on the service, not to environment variables in a linked environment
group.
'
- info:
name: List secret files
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId/secret-files
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: cursor
value: ''
type: query
description: The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- name: limit
value: ''
type: query
description: The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
docs: 'List all secret files for the service with the provided ID.
'
- info:
name: Update secret files
type: http
http:
method: PUT
url: https://api.render.com/v1/services/:serviceId/secret-files
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
body:
type: json
data: '{}'
docs: 'Replace all secret files for a service with the provided list of secret files.
**Any of the service''s existing secret files not included in this request will be deleted.**
This only applies to secret files set directly on the service, not to secret files in a linked environment group.
'
- info:
name: Retrieve secret file
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: secretFileName
value: ''
type: path
description: The file name of the secret file
docs: 'Retrieve a particular secret file for a particular service.
This only applies to secret files set directly on the service, not to secret files in a linked environment group.
'
- info:
name: Add or update secret file
type: http
http:
method: PUT
url: https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: secretFileName
value: ''
type: path
description: The file name of the secret file
body:
type: json
data: '{}'
docs: 'Add or update a particular secret file for a particular service.
This only applies to secret files set directly on the service, not to secret files in a linked environment group.
'
- info:
name: Delete secret file
type: http
http:
method: DELETE
url: https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: secretFileName
value: ''
type: path
description: The file name of the secret file
docs: 'Delete a particular secret file from a particular service.
This only applies to secret files set directly on the service, not to secret files in a linked environment group.
'
- info:
name: List events
type: http
http:
method: GET
url: https://api.render.com/v1/services/:serviceId/events
params:
- name: serviceId
value: ''
type: path
description: The ID of the service
- name: type
value: ''
type: query
description: The type of event to filter to
- name: startTime
value: ''
type: query
description: Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`.
- name: endTime
value: ''
type: query
description: Epoch/Unix timestamp of end of time range to return. Defaults to `now()`.
- name: cursor
value: ''
type: query
descripti
# --- truncated at 32 KB (138 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/render/refs/heads/main/apis.yml