Skip to content
Changelog

Report a bug

Render integration: operations for AI agents

Render connects to Type.com as an integration. This page lists the 228 operations documented for Claude and Codex in Type.com: 111 read, 61 write, 56 destructive.

About Render

Render is a unified cloud platform that enables developers to build and run applications and websites with ease.

Categories: Developer Tools & IT

How to connect Render to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

228 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

228 operations listed.

Blueprints

  • Read

    List Blueprints

    List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has access to.

    GET /blueprints

  • Read

    Validate Blueprint

    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 request body (including the Blueprint file) cannot exceed 10MB in size.

    POST /blueprints/validate

  • Read

    Retrieve Blueprint

    Retrieve the Blueprint with the provided ID.

    GET /blueprints/{blueprintId}

  • Read

    List Blueprint syncs

    List syncs for the Blueprint with the provided ID. Syncs that are planned but not yet approved (in the `created` state) are not included.

    GET /blueprints/{blueprintId}/syncs

  • Write

    Update Blueprint

    Update the Blueprint with the provided ID.

    PATCH /blueprints/{blueprintId}

  • Destructive

    Disconnect Blueprint

    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.

    DELETE /blueprints/{blueprintId}

Workspaces

  • Read

    List workspaces

    List the workspaces that your API key has access to, optionally filtered by name or owner email address.

    GET /owners

  • Read

    Retrieve workspace

    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.

    GET /owners/{ownerId}

  • Read

    List workspace members

    Retrieves the list of users belonging to the workspace with the provided ID.

    GET /owners/{ownerId}/members

  • Write

    Update workspace member role

    Update the role of an existing workspace member.

    PATCH /owners/{ownerId}/members/{userId}

  • Destructive

    Remove workspace member

    Remove a user from the specified workspace.

    DELETE /owners/{ownerId}/members/{userId}

Dedicated IPs

  • Read

    List dedicated IPs

    List dedicated IP sets for a workspace.

    GET /dedicated-ips

  • Read

    Retrieve dedicated IP set

    Retrieve the dedicated IP set with the provided ID.

    GET /dedicated-ips/{dedicatedIpId}

  • Write

    Create dedicated IP set

    Create a dedicated IP set. Provisioning an IP set is asynchronous. The response returns immediately with `status: CREATING` and `ips: []`. When provisioning completes, status changes to `RUNNING` and `ips` contains your assigned addresses. If `environmentIds` is omitted or empty, this IP set applies to all services in the workspace in the selected region. Otherwise, it applies only to services in the listed environments in that region.

    POST /dedicated-ips

  • Write

    Update dedicated IP set

    Update the dedicated IP set with the provided ID. All fields are optional. Omitted fields are left unchanged. To switch from environment-scoped to workspace-scoped, provide `environmentIds: []`.

    PATCH /dedicated-ips/{dedicatedIpId}

  • Destructive

    Delete dedicated IP set

    Delete the dedicated IP set with the provided ID.

    DELETE /dedicated-ips/{dedicatedIpId}

Disks

  • Read

    List disks

    List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view.

    GET /disks

  • Read

    Retrieve disk

    Retrieve the persistent disk with the provided ID.

    GET /disks/{diskId}

  • Read

    List snapshots

    List snapshots for the persistent disk with the provided ID. Each snapshot is a point-in-time copy of the disk's data.

    GET /disks/{diskId}/snapshots

  • Write

    Add disk

    Attach a persistent disk to a web service, private service, or background worker. The service must be redeployed for the disk to be attached.

    POST /disks

  • Write

    Update disk

    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.

    PATCH /disks/{diskId}

  • Destructive

    Delete disk

    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.

    DELETE /disks/{diskId}

  • Destructive

    Restore snapshot

    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.

    POST /disks/{diskId}/snapshots/restore

Users

  • Read

    Get the authenticated user

    Retrieve the user associated with the provided API key.

    GET /users

Audit Logs

  • Read

    List workspace audit logs

    Retrieve audit logs for a specific workspace with optional filtering and pagination.

    GET /owners/{ownerId}/audit-logs

  • Read

    List organization audit logs

    Retrieve audit logs for a specific organization with optional filtering and pagination.

    GET /organizations/{orgId}/audit-logs

Notification Settings

  • Read

    Retrieve notification settings

    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.

    GET /notification-settings/owners/{ownerId}

  • Read

    List notification overrides

    List notification overrides matching the provided filters. If no filters are provided, returns all notification overrides for all workspaces the user belongs to.

    GET /notification-settings/overrides

  • Read

    Retrieve notification override

    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.

    GET /notification-settings/overrides/services/{serviceId}

  • Write

    Update notification settings

    Update notification settings for the owner with the provided ID.

    PATCH /notification-settings/owners/{ownerId}

  • Write

    Update notification override

    Update the notification override for the service with the provided ID.

    PATCH /notification-settings/overrides/services/{serviceId}

Registry Credentials

  • Read

    List registry credentials

    List registry credentials matching the provided filters. If no filters are provided, returns all registry credentials you have permissions to view.

    GET /registrycredentials

  • Read

    Retrieve registry credential

    Retrieve the registry credential with the provided ID.

    GET /registrycredentials/{registryCredentialId}

  • Write

    Create registry credential

    Create a new registry credential.

    POST /registrycredentials

  • Write

    Update registry credential

    Update the registry credential with the provided ID. Services that use this credential must be redeployed to use updated values.

    PATCH /registrycredentials/{registryCredentialId}

  • Destructive

    Delete registry credential

    Delete the registry credential with the provided ID.

    DELETE /registrycredentials/{registryCredentialId}

Services

  • Read

    List services

    List services matching the provided filters. If no filters are provided, returns all services you have permissions to view.

    GET /services

  • Read

    Retrieve service

    Retrieve the service with the provided ID.

    GET /services/{serviceId}

  • Read

    List environment variables

    List all environment variables for the service with the provided ID.

    GET /services/{serviceId}/env-vars

  • Read

    Retrieve environment variable

    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.

    GET /services/{serviceId}/env-vars/{envVarKey}

  • Read

    List secret files

    List all secret files for the service with the provided ID.

    GET /services/{serviceId}/secret-files

  • Read

    Retrieve secret file

    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.

    GET /services/{serviceId}/secret-files/{envVarKey}

  • Read

    List events

    List recent events that occurred for the service with the provided ID.

    GET /services/{serviceId}/events

  • Read

    List instances

    List instances for the provided service.

    GET /services/{serviceId}/instances

  • Read

    Retrieve service outbound IPs

    Retrieve the IP addresses the service's outbound traffic originates from. A service uses either a dedicated IP set that applies to it, or the shared Render IPs for its region.

    GET /services/{serviceId}/outbound-ips

  • Write

    Create service

    Creates a new Render service in the specified workspace with the specified configuration.

    POST /services

  • Write

    Update service

    Update the service with the provided ID.

    PATCH /services/{serviceId}

  • Write

    Suspend service

    Suspend the service with the provided ID.

    POST /services/{serviceId}/suspend

  • Write

    Resume service

    Resume the service with the provided ID (if it's currently suspended).

    POST /services/{serviceId}/resume

  • Write

    Restart service

    Restart the service with the provided ID. Not supported for cron jobs.

    POST /services/{serviceId}/restart

  • Write

    Scale instance count

    [Scale](https://render.com/docs/scaling#manual-scaling) the service with the provided ID to a fixed number of instances. Render ignores this value as long as autoscaling is enabled for the service.

    POST /services/{serviceId}/scale

  • Write

    Create service preview (image-backed)

    Create a preview instance for an image-backed service. The preview uses the settings of the base service (referenced by `serviceId`), except settings overridden via provided parameters. View all active previews from your service's Previews tab in the Render Dashboard. Note that you can't create previews for Git-backed services using the Render API.

    POST /services/{serviceId}/preview

  • Destructive

    Delete service

    Delete the service with the provided ID.

    DELETE /services/{serviceId}

  • Destructive

    Purge Web Service Cache

    Trigger cache purge for the web service if caching is enabled.

    POST /services/{serviceId}/cache/purge

  • Destructive

    Update environment variables

    Replace all environment variables for a service with the provided list of environment variables.

    PUT /services/{serviceId}/env-vars

  • Destructive

    Add or update environment variable

    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.

    PUT /services/{serviceId}/env-vars/{envVarKey}

  • Destructive

    Delete environment variable

    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.

    DELETE /services/{serviceId}/env-vars/{envVarKey}

  • Destructive

    Update secret files

    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.

    PUT /services/{serviceId}/secret-files

  • Destructive

    Add or update secret file

    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.

    PUT /services/{serviceId}/secret-files/{envVarKey}

  • Destructive

    Delete secret file

    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.

    DELETE /services/{serviceId}/secret-files/{envVarKey}

  • Destructive

    Update autoscaling config

    Update the [autoscaling](https://render.com/docs/scaling#autoscaling) config for the service with the provided ID.

    PUT /services/{serviceId}/autoscaling

  • Destructive

    Delete autoscaling config

    Delete the autoscaling config for a service given the service id.

    DELETE /services/{serviceId}/autoscaling

Deploys

  • Read

    List deploys

    List deploys matching the provided filters. If no filters are provided, all deploys for the service are returned.

    GET /services/{serviceId}/deploys

  • Read

    Retrieve deploy

    Retrieve the details of a particular deploy for a particular service.

    GET /services/{serviceId}/deploys/{deployId}

  • Write

    Trigger deploy

    Trigger a deploy for the service with the provided ID.

    POST /services/{serviceId}/deploys

  • Write

    Roll back deploy

    Trigger a rollback to a previous deploy of the specified service. Triggering a rollback with this endpoint does not disable autodeploys for the service. This means an autodeploy might restore changes you had intentionally rolled back. You can toggle autodeploys for your service with the [Update service](https://api-docs.render.com/reference/update-service) endpoint or in the Render Dashboard.

    POST /services/{serviceId}/rollback

  • Destructive

    Cancel deploy

    Cancel an in-progress deploy for a service. Not supported for cron jobs.

    POST /services/{serviceId}/deploys/{deployId}/cancel

Services Headers

  • Read

    List header rules

    List a particular service's response header rules that match the provided filters. If no filters are provided, all rules for the service are returned.

    GET /services/{serviceId}/headers

  • Write

    Add header rule

    Add a response header rule to the service with the provided ID.

    POST /services/{serviceId}/headers

  • Destructive

    Replace header rules

    Replace all header rules for a particular service with the provided list. **This deletes all existing header rules for the service that aren't included in the request.**

    PUT /services/{serviceId}/headers

  • Destructive

    Delete header rule

    Delete a particular response header rule for a particular service.

    DELETE /services/{serviceId}/headers/{headerId}

Services Routes

  • Read

    List redirect/rewrite rules

    List a particular service's redirect/rewrite rules that match the provided filters. If no filters are provided, all rules for the service are returned.

    GET /services/{serviceId}/routes

  • Write

    Add redirect/rewrite rules

    Add redirect/rewrite rules to the service with the provided ID.

    POST /services/{serviceId}/routes

  • Write

    Update redirect/rewrite rule priority

    Update the priority for a particular redirect/rewrite rule. To apply redirect/rewrite rules to an incoming request, Render starts from the rule with priority `0` and applies the first encountered rule that matches the request's path (if any). Render increments the priority of other rules by `1` as necessary to make space for the updated rule.

    PATCH /services/{serviceId}/routes/{routeId}

  • Destructive

    Update redirect/rewrite rules

    Replace all redirect/rewrite rules for a particular service with the provided list. **This deletes all existing redirect/rewrite rules for the service that aren't included in the request.** Rule priority is assigned according to list order (the first rule in the list has the highest priority).

    PUT /services/{serviceId}/routes

  • Destructive

    Delete redirect/rewrite rule

    Delete a particular redirect/rewrite rule for a particular service.

    DELETE /services/{serviceId}/routes/{routeId}

Custom Domains

  • Read

    List custom domains

    List a particular service's custom domains that match the provided filters. If no filters are provided, all custom domains for the service are returned.

    GET /services/{serviceId}/custom-domains

  • Read

    Retrieve custom domain

    Retrieve a particular custom domain for a particular service.

    GET /services/{serviceId}/custom-domains/{customDomainNameOrID}

  • Write

    Add custom domain

    Add a custom domain to the service with the provided ID.

    POST /services/{serviceId}/custom-domains

  • Write

    Verify DNS configuration

    Verify the DNS configuration for a custom domain.

    POST /services/{serviceId}/custom-domains/{customDomainNameOrID}/verify

  • Destructive

    Delete custom domain

    Delete a custom domain for a service given the service id and custom domain id or name.

    DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID}

One Off Jobs

  • Read

    List jobs

    List jobs for the provided service that match the provided filters. If no filters are provided, all jobs for the service are returned.

    GET /services/{serviceId}/jobs

  • Read

    Retrieve job

    Retrieve the details of a particular one-off job for a particular service.

    GET /services/{serviceId}/jobs/{jobId}

  • Write

    Create job

    Create a one-off job using the provided service. For details, see [One-Off Jobs](https://render.com/docs/one-off-jobs).

    POST /services/{serviceId}/jobs

  • Destructive

    Cancel running job

    Cancel a particular one-off job for a particular service.

    POST /services/{serviceId}/jobs/{jobId}/cancel

Services Cron Jobs

  • Destructive

    Trigger cron job run

    Trigger a run for a cron job and cancel any active runs.

    POST /cron-jobs/{cronJobId}/runs

  • Destructive

    Cancel running cron job

    Cancel a currently running cron job.

    DELETE /cron-jobs/{cronJobId}/runs

Events

  • Read

    Retrieve event

    Retrieve the details of a particular event

    GET /events/{eventId}

Logs

  • Read

    List logs

    List logs matching the provided filters. Logs are paginated by start and end timestamps. There are more logs to fetch if `hasMore` is true in the response. Provide the `nextStartTime` and `nextEndTime` timestamps as the `startTime` and `endTime` query parameters to fetch the next page of logs. You can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner.

    GET /logs

  • Read

    Subscribe to new logs

    Open a websocket connection to subscribe to logs matching the provided filters. Logs are streamed in real-time as they are generated. You can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner.

    GET /logs/subscribe

  • Read

    List log label values

    List all values for a given log label in the logs matching the provided filters.

    GET /logs/values

  • Read

    Retrieve log stream

    Returns log stream information for the specified workspace.

    GET /logs/streams/owner/{ownerId}

  • Read

    List log stream overrides

    Lists log stream overrides for the provided workspace that match the provided filters. These overrides take precedence over the workspace's default log stream.

    GET /logs/streams/resource

  • Read

    Retrieve log stream override

    Returns log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream.

    GET /logs/streams/resource/{resourceId}

  • Destructive

    Update log stream

    Updates log stream information for the specified workspace. All logs for resources owned by this workspace will be sent to this log stream unless overridden by individual resources.

    PUT /logs/streams/owner/{ownerId}

  • Destructive

    Delete log stream

    Removes the log stream for the specified workspace.

    DELETE /logs/streams/owner/{ownerId}

  • Destructive

    Update log stream override

    Updates log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream.

    PUT /logs/streams/resource/{resourceId}

  • Destructive

    Delete log stream override

    Removes the log stream override for the specified resource. After deletion, the resource will use the workspace's default log stream setting.

    DELETE /logs/streams/resource/{resourceId}

Metrics

  • Read

    Retrieve metrics stream

    Returns metrics stream information for the specified workspace.

    GET /metrics-stream/{ownerId}

  • Read

    Get CPU usage

    Get CPU usage for one or more resources.

    GET /metrics/cpu

  • Read

    Get CPU limit

    Get the CPU limit for one or more resources.

    GET /metrics/cpu-limit

  • Read

    Get CPU target

    Get CPU target for one or more resources.

    GET /metrics/cpu-target

  • Read

    Get memory usage

    Get memory usage for one or more resources.

    GET /metrics/memory

  • Read

    Get memory limit

    Get the memory limit for one or more resources.

    GET /metrics/memory-limit

  • Read

    Get memory target

    Get memory target for one or more resources.

    GET /metrics/memory-target

  • Read

    Get HTTP request count

    Get the HTTP request count for one or more resources.

    GET /metrics/http-requests

  • Read

    Get HTTP latency

    Get HTTP latency metrics for one or more resources.

    GET /metrics/http-latency

  • Read

    Get bandwidth usage

    Get bandwidth usage for one or more resources.

    GET /metrics/bandwidth

  • Read

    Get bandwidth usage breakdown by traffic source

    Get bandwidth usage for one or more resources broken down by traffic source (HTTP, WebSocket, NAT, PrivateLink). Returns hourly data points with traffic source breakdown. Traffic source data is available from March 9, 2025 onwards. Queries for earlier dates will return a 400 Bad Request error.

    GET /metrics/bandwidth-sources

  • Read

    Get disk usage

    Get persistent disk usage for one or more resources.

    GET /metrics/disk-usage

  • Read

    Get disk capacity

    Get persistent disk capacity for one or more resources.

    GET /metrics/disk-capacity

  • Read

    Get instance count

    Get the instance count for one or more resources.

    GET /metrics/instance-count

  • Read

    Get active connection count

    Get the number of active connections for one or more Postgres databases or Redis instances.

    GET /metrics/active-connections

  • Read

    Get replica lag

    Get seconds of replica lag of a Postgres replica.

    GET /metrics/replication-lag

  • Read

    List queryable instance values

    List instance values to filter by for one or more resources.

    GET /metrics/filters/application

  • Read

    List queryable status codes and host values

    List status codes and host values to filter by for one or more resources.

    GET /metrics/filters/http

  • Read

    List queryable paths

    The path suggestions are based on the most recent 5000 log lines as filtered by the provided filters

    GET /metrics/filters/path

  • Read

    Get task runs queued count

    Get the total number of task runs queued for one or more tasks.

    GET /metrics/task-runs-queued

  • Read

    Get task runs completed count

    Get the total number of task runs completed for one or more tasks. Optionally filter by state (succeeded/failed) or aggregate by state.

    GET /metrics/task-runs-completed

  • Destructive

    Create or update metrics stream

    Creates or updates the metrics stream for the specified workspace.

    PUT /metrics-stream/{ownerId}

  • Destructive

    Delete metrics stream

    Deletes the metrics stream for the specified workspace.

    DELETE /metrics-stream/{ownerId}

Key Value

  • Read

    List Key Value instances

    List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are returned.

    GET /key-value

  • Read

    Retrieve Key Value instance

    Retrieve a Key Value instance by ID.

    GET /key-value/{redisId}

  • Read

    Retrieve Key Value connection info

    Retrieve connection info for a Key Value instance by ID. Connection info includes sensitive information.

    GET /key-value/{redisId}/connection-info

  • Write

    Create Key Value instance

    Create a new Key Value instance.

    POST /key-value

  • Write

    Update Key Value instance

    Update a Key Value instance by ID. Note that changing your plan, max memory policy, or persistence mode will restart your Key Value instance.

    PATCH /key-value/{redisId}

  • Write

    Suspend Key Value instance

    Suspend a Key Value instance by ID.

    POST /key-value/{redisId}/suspend

  • Write

    Resume Key Value instance

    Resume a Key Value instance by ID.

    POST /key-value/{redisId}/resume

  • Destructive

    Delete Key Value instance

    Delete a Key Value instance by ID.

    DELETE /key-value/{redisId}

Redis (Deprecated)

  • Read

    List Redis instances (deprecated)

    List Redis instances matching the provided filters. If no filters are provided, all Redis instances are returned. This API is deprecated in favor of the Key Value API.

    GET /redis

  • Read

    Retrieve Redis instance (deprecated)

    Retrieve a Redis instance by ID. This API is deprecated in favor of the Key Value API.

    GET /redis/{redisId}

  • Read

    Retrieve Redis connection info (deprecated)

    Retrieve connection info for a Redis instance by ID. Connection info includes sensitive information. This API is deprecated in favor of the Key Value API.

    GET /redis/{redisId}/connection-info

  • Write

    Create Redis instance (deprecated)

    Create a new Redis instance. This API is deprecated in favor of the Key Value API.

    POST /redis

  • Write

    Update Redis instance (deprecated)

    Update a Redis instance by ID. This API is deprecated in favor of the Key Value API.

    PATCH /redis/{redisId}

  • Write

    Suspend Redis instance (deprecated)

    Suspend a Redis instance by ID. This API is deprecated in favor of the Key Value API.

    POST /redis/{redisId}/suspend

  • Write

    Resume Redis instance (deprecated)

    Resume a Redis instance by ID. This API is deprecated in favor of the Key Value API.

    POST /redis/{redisId}/resume

  • Destructive

    Delete Redis instance (deprecated)

    Delete a Redis instance by ID. This API is deprecated in favor of the Key Value API.

    DELETE /redis/{redisId}

Postgres

  • Read

    List Postgres instances

    List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.

    GET /postgres

  • Read

    Retrieve Postgres instance

    Retrieve a Postgres instance by ID.

    GET /postgres/{postgresId}

  • Read

    Retrieve Postgres connection info

    Retrieve connection info for a Postgres instance by ID. Connection info includes sensitive information.

    GET /postgres/{postgresId}/connection-info

  • Read

    Retrieve point-in-time recovery status

    Retrieve information on the availability of Postgres point-in-time recovery for a Postgres instance by ID.

    GET /postgres/{postgresId}/recovery

  • Read

    List Postgres exports

    List [exports](https://render.com/docs/postgresql-backups#logical-backups) for a Postgres instance by ID. Returns a URL to download the export.

    GET /postgres/{postgresId}/export

  • Read

    List PostgreSQL Users

    List PostgreSQL users for the Render Postgres instance with the provided ID.

    GET /postgres/{postgresId}/credentials

  • Read

    List live queries

    List currently running queries (from `pg_stat_activity`) on a Postgres instance by ID.

    GET /postgres/{postgresId}/query/processes

  • Read

    List top queries

    List the top 50 queries by total execution time (from `pg_stat_statements`) on a Postgres instance by ID.

    GET /postgres/{postgresId}/query/top-queries

  • Read

    List database, table, and index sizes

    List the sizes of databases, tables, and indexes on a Postgres instance by ID.

    GET /postgres/{postgresId}/query/sizes

  • Read

    List table scans

    List the number of sequential scans performed against each table on a Postgres instance by ID.

    GET /postgres/{postgresId}/query/table-scans

  • Write

    Create Postgres instance

    Create a new Postgres instance.

    POST /postgres

  • Write

    Trigger point-in-time recovery

    Trigger [point-in-time recovery](https://render.com/docs/postgresql-backups) on the Postgres instance with the provided ID.

    POST /postgres/{postgresId}/recovery

  • Write

    Suspend Postgres instance

    Suspend a Postgres instance by ID.

    POST /postgres/{postgresId}/suspend

  • Write

    Resume Postgres instance

    Resume a Postgres instance by ID.

    POST /postgres/{postgresId}/resume

  • Write

    Restart Postgres instance

    Restart a Postgres instance by ID.

    POST /postgres/{postgresId}/restart

  • Write

    Failover Postgres instance

    Failover a [highly available Postgres](https://render.com/docs/postgresql-high-availability) instance.

    POST /postgres/{postgresId}/failover

  • Write

    Create Postgres export

    Create an [export](https://render.com/docs/postgresql-backups#logical-backups) of a Postgres instance by ID.

    POST /postgres/{postgresId}/export

  • Write

    Create PostgreSQL User

    Create a new PostgreSQL user for the Render Postgres instance with the provided ID. This becomes the database's new "default" user.

    POST /postgres/{postgresId}/credentials

  • Destructive

    Update Postgres instance

    Update a Postgres instance by ID.

    PATCH /postgres/{postgresId}

  • Destructive

    Delete Postgres instance

    Delete a Postgres instance by ID. This operation is irreversible, and all data will be lost.

    DELETE /postgres/{postgresId}

  • Destructive

    Delete PostgreSQL User

    Delete a PostgreSQL user from the Render Postgres instance with the provided ID.

    DELETE /postgres/{postgresId}/credentials/{username}

Projects & Environments

  • Read

    List projects

    List projects matching the provided filters. If no filters are provided, all projects are returned.

    GET /projects

  • Read

    Retrieve Project

    Retrieve the project with the provided ID.

    GET /projects/{projectId}

  • Read

    List environments

    List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned.

    GET /environments

  • Read

    Retrieve environment

    Retrieve the environment with the provided ID.

    GET /environments/{environmentId}

  • Write

    Create project

    Create a new project.

    POST /projects

  • Write

    Update project

    Update the details of a project. To update the details of a particular _environment_ in the project, instead use the [Update environment](https://api-docs.render.com/reference/update-environment) endpoint.

    PATCH /projects/{projectId}

  • Write

    Create environment

    Create a new environment belonging to the project with the provided ID.

    POST /environments

  • Write

    Update environment

    Update the details of the environment with the provided ID.

    PATCH /environments/{environmentId}

  • Write

    Add resources to environment

    Add resources to the environment with the provided ID.

    POST /environments/{environmentId}/resources

  • Destructive

    Delete project

    Delete the project with the provided ID. Requires _all_ of the project's environments to be empty (i.e., they must contain no services or other resources). Otherwise, deletion fails with a `409` response. To delete a non-empty project, do one of the following: - First move or delete all contained services and other resources. - Delete the project in the [Render Dashboard](https://dashboard.render.com).

    DELETE /projects/{projectId}

  • Destructive

    Delete environment

    Delete the environment with the provided ID. Requires the environment to be empty (i.e., it must contain no services or other resources). Otherwise, deletion fails with a `409` response. To delete a non-empty environment, do one of the following: - First move or delete all contained services and other resources. - Delete the environment in the [Render Dashboard](https://dashboard.render.com).

    DELETE /environments/{environmentId}

  • Destructive

    Remove resources from environment

    Remove resources from the environment with the provided ID.

    DELETE /environments/{environmentId}/resources

Environment Groups

  • Read

    List environment groups

    List environment groups matching the provided filters. If no filters are provided, all environment groups are returned.

    GET /env-groups

  • Read

    Retrieve environment group

    Retrieve an environment group by ID.

    GET /env-groups/{envGroupId}

  • Read

    Retrieve environment variable

    Retrieve a particular environment variable in a particular environment group.

    GET /env-groups/{envGroupId}/env-vars/{envVarKey}

  • Read

    Retrieve secret file

    Retrieve a particular secret file in a particular environment group.

    GET /env-groups/{envGroupId}/secret-files/{envVarKey}

  • Write

    Create environment group

    Create a new environment group.

    POST /env-groups

  • Write

    Update environment group

    Update the attributes of an environment group.

    PATCH /env-groups/{envGroupId}

  • Destructive

    Delete environment group

    Delete the environment group with the provided ID, including all environment variables and secret files it contains.

    DELETE /env-groups/{envGroupId}

  • Destructive

    Add or update environment variable

    Add or update a particular environment variable in a particular environment group.

    PUT /env-groups/{envGroupId}/env-vars/{envVarKey}

  • Destructive

    Remove environment variable

    Remove a particular environment variable from a particular environment group.

    DELETE /env-groups/{envGroupId}/env-vars/{envVarKey}

  • Destructive

    Add or update secret file

    Add or update a particular secret file in an particular environment group.

    PUT /env-groups/{envGroupId}/secret-files/{envVarKey}

  • Destructive

    Remove secret file

    Remove a particular secret file from a particular environment group.

    DELETE /env-groups/{envGroupId}/secret-files/{envVarKey}

Maintenance

  • Read

    List maintenance runs

    List scheduled and/or recent maintenance runs for specified resources.

    GET /maintenance

  • Read

    Retrieve maintenance run

    Retrieve the maintenance run with the provided ID.

    GET /maintenance/{maintenanceRunID}

  • Write

    Update maintenance run

    Update the maintenance run with the provided ID. Updates from this endpoint are asynchronous. To check your update's status, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint.

    PATCH /maintenance/{maintenanceRunID}

  • Write

    Trigger maintenance run

    Trigger the scheduled maintenance run with the provided ID. Triggering maintenance is asynchronous. To check whether maintenance has started, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint. As maintenance progresses, the run's `state` will change from `scheduled` to other values, such as `in_progress` and `succeeded`.

    POST /maintenance/{maintenanceRunID}/trigger

Build Sources

  • Read

    List build sources

    List build sources matching the provided filters. If `ownerId` is omitted, returns build sources across every workspace you can view.

    GET /build-sources

  • Read

    Retrieve a build source

    Retrieve a shared build source by ID

    GET /build-sources/{buildSourceId}

  • Read

    List builds in a build source

    List builds in a build source, newest first. Pass the last item's `cursor` as the `cursor` parameter to fetch the next page.

    GET /build-sources/{buildSourceId}/builds

  • Read

    Retrieve a build

    Retrieve a build of a build source, including its status.

    GET /build-sources/{buildSourceId}/builds/{buildId}

  • Read

    List environment variables

    List all environment variables for the build source with the provided ID.

    GET /build-sources/{buildSourceId}/env-vars

  • Read

    Retrieve environment variable

    Retrieve a particular environment variable for a particular build source. This only applies to environment variables set directly on the build source, not to environment variables in a linked environment group.

    GET /build-sources/{buildSourceId}/env-vars/{envVarKey}

  • Read

    List secret files

    List all secret files for the build source with the provided ID.

    GET /build-sources/{buildSourceId}/secret-files

  • Read

    Retrieve secret file

    Retrieve a particular secret file for a particular build source. This only applies to secret files set directly on the build source, not to secret files in a linked environment group.

    GET /build-sources/{buildSourceId}/secret-files/{envVarKey}

  • Write

    Create a build source

    Create a build source that can be linked to one or more services in the same workspace. Exactly one of `git` or `image` must be set: - `git`: the build source is git-backed. The code is built in the requested `region` (defaults to `oregon`). - `image`: the build source is image-backed. It points at an existing image in an external registry; no build is performed. `envVars`, `secretFiles`, and `envGroupIds` set the build-time environment and are only valid for `git` sources; the request fails if any are provided with `image`.

    POST /build-sources

  • Write

    Update a build source

    Update a shared build source. Each top-level field is a true patch, unset fields are left unchanged. Supplying `git` or `image` can change the build source's underlying identity: - `image` on a git-backed build source switches it to image-backed - `git` on an image-backed build source switches it to git-backed - `git` on a build source that's already git-backed is a pure patch onto the existing config

    PATCH /build-sources/{buildSourceId}

  • Write

    Trigger a build

    Start a new build of the build source at the current HEAD of its branch, even if an up-to-date build already exists. Services linked to the build source with autodeploy enabled are deployed with the result. Updating a build source or its build-time environment (env vars, secret files, env groups) with the REST API does not build it. Call this endpoint after those changes to build them. Only `git` build sources can be built.

    POST /build-sources/{buildSourceId}/builds

  • Destructive

    Delete a build source

    Delete the build source with the provided ID.

    DELETE /build-sources/{buildSourceId}

  • Destructive

    Update environment variables

    Replace all environment variables for a build source with the provided list of environment variables.

    PUT /build-sources/{buildSourceId}/env-vars

  • Destructive

    Add or update environment variable

    Add or update a particular environment variable for a particular build source. This only applies to environment variables set directly on the build source, not to environment variables in a linked environment group.

    PUT /build-sources/{buildSourceId}/env-vars/{envVarKey}

  • Destructive

    Delete environment variable

    Delete a particular environment variable from a particular build source. This only applies to environment variables set directly on the build source, not to environment variables in a linked environment group.

    DELETE /build-sources/{buildSourceId}/env-vars/{envVarKey}

  • Destructive

    Update secret files

    Replace all secret files for a build source with the provided list of secret files. **Any of the build source's existing secret files not included in this request will be deleted.** This only applies to secret files set directly on the build source, not to secret files in a linked environment group.

    PUT /build-sources/{buildSourceId}/secret-files

  • Destructive

    Add or update secret file

    Add or update a particular secret file for a particular build source. This only applies to secret files set directly on the build source, not to secret files in a linked environment group.

    PUT /build-sources/{buildSourceId}/secret-files/{envVarKey}

  • Destructive

    Delete secret file

    Delete a particular secret file from a particular build source. This only applies to secret files set directly on the build source, not to secret files in a linked environment group.

    DELETE /build-sources/{buildSourceId}/secret-files/{envVarKey}

Webhooks

  • Read

    List webhooks

    List webhooks

    GET /webhooks

  • Read

    Retrieve a webhook

    Retrieve the webhook with the provided ID

    GET /webhooks/{webhookId}

  • Read

    List webhook events

    Retrieve a list of events that have been sent to this webhook, with optional filtering by timestamp.

    GET /webhooks/{webhookId}/events

  • Write

    Create a webhook

    Create a new webhook.

    POST /webhooks

  • Write

    Update a webhook

    Update the webhook with the provided ID.

    PATCH /webhooks/{webhookId}

  • Destructive

    Delete a webhook

    Delete the webhook with the provided ID.

    DELETE /webhooks/{webhookId}

Workflows

  • Read

    List workflows

    List workflows that match the provided filters. If no filters are provided, all workflows accessible by the authenticated user are returned.

    GET /workflows

  • Read

    Retrieve workflow

    Retrieve the workflow service with the provided ID.

    GET /workflows/{workflowId}

  • Read

    List workflow versions

    List known versions of the workflow service with the provided ID.

    GET /workflowversions

  • Read

    Retrieve workflow version

    Retrieve the specific workflow service version with the provided ID.

    GET /workflowversions/{workflowVersionId}

  • Write

    Create a workflow

    Create a new workflow service with the specified configuration.

    POST /workflows

  • Write

    Update workflow

    Update the workflow service with the provided ID.

    PATCH /workflows/{workflowId}

  • Write

    Deploy a workflow version

    Creates and deploys a new version of a workflow.

    POST /workflowversions

  • Destructive

    Delete workflow

    Delete the workflow service with the provided ID.

    DELETE /workflows/{workflowId}

Workflow Tasks

  • Read

    List tasks

    List workflow tasks that match the provided filters. If no filters are provided, all task definitions accessible by the authenticated user are returned.

    GET /tasks

  • Read

    Retrieve task

    Retrieve the workflow task with the provided ID.

    GET /tasks/{taskId}

  • Read

    List task runs

    List task runs that match the provided filters. If no filters are provided, all task runs accessible by the authenticated user are returned.

    GET /task-runs

  • Read

    Stream realtime events (SSE)

    Establishes a unidirectional event stream. The server sends events as lines formatted per the SSE spec. Clients should set `Accept: text/event-stream` and keep the connection open. The server sends a `task.completed` event whenever a requested task run reaches any terminal state (`completed`, `failed`, or `canceled`). The `status` field of the payload indicates which state was reached. The server automatically closes the stream in the following cases: - All requested task runs have reached a terminal state. - The stream has not sent any events for 30 minutes. For tasks with a timeout higher than 30 minutes, waiting clients should fall back to polling with the [Retrieve task run](https://api-docs.render.com/reference/gettaskrun) endpoint.

    GET /task-runs/events

  • Read

    Retrieve task run

    Retrieve the workflow task run with the provided ID.

    GET /task-runs/{taskRunId}

  • Write

    Run task

    Kicks off a run of the workflow task with the provided ID, passing the provided input data.

    POST /task-runs

  • Destructive

    Cancel task run

    Cancel a running task run with the provided ID.

    DELETE /task-runs/{taskRunId}

See How connections work for access and permissions, or browse all integrations.