# Render integration

> Manage Render cloud services, deploys, databases, and infrastructure via the Render REST API.

- Authentication: apiKey

## Tools (199)

- **Add custom domain**: Add a custom domain to the service with the provided ID.
- **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.
- **Add header rule**: Add a response header rule to the service with the provided ID.
- **Add or update environment variable (env group)**: Add or update a particular environment variable in a particular environment group.
- **Add or update environment variable (service)**: Add or update a particular environment variable for a particular service. This only applies to environment variables set directly on the service, not
- **Add or update secret file (env group)**: Add or update a particular secret file in an particular environment group.
- **Add or update secret file (service)**: 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
- **Add redirect/rewrite rules**: Add redirect/rewrite rules to the service with the provided ID.
- **Add resources to environment**: Add resources to the environment with the provided ID.
- **Cancel deploy**: Cancel an in-progress deploy for a service. Not supported for cron jobs.
- **Cancel running cron job**: Cancel a currently running cron job.
- **Cancel running job**: Cancel a particular one-off job for a particular service.
- **Cancel task run**: Cancel a running task run with the provided ID.
- **Create a webhook**: Create a new webhook.
- **Create a workflow**: Create a new workflow service with the specified configuration.
- **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 provis
- **Create environment**: Create a new environment belonging to the project with the provided ID.
- **Create environment group**: Create a new environment group.
- **Create job**: Create a one-off job using the provided service. For details, see [One-Off Jobs](https://render.com/docs/one-off-jobs).
- **Create Key Value instance**: Create a new Key Value instance.
- **Create or update metrics stream**: Creates or updates the metrics stream for the specified workspace.
- **Create Postgres export**: Create an [export](https://render.com/docs/postgresql-backups#logical-backups) of a Postgres instance by ID.
- **Create Postgres instance**: Create a new Postgres instance.
- **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.
- **Create project**: Create a new project.
- **Create registry credential**: Create a new registry credential.
- **Create service**: Creates a new Render service in the specified workspace with the specified configuration.
- **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
- **Delete autoscaling config**: Delete the autoscaling config for a service given the service id.
- **Delete a webhook**: Delete the webhook with the provided ID.
- **Delete custom domain**: Delete a custom domain for a service given the service id and custom domain id or name.
- **Delete dedicated IP set**: Delete the dedicated IP set with the provided ID.
- **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 i
- **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, d
- **Delete environment group**: Delete the environment group with the provided ID, including all environment variables and secret files it contains.
- **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 env
- **Delete header rule**: Delete a particular response header rule for a particular service.
- **Delete Key Value instance**: Delete a Key Value instance by ID.
- **Delete log stream**: Removes the log stream for the specified workspace.
- **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 metrics stream**: Deletes the metrics stream for the specified workspace.
- **Delete Postgres instance**: Delete a Postgres instance by ID. This operation is irreversible, and all data will be lost.
- **Delete PostgreSQL User**: Delete a PostgreSQL user from the Render Postgres instance with the provided ID.
- **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 resour
- **Delete redirect/rewrite rule**: Delete a particular redirect/rewrite rule for a particular service.
- **Delete registry credential**: Delete the registry credential with the provided ID.
- **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 lin
- **Delete service**: Delete the service with the provided ID.
- **Delete workflow**: Delete the workflow service with the provided ID.
- **Deploy a workflow version**: Creates and deploys a new version of a workflow.
- **Disconnect Blueprint**: Disconnect the Blueprint with the provided ID. Disconnecting a Blueprint stops automatic resource syncing via the associated `render.yaml` file. It do
- **Failover Postgres instance**: Failover a [highly available Postgres](https://render.com/docs/postgresql-high-availability) instance.
- **Get active connection count**: Get the number of active connections for one or more Postgres databases or Redis instances.
- **Get bandwidth usage**: Get bandwidth usage for one or more resources.
- **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 traff
- **Get CPU limit**: Get the CPU limit for one or more resources.
- **Get CPU target**: Get CPU target for one or more resources.
- **Get CPU usage**: Get CPU usage for one or more resources.
- **Get disk capacity**: Get persistent disk capacity for one or more resources.
- **Get disk usage**: Get persistent disk usage for one or more resources.
- **Get HTTP latency**: Get HTTP latency metrics for one or more resources.
- **Get HTTP request count**: Get the HTTP request count for one or more resources.
- **Get instance count**: Get the instance count for one or more resources.
- **Get memory limit**: Get the memory limit for one or more resources.
- **Get memory target**: Get memory target for one or more resources.
- **Get memory usage**: Get memory usage for one or more resources.
- **Get replica lag**: Get seconds of replica lag of a Postgres replica.
- **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 task runs queued count**: Get the total number of task runs queued for one or more tasks.
- **Get the authenticated user**: Retrieve the user associated with the provided API key.
- **Link service**: Link a particular service to a particular environment group. The linked service will have access to the environment variables and secret files in the
- **List Blueprints**: List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has access to.
- **List Blueprint syncs**: List syncs for the Blueprint with the provided ID.
- **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 returne
- **List database, table, and index sizes**: List the sizes of databases, tables, and indexes on a Postgres instance by ID.
- **List dedicated IPs**: List dedicated IP sets for a workspace.
- **List deploys**: List deploys matching the provided filters. If no filters are provided, all deploys for the service are returned.
- **List disks**: List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view.
- **List environment groups**: List environment groups matching the provided filters. If no filters are provided, all environment groups are returned.
- **List environments**: List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned.
- **List environment variables**: List all environment variables for the service with the provided ID.
- **List events**: List recent events that occurred for the service with the provided ID.
- **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.
- **List instances**: List instances for the provided service.
- **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.
- **List Key Value instances**: List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are returned.
- **List live queries**: List currently running queries (from `pg_stat_activity`) on a Postgres instance by ID.
- **List log label values**: List all values for a given log label in the logs matching the provided filters.
- **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 resp
- **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 lo
- **List maintenance runs**: List scheduled and/or recent maintenance runs for specified resources.
- **List notification overrides**: List notification overrides matching the provided filters. If no filters are provided, returns all notification overrides for all workspaces the user
- **List organization audit logs**: Retrieve audit logs for a specific organization with optional filtering and pagination.
- **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.
- **List Postgres instances**: List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.
- **List PostgreSQL Users**: List PostgreSQL users for the Render Postgres instance with the provided ID.
- **List projects**: List projects matching the provided filters. If no filters are provided, all projects are returned.
- **List queryable instance values**: List instance values to filter by for one or more resources.
- **List queryable paths**: The path suggestions are based on the most recent 5000 log lines as filtered by the provided filters
- **List queryable status codes and host values**: List status codes and host values to filter by for one or more resources.
- **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
- **List registry credentials**: List registry credentials matching the provided filters. If no filters are provided, returns all registry credentials you have permissions to view.
- **List secret files**: List all secret files for the service with the provided ID.
- **List services**: List services matching the provided filters. If no filters are provided, returns all services you have permissions to view.
- **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.
- **List table scans**: List the number of sequential scans performed against each table on a Postgres instance by ID.
- **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.
- **List tasks**: List workflow tasks that match the provided filters. If no filters are provided, all task definitions accessible by the authenticated user are returne
- **List top queries**: List the top 50 queries by total execution time (from `pg_stat_statements`) on a Postgres instance by ID.
- **List webhook events**: Retrieve a list of events that have been sent to this webhook, with optional filtering by timestamp.
- **List webhooks**: List webhooks
- **List workflows**: List workflows that match the provided filters. If no filters are provided, all workflows accessible by the authenticated user are returned.
- **List workflow versions**: List known versions of the workflow service with the provided ID.
- **List workspace audit logs**: Retrieve audit logs for a specific workspace with optional filtering and pagination.
- **List workspace members**: Retrieves the list of users belonging to the workspace with the provided ID.
- **List workspaces**: List the workspaces that your API key has access to, optionally filtered by name or owner email address.
- **Purge Web Service Cache**: Trigger cache purge for the web service if caching is enabled.
- **Remove environment variable**: Remove a particular environment variable from a particular environment group.
- **Remove resources from environment**: Remove resources from the environment with the provided ID.
- **Remove secret file**: Remove a particular secret file from a particular environment group.
- **Remove workspace member**: Remove a user from the specified workspace.
- **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 include
- **Restart Postgres instance**: Restart a Postgres instance by ID.
- **Restart service**: Restart the service with the provided ID. Not supported for cron jobs.
- **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
- **Resume Key Value instance**: Resume a Key Value instance by ID.
- **Resume Postgres instance**: Resume a Postgres instance by ID.
- **Resume service**: Resume the service with the provided ID (if it's currently suspended).
- **Retrieve a webhook**: Retrieve the webhook with the provided ID
- **Retrieve Blueprint**: Retrieve the Blueprint with the provided ID.
- **Retrieve custom domain**: Retrieve a particular custom domain for a particular service.
- **Retrieve dedicated IP set**: Retrieve the dedicated IP set with the provided ID.
- **Retrieve deploy**: Retrieve the details of a particular deploy for a particular service.
- **Retrieve disk**: Retrieve the persistent disk with the provided ID.
- **Retrieve environment**: Retrieve the environment with the provided ID.
- **Retrieve environment group**: Retrieve an environment group by ID.
- **Retrieve environment variable (env group)**: Retrieve a particular environment variable in a particular environment group.
- **Retrieve environment variable (service)**: Retrieve a particular environment variable for a particular service. This only applies to environment variables set directly on the service, not to en
- **Retrieve event**: Retrieve the details of a particular event
- **Retrieve job**: Retrieve the details of a particular one-off job for a particular service.
- **Retrieve Key Value connection info**: Retrieve connection info for a Key Value instance by ID. Connection info includes sensitive information.
- **Retrieve Key Value instance**: Retrieve a Key Value instance by ID.
- **Retrieve log stream**: Returns log stream information for the specified workspace.
- **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.
- **Retrieve maintenance run**: Retrieve the maintenance run with the provided ID.
- **Retrieve metrics stream**: Returns metrics stream information for the specified workspace.
- **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 particu
- **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 res
- **Retrieve point-in-time recovery status**: Retrieve information on the availability of Postgres point-in-time recovery for a Postgres instance by ID.
- **Retrieve Postgres connection info**: Retrieve connection info for a Postgres instance by ID. Connection info includes sensitive information.
- **Retrieve Postgres instance**: Retrieve a Postgres instance by ID.
- **Retrieve Project**: Retrieve the project with the provided ID.
- **Retrieve registry credential**: Retrieve the registry credential with the provided ID.
- **Retrieve secret file (env group)**: Retrieve a particular secret file in a particular environment group.
- **Retrieve secret file (service)**: 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 li
- **Retrieve service**: Retrieve the service with the provided ID.
- **Retrieve task**: Retrieve the workflow task with the provided ID.
- **Retrieve task run**: Retrieve the workflow task run with the provided ID.
- **Retrieve workflow**: Retrieve the workflow service with the provided ID.
- **Retrieve workflow version**: Retrieve the specific workflow service version with the provided ID.
- **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
- **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 servic
- **Run task**: Kicks off a run of the workflow task with the provided ID, passing the provided input data.
- **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
- **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`
- **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 fo
- **Suspend Key Value instance**: Suspend a Key Value instance by ID.
- **Suspend Postgres instance**: Suspend a Postgres instance by ID.
- **Suspend service**: Suspend the service with the provided ID.
- **Trigger cron job run**: Trigger a run for a cron job and cancel any active runs.
- **Trigger deploy**: Trigger a deploy for the service with the provided ID.
- **Trigger maintenance run**: Trigger the scheduled maintenance run with the provided ID. Triggering maintenance is asynchronous. To check whether maintenance has started, use the
- **Trigger point-in-time recovery**: Trigger [point-in-time recovery](https://render.com/docs/postgresql-backups) on the Postgres instance with the provided ID.
- **Unlink service**: Unlink a particular service from a particular environment group. The service will lose access to the environment variables and secret files in the gro
- **Update autoscaling config**: Update the [autoscaling](https://render.com/docs/scaling#autoscaling) config for the service with the provided ID.
- **Update a webhook**: Update the webhook with the provided ID.
- **Update Blueprint**: Update the Blueprint with the provided ID.
- **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 wor
- **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
- **Update environment**: Update the details of the environment with the provided ID.
- **Update environment group**: Update the attributes of an environment group.
- **Update environment variables**: Replace all environment variables for a service with the provided list of environment variables.
- **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.
- **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 over
- **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.
- **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 mainten
- **Update notification override**: Update the notification override for the service with the provided ID.
- **Update notification settings**: Update notification settings for the owner with the provided ID.
- **Update Postgres instance**: Update a Postgres instance by ID.
- **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-
- **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 p
- **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
- **Update registry credential**: Update the registry credential with the provided ID. Services that use this credential must be redeployed to use updated values.
- **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 reque
- **Update service**: Update the service with the provided ID.
- **Update workflow**: Update the workflow service with the provided ID.
- **Update workspace member role**: Update the role of an existing workspace member.
- **Validate Blueprint**: Validate a `render.yaml` Blueprint file without creating or modifying any resources. This endpoint checks the syntax and structure of the Blueprint, v
- **Verify DNS configuration**: Verify the DNS configuration for a custom domain.

## Triggers (2)

- **Deploy Finished in Render**: Triggers when a deploy reaches a terminal state (live, failed, canceled, or deactivated) on a Render service.
- **Deploy Failed in Render**: Triggers when a deploy fails (build, pre-deploy, or update failure) on a Render service.

Connect Render in General Input: https://www.generalinput.com/apps/render