Connect AI agents to Render

blueprint_idstringrequired

The ID of the Blueprint to retrieve. Render Blueprint IDs use the `exs-` prefix, e.g. exs-cph1rs3idesc73a2b2mg.

blueprint_idstringrequired

The ID of the Blueprint whose syncs should be listed. Render Blueprint IDs use the `exs-` prefix, e.g. exs-cph1rs3idesc73a2b2mg.

cursorstring

Pagination cursor from a previous response. Each returned sync is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of syncs to return in this page of results. Between 1 and 100; defaults to 20.default 20

cursorstring

Pagination cursor from a previous response. Each returned Blueprint is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of Blueprints to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to Blueprints belonging to one of these Render workspace (owner) IDs. Provide an array of workspace ID strings. If omitted, returns all Blueprints the API key has access to.

custom_domain_id_or_namestringrequired

The ID or the exact name of the custom domain to retrieve. Custom domain IDs use the `cdm-` prefix; alternatively, pass the domain's exact name (e.g. www.example.com).

service_idstringrequired

The ID of the Render service the custom domain belongs to. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

service_idstringrequired

The ID of the Render service whose custom domains to list. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

created_afterstring

Only return custom domains created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return custom domains created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned domain is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

domain_typestring

Filter to custom domains of a specific type. Valid values: apex (e.g. example.com), subdomain (e.g. www.example.com).one of apexsubdomain

limitinteger

Maximum number of custom domains to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to custom domains whose name matches one of these values. Provide an array of exact domain names.

verification_statusstring

Filter to custom domains with a specific DNS verification status. Valid values: verified, unverified.one of verifiedunverified

dedicated_ip_idstringrequired

The ID of the dedicated IP set to retrieve, as returned by render_dedicated_ips_list or render_dedicated_ip_create.

owner_idstringrequired

ID of the Render workspace (team/owner) to list dedicated IP sets for. Find it in your Render workspace settings or via a workspace/owners list endpoint. Example: tea-cjnxpkdhshc73d12t9i0.

environment_idstring

Restrict results to the dedicated IP set (if any) scoped to this specific Render environment ID. Excludes workspace-wide dedicated IP sets from the results. Omit to list all dedicated IP sets for the workspace, both workspace-wide and environment-scoped.

deploy_idstringrequired

ID of the deploy to retrieve. Example: dep-cq3e6ttumphs73fk1nn0.

service_idstringrequired

ID of the Render service the deploy belongs to. Example: srv-c7ff2gp8fa8c73a1lj7g.

service_idstringrequired

ID of the Render service whose deploys should be listed. Example: srv-c7ff2gp8fa8c73a1lj7g.

created_afterstring

Only return deploys created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return deploys created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned deploy is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

finished_afterstring

Only return deploys that finished after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

finished_beforestring

Only return deploys that finished before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

limitinteger

Maximum number of deploys to return in this page of results. Between 1 and 100; defaults to 20.default 20

statusarray

Filter to deploys with one of these statuses. Valid values: created, queued, build_in_progress, update_in_progress, live, deactivated, build_failed, update_failed, canceled, pre_deploy_in_progress, pre_deploy_failed.

updated_afterstring

Only return deploys updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

updated_beforestring

Only return deploys updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

disk_idstringrequired

The ID of the disk to retrieve. Render disk IDs use the `dsk-` prefix, e.g. dsk-cph1rs3idesc73a2b2mg.

disk_idstringrequired

The ID of the disk whose snapshots should be listed. Render disk IDs use the `dsk-` prefix, e.g. dsk-cph1rs3idesc73a2b2mg.

created_afterstring

Only return disks created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return disks created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned disk is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

disk_idarray

Filter to disks with one of these exact disk IDs. Provide an array of disk ID strings, each using the `dsk-` prefix.

limitinteger

Maximum number of disks to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to disks whose name matches one of these values. Provide an array of exact disk names.

owner_idarray

Filter to disks owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

service_idarray

Filter to disks attached to one of these Render service IDs. Provide an array of service ID strings.

updated_afterstring

Only return disks last updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return disks last updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

env_group_idstringrequired

ID of the environment group that contains the variable.

env_var_keystringrequired

Name (key) of the environment variable to retrieve, e.g. DATABASE_URL.

env_group_idstringrequired

ID of the environment group to retrieve.

env_group_idstringrequired

The ID of the Render environment group that owns the secret file, as returned by render_env_groups_list or render_env_group_get. Environment group IDs use the `evg-` prefix, e.g. evg-d0m3n1a1fgac73c3jkfg.

namestringrequired

The filename of the secret file to retrieve, e.g. .env or credentials.json.

created_afterstring

Only return environment groups created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return environment groups created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned environment group is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to environment groups that belong to one of these Render environment IDs. Provide an array of environment ID strings.

limitinteger

Maximum number of environment groups to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to environment groups whose name matches one of these values. Provide an array of exact group names.

owner_idarray

Filter to environment groups owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

updated_afterstring

Only return environment groups last updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return environment groups last updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

environment_idstringrequired

The ID of the environment to retrieve, as returned by render_environments_list or render_environment_create. Render environment IDs use the `evm-` prefix, e.g. evm-cq2u42dsc6pc73fnjrb0.

project_idarrayrequired

Filter to environments belonging to one of these Render project IDs. This is required — provide an array of project ID strings, e.g. ["prj-c9pn6ffds738e88f0i8g"].

created_afterstring

Only return environments created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return environments created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned environment is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to these specific Render environment IDs. Provide an array of environment ID strings — useful for fetching several environments' full records in one call.

limitinteger

Maximum number of environments to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to environments whose name matches one of these values. Provide an array of exact environment names.

owner_idarray

Filter to environments owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

updated_afterstring

Only return environments updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return environments updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

event_idstringrequired

The ID of the event to retrieve, e.g. evt-cph1rs3idesc73a2b2mg.

service_idstringrequired

ID of the Render service whose header rules should be listed. Example: srv-c7ff2gp8fa8c73a1lj7g.

cursorstring

Pagination cursor from a previous response. Each returned header rule is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of header rules to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to header rules with one of these header names. Provide an array of exact header name strings, e.g. ["Cache-Control"].

patharray

Filter to header rules that apply to one of these request paths. Provide an array of exact path strings, e.g. ["/static/*"].

valuearray

Filter to header rules with one of these header values. Provide an array of exact header value strings, e.g. ["public, max-age=604800"].

job_idstringrequired

The ID of the job to retrieve, e.g. job-cph1rs3idesc73a2b2mg.

service_idstringrequired

The Render service ID the job belongs to.

service_idstringrequired

The Render service ID whose jobs you want to list.

created_afterstring

Only return jobs created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return jobs created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned job is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

finished_afterstring

Only return jobs that finished after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

finished_beforestring

Only return jobs that finished before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

limitinteger

Maximum number of jobs to return in this page of results. Between 1 and 100; defaults to 20.default 20

started_afterstring

Only return jobs that started after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

started_beforestring

Only return jobs that started before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

statusarray

Filter to jobs in one of these statuses. Valid values: pending, running, succeeded, failed, canceled.

redis_idstringrequired

The ID of the Key Value instance to retrieve connection info for, as returned by render_key_value_instances_list or render_key_value_instance_create.

redis_idstringrequired

The ID of the Key Value instance to retrieve, as returned by render_key_value_instances_list or render_key_value_instance_create.

created_afterstring

Only return Key Value instances created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return Key Value instances created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned instance is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to instances that belong to one of these Render environment IDs. Provide an array of environment ID strings.

limitinteger

Maximum number of Key Value instances to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to instances whose name matches one of these values. Provide an array of exact instance names.

owner_idarray

Filter to instances owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

regionarray

Filter to instances deployed in one of these regions. Valid values: frankfurt, oregon, ohio, singapore, virginia.

updated_afterstring

Only return Key Value instances updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return Key Value instances updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

owner_idstringrequired

The ID of the Render workspace (owner) to return log stream information for. Render workspace IDs use the `tea-` prefix, e.g. tea-cjnxpkdhshc73d12t9i0.

resource_idstringrequired

The ID of the resource (service, cron job, Postgres database, or Key Value/Redis instance) to retrieve the log stream override for.

cursorstring

Pagination cursor from a previous response. Each returned override is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of overrides to return in this page of results. Between 1 and 100; defaults to 20.default 20

log_stream_idarray

Filter to overrides belonging to one of these log stream IDs. Provide an array of log stream ID strings.

owner_idarray

Filter to overrides belonging to resources owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

resource_idarray

Filter to overrides for one of these resource IDs (a service, cron job, Postgres database, or Key Value/Redis instance). Provide an array of resource ID strings.

settingarray

Filter to overrides with one of these send/drop settings. Valid values: send, drop.

labelstringrequired

The log label to list distinct values for. Valid values: instance, host, statusCode, method, level, type.one of instancehoststatusCodemethodleveltype

owner_idstringrequired

The ID of the Render workspace (owner) to return log label values for.

resourcearrayrequired

The resource(s) to inspect logs for. Each value is the ID of a server, cron job, job, Postgres, Key Value, workflow, or sandbox group. All resources in one call must be in the same region and belong to the same owner.

directionstring

Direction to read logs in relative to the time window. Valid values: backward (most recent logs first, the default), forward (oldest logs in the window first).one of forwardbackwarddefault backward

end_timestring

End of the time range to consider, as an ISO 8601 / RFC3339 timestamp. Defaults to now() if omitted.

hostarray

Filter logs by host before collecting label values. Accepts an array of host values; wildcards and regex are supported.

instancearray

Filter logs by the specific running instance they were emitted from before collecting label values. Provide an array of instance IDs.

levelarray

Filter logs by severity level before collecting label values. Accepts an array of level values; wildcards and regex are supported.

limitinteger

Maximum number of values to return in this page of results. Between 1 and 100; defaults to 20.default 20

methodarray

Filter request logs by HTTP method before collecting label values. Accepts an array of method values; wildcards and regex are supported.

patharray

Filter request logs by request path before collecting label values. Accepts an array of path values; wildcards and regex are supported.

sandboxarray

Filter logs by sandbox ID before collecting label values. Accepts an array of sandbox IDs.

start_timestring

Start of the time range to consider, as an ISO 8601 / RFC3339 timestamp. Defaults to now() minus 1 hour if omitted.

status_codearray

Filter request logs by HTTP status code before collecting label values. Accepts an array of status code values; wildcards and regex are supported.

taskarray

Filter logs by task ID(s) before collecting label values, for logs emitted by workflow tasks. Accepts an array of task IDs.

task_runarray

Filter logs by task run ID(s) before collecting label values. Accepts an array of task run IDs.

textarray

Free-text search across the log message before collecting label values. Accepts an array of search terms; wildcards and regex are supported.

typearray

Filter logs by type before collecting label values. Common values include app, request, and build.

owner_idstringrequired

The ID of the Render workspace (owner) to return logs for.

resourcearrayrequired

The resource(s) to fetch logs for. Each value is the ID of a server, cron job, job, Postgres, Key Value, workflow, or sandbox group. All resources in one call must be in the same region and belong to the same owner.

directionstring

Direction to read logs in relative to the time window. Valid values: backward (most recent logs first, the default), forward (oldest logs in the window first).one of forwardbackwarddefault backward

end_timestring

End of the time range to fetch logs for, as an ISO 8601 / RFC3339 timestamp. Defaults to now() if omitted. To fetch the next page after a response with hasMore true, pass that response's nextEndTime value here.

hostarray

Filter request logs by host. Accepts an array of host values; wildcards and regex are supported per Render's log filtering syntax.

instancearray

Filter logs by the specific running instance (server) they were emitted from. Provide an array of instance IDs.

levelarray

Filter logs by severity level. Accepts an array of level values (e.g. info, warning, error); wildcards and regex are supported.

limitinteger

Maximum number of log entries to return in this page of results. Between 1 and 100; defaults to 20.default 20

methodarray

Filter request logs by HTTP method. Accepts an array of method values; wildcards and regex are supported.

patharray

Filter request logs by request path. Accepts an array of path values; wildcards and regex are supported.

sandboxarray

Filter logs by sandbox ID. Accepts an array of sandbox IDs.

start_timestring

Start of the time range to fetch logs for, as an ISO 8601 / RFC3339 timestamp. Defaults to now() minus 1 hour if omitted. To fetch the next page after a response with hasMore true, pass that response's nextStartTime value here.

status_codearray

Filter request logs by HTTP status code. Accepts an array of status code values; wildcards and regex are supported.

taskarray

Filter logs by task ID(s), for logs emitted by workflow tasks. Accepts an array of task IDs.

task_runarray

Filter logs by task run ID(s), for logs emitted by a specific workflow task run. Accepts an array of task run IDs.

textarray

Free-text search across the log message. Accepts an array of search terms; wildcards and regex are supported.

typearray

Filter logs by type. Common values include app (application logs), request (request logs), and build (build logs). Use render_log_values_list with label=type to discover the full set available for your query.

maintenance_run_idstringrequired

The ID of the maintenance run to retrieve. Render maintenance run IDs use the `mrn-` prefix, e.g. mrn-cph1rs3idesc73a2b2mg.

owner_idarray

Filter to maintenance runs on resources owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

resource_idarray

Filter to maintenance runs for one of these resource IDs. A resource can be a Render service, a Postgres instance, or a Key Value (Redis) instance. Provide an array of resource ID strings.

statearray

Filter to maintenance runs in one of these states. Valid values: scheduled, in_progress, user_fix_required, cancelled, succeeded, failed.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Resource ID(s) to query. Provide an array of Postgres IDs or Key Value (Redis) IDs; when multiple are given they are ORed together. Services are not valid here. Example: ["dpg-abc123", "red-abc123"].

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

end_timestring

End of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to the current time if omitted.

resolution_secondsnumber

The resolution of the returned data, in seconds. Must be at least 30. Defaults to 60.default 60

resourcearray

One or more Render service IDs to query filter values for. When multiple IDs are provided, they are ORed together (any match is included).

servicestring

Deprecated alias for the resource parameter: a single Render service ID to query filter values for. Prefer resource, which also supports multiple IDs.

start_timestring

Start of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before the current time if omitted.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resourcearray

Service ID(s) to query. Provide an array of Render service IDs; when multiple are given they are ORed together. Example: ["srv-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resourcearray

Service ID(s) to query. Provide an array of Render service IDs; when multiple are given they are ORed together. At most 30 resources may be queried at once. Example: ["srv-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z. Traffic-source breakdown data is only available for dates on or after 2025-03-09; a query whose time range starts earlier than that returns a 400 error.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Resource ID(s) to query. Provide an array of Render service IDs, Postgres IDs, or Key Value (Redis) IDs; when multiple are given they are ORed together. Example: ["srv-abc123", "dpg-abc123", "red-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Resource ID(s) to query. Provide an array of Render service IDs, Postgres IDs, or Key Value (Redis) IDs; when multiple are given they are ORed together. Example: ["srv-abc123", "dpg-abc123", "red-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

end_timestring

End of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to the current time if omitted.

hostarray

One or more hosts of HTTP requests to filter to, e.g. example.com. When multiple hosts are provided, they are ORed together.

resolution_secondsnumber

The resolution of the returned data, in seconds. Must be at least 30. Defaults to 60.default 60

resourcearray

One or more Render service IDs to query filter values for. When multiple IDs are provided, they are ORed together (any match is included). Note: on this specific endpoint, Render's live API currently rejects this parameter with "resource is not a valid field" (confirmed by live testing) even though the equivalent parameter works on other metrics endpoints — use the service field below instead until Render fixes this.

servicestring

A single Render service ID to query filter values for. Despite being marked deprecated in favor of resource, this is currently the ONLY working service filter on this specific endpoint — Render's live API rejects the resource parameter here with a 400 (confirmed by live testing). Use this field until that's fixed upstream.

start_timestring

Start of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before the current time if omitted.

status_codearray

One or more HTTP status codes of requests to filter to, e.g. 200. When multiple status codes are provided, they are ORed together.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

hostarray

Hosts of HTTP requests to filter to. Provide an array of hostnames; when multiple are given they are ORed together. Example: ["example.com"].

patharray

Request paths to filter to. Provide an array of path strings; when multiple are given they are ORed together. Example: ["/graphql"].

quantilearray

Latency quantiles to fetch, as decimals between 0 and 1 (e.g. 0.5 for the median, 0.99 for the 99th percentile). Provide an array of numbers; when multiple are given they are ORed together and each returns its own time series. Example: [0.5, 0.99].

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Service ID(s) to query. Provide an array of Render service IDs; when multiple are given they are ORed together (results include requests to any of them). Example: ["srv-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

aggregate_bystring

Field to aggregate the request count by, so the response breaks results down per value of this field instead of returning a single combined series. Valid values: statusCode, host.one of statusCodehost

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

hostarray

Hosts of HTTP requests to filter to. Provide an array of hostnames; when multiple are given they are ORed together. Example: ["example.com"].

patharray

Request paths to filter to. Provide an array of path strings; when multiple are given they are ORed together. Example: ["/graphql"].

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Service ID(s) to query. Provide an array of Render service IDs; when multiple are given they are ORed together (results include requests to any of them). Example: ["srv-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Resource ID(s) to query. Provide an array of Render service IDs, Postgres IDs, or Key Value (Redis) IDs; when multiple are given they are ORed together. Example: ["srv-abc123", "dpg-abc123", "red-abc123"].

servicearray

Deprecated filter, superseded by `resource`. Service ID(s) to query; when multiple are provided they are ORed together. Prefer the resource field instead.

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

aggregation_methodstring

The aggregation method to apply when a query resolves to multiple time series (e.g. multiple instances of a resource). Valid values: AVG, MAX, MIN.one of AVGMAXMIN

end_timestring

End of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. If omitted, Render defaults to the current time.

instancearray

Specific instance ID(s) to filter to within the given resource(s), e.g. individual running instance identifiers. When multiple values are given, they are ORed together. Example: ["srv-d1a2b3c4d5e6f7g8h9i0-6f8c9"].

resolution_secondsnumber

The resolution (time-bucket size, in seconds) of the returned data points. Minimum 30. Defaults to 60 seconds if omitted.default 60

resourcearray

Resource ID(s) to query metrics for. Accepts Render service IDs, Postgres IDs, or Key Value (Redis) IDs. When multiple values are given, they are ORed together (matches any of them). Example: ["srv-d1a2b3c4d5e6f7g8h9i0"].

servicestring

Deprecated: legacy single service ID filter, equivalent to `resource` but limited to one service and not combinable with it. Prefer the Resource IDs field instead. Example: srv-d1a2b3c4d5e6f7g8h9i0.

start_timestring

Start of the time range to return, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. If omitted, Render defaults to one hour before now.

end_timestring

End of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to the current time if omitted.

hostarray

One or more hosts of HTTP requests to filter to, e.g. example.com. When multiple hosts are provided, they are ORed together.

patharray

One or more request paths to filter to, e.g. /graphql. When multiple paths are provided, they are ORed together.

resourcearray

One or more Render service IDs to query filter values for. When multiple IDs are provided, they are ORed together (any match is included).

servicestring

Deprecated alias for the resource parameter: a single Render service ID to query filter values for. Prefer resource, which also supports multiple IDs.

start_timestring

Start of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before the current time if omitted.

status_codearray

One or more HTTP status codes of requests to filter to, e.g. 200. When multiple status codes are provided, they are ORed together.

end_timestring

End of the time range to return, as an ISO 8601 datetime. Defaults to the current time if omitted. Example: 2021-06-17T08:30:30Z.

resolution_secondsnumber

The resolution, in seconds, of the returned data points. Must be at least 30. Defaults to 60 (one data point per minute); larger values return fewer, more coarsely aggregated points over the same time range.default 60

resourcearray

Postgres ID(s) to query. Provide an array of Render Postgres IDs; when multiple are given they are ORed together. Example: ["dpg-abc123"].

start_timestring

Start of the time range to return, as an ISO 8601 datetime. Defaults to one hour before now if omitted. Example: 2021-06-17T08:15:30Z.

owner_idstringrequired

The ID of the Render workspace (owner) whose metrics stream integration should be retrieved. Render workspace IDs use the `tea-` prefix, e.g. tea-cjnxpkdhshc73d12t9i0.

aggregate_bystring

Field to aggregate the returned time series by. The only supported value is state, which returns separate series for each completion state instead of one combined series.one of state

aggregation_methodstring

How to aggregate the metric across multiple matching tasks/time series. This is a cumulative counter metric — Render only accepts SUM here (AVG/MAX/MIN/NONE are all rejected with a 400). Defaults to SUM; you should not normally need to change it.one of SUMdefault SUM

end_timestring

End of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to the current time if omitted.

resolution_secondsnumber

The resolution of the returned data, in seconds. Must be at least 30. Defaults to 60.default 60

resourcearray

One or more Render task IDs to query completed run counts for. When multiple IDs are provided, they are ORed together (any match is included).

start_timestring

Start of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before the current time if omitted.

statearray

Filter to completed task runs in one of these states. Valid values: succeeded, failed. When multiple states are provided, they are ORed together.

aggregation_methodstring

How to aggregate the metric across multiple matching tasks/time series. This is a cumulative counter metric — Render only accepts SUM here (AVG/MAX/MIN/NONE are all rejected with a 400). Defaults to SUM; you should not normally need to change it.one of SUMdefault SUM

end_timestring

End of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to the current time if omitted.

resolution_secondsnumber

The resolution of the returned data, in seconds. Must be at least 30. Defaults to 60.default 60

resourcearray

One or more Render task IDs to query queued run counts for. When multiple IDs are provided, they are ORed together (any match is included).

start_timestring

Start of the time range to query, as an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before the current time if omitted.

service_idstringrequired

The ID of the Render service whose notification override to retrieve. Provide a service ID, not the ID of an override record.

cursorstring

Pagination cursor from a previous response. Each returned override is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of overrides to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to overrides belonging to one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

service_idarray

Filter to the override for one of these specific Render service IDs. Provide an array of service ID strings.

owner_idstringrequired

The ID of the Render workspace (owner) whose notification settings to retrieve. This is a workspace ID, not the ID of a particular resource.

org_idstringrequired

The unique identifier of the Render organization whose audit logs to retrieve.

cursorstring

Pagination cursor from a previous response. Each returned audit log entry is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

directionstring

The direction to page through audit log entries. "backward" returns the most recent entries first; "forward" starts from the oldest entry in the time range. Defaults to backward.one of forwardbackwarddefault backward

end_timestring

Only return audit log entries recorded at or before this timestamp. Provide an ISO 8601 datetime, e.g. 2023-12-31T23:59:59Z.

limitinteger

Maximum number of audit log entries to return in this page of results. Between 1 and 1000; defaults to 20.default 20

start_timestring

Only return audit log entries recorded at or after this timestamp. Provide an ISO 8601 datetime, e.g. 2023-01-01T00:00:00Z.

postgres_idstringrequired

The ID of the Postgres instance to retrieve connection info for. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

postgres_idstringrequired

The ID of the Render Postgres instance whose exports should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Postgres instance to retrieve. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

created_afterstring

Only return Postgres instances created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return Postgres instances created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned instance is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to Postgres instances that belong to one of these Render environment IDs. Provide an array of environment ID strings.

include_replicasboolean

Whether to include read replica instances in the results.default true

limitinteger

Maximum number of Postgres instances to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to Postgres instances whose name matches one of these values. Provide an array of exact instance names.

owner_idarray

Filter to Postgres instances owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

regionarray

Filter to Postgres instances deployed in one of these regions. Valid values: frankfurt, oregon, ohio, singapore, virginia.

suspendedarray

Filter Postgres instances by suspension state. Valid values: suspended, not_suspended.

updated_afterstring

Only return Postgres instances updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return Postgres instances updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

postgres_idstringrequired

The ID of the Render Postgres instance whose live queries should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Postgres instance to check recovery status for. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

postgres_idstringrequired

The ID of the Render Postgres instance whose database, table, and index sizes should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Render Postgres instance whose table scan counts should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Render Postgres instance whose top queries should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Render Postgres instance whose users should be listed. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

project_idstringrequired

The ID of the project to retrieve. Render project IDs use the `prj-` prefix, e.g. prj-c9pn6ffds738e88f0i8g.

created_afterstring

Only return projects created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return projects created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned project is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of projects to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to projects whose name matches one of these values. Provide an array of exact project names.

owner_idarray

Filter to projects owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

updated_afterstring

Only return projects updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return projects updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

redis_idstringrequired

The ID of the Redis instance to retrieve connection info for. Render Redis instance IDs use the `red-` prefix, e.g. red-abc123.

redis_idstringrequired

The ID of the Redis instance to retrieve. Render Redis instance IDs use the `red-` prefix, e.g. red-abc123.

created_afterstring

Only return Redis instances created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return Redis instances created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned Redis instance is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to Redis instances that belong to one of these Render environment IDs. Provide an array of environment ID strings.

limitinteger

Maximum number of Redis instances to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to Redis instances whose name matches one of these values. Provide an array of exact instance names.

owner_idarray

Filter to Redis instances owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

regionarray

Filter to Redis instances deployed in one of these regions. Valid values: frankfurt, oregon, ohio, singapore, virginia.

updated_afterstring

Only return Redis instances updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return Redis instances updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

registry_credential_idstringrequired

The ID of the registry credential to retrieve, as returned by render_registry_credentials_list or render_registry_credential_create, e.g. rgc-d0m3n1a1fgac73c3jkfg.

created_afterstring

Only return registry credentials created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return registry credentials created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned credential is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of registry credentials to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to registry credentials whose name matches one of these values. Provide an array of exact credential names.

owner_idarray

Filter to registry credentials owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

typearray

Filter to registry credentials for one of these registry types. Valid values: GITHUB, GITLAB, DOCKER, GOOGLE_ARTIFACT, AWS_ECR.

updated_afterstring

Only return registry credentials updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

updated_beforestring

Only return registry credentials updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

usernamearray

Filter to registry credentials whose username matches one of these values. Provide an array of exact usernames.

service_idstringrequired

The ID of the Render service whose redirect/rewrite rules to list. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

cursorstring

Pagination cursor from a previous response. Each returned rule is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

destinationarray

Filter to rules whose destination path matches one of these values. Provide an array of exact destination pattern strings.

limitinteger

Maximum number of rules to return in this page of results. Between 1 and 100; defaults to 20.default 20

sourcearray

Filter to rules whose source path pattern matches one of these values. Provide an array of exact source pattern strings.

typearray

Filter to rules of one of these types. Valid values: redirect, rewrite.

env_var_keystringrequired

The name (key) of the environment variable to retrieve, e.g. NODE_ENV.

service_idstringrequired

The ID of the Render service that owns the environment variable. Service IDs start with the `srv-` prefix and can be found via render_services_list or the Render Dashboard.

service_idstringrequired

The ID of the Render service whose environment variables should be listed. Service IDs start with the `srv-` prefix and can be found via render_services_list or the Render Dashboard.

cursorstring

Pagination cursor from a previous response. Each returned environment variable is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of environment variables to return in this page of results. Between 1 and 100; defaults to 20.default 20

service_idstringrequired

The ID of the Render service, e.g. srv-abc123def456. Find it in the Render dashboard URL or from render_services_list.

cursorstring

Pagination cursor from a previous response. Each returned event is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

end_timestring

Only return events that occurred at or before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:30:30Z. Defaults to now.

limitinteger

Maximum number of events to return in this page of results. Between 1 and 100; defaults to 20.default 20

start_timestring

Only return events that occurred at or after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z. Defaults to one hour before now.

typestring

Filter to events of this type only, e.g. deploy_started, deploy_ended, build_started, build_ended, autoscaling_started, service_suspended, server_restarted. Valid values: artifact_fetch_failed, artifact_source_changed, autoscaling_config_changed, autoscaling_ended, autoscaling_started, branch_deleted, build_ended, build_started, commit_ignored, cron_job_run_ended, cron_job_run_started, deploy_ended, deploy_started, disk_created, disk_updated, disk_deleted, service_disk_usage_high, service_disk_usage_recovered, image_pull_failed, initial_deploy_hook_ended, initial_deploy_hook_started, instance_count_changed, job_run_ended, maintenance_mode_enabled, maintenance_mode_uri_updated, maintenance_ended, maintenance_started, pipeline_minutes_exhausted, plan_changed, pre_deploy_ended, pre_deploy_started, server_available, server_failed, server_hardware_failure, server_restarted, service_resumed, service_suspended, suspender_added, suspender_removed, zero_downtime_redeploy_ended, zero_downtime_redeploy_started, auto_deploy_disabled, auto_deploy_enabled. Omit to return events of every type.one of artifact_fetch_failedartifact_source_changedautoscaling_config_changedautoscaling_endedautoscaling_startedbranch_deletedbuild_endedbuild_startedcommit_ignoredcron_job_run_endedcron_job_run_starteddeploy_endeddeploy_starteddisk_createddisk_updateddisk_deletedservice_disk_usage_highservice_disk_usage_recoveredimage_pull_failedinitial_deploy_hook_endedinitial_deploy_hook_startedinstance_count_changedjob_run_endedmaintenance_mode_enabledmaintenance_mode_uri_updatedmaintenance_endedmaintenance_startedpipeline_minutes_exhaustedplan_changedpre_deploy_endedpre_deploy_startedserver_availableserver_failedserver_hardware_failureserver_restartedservice_resumedservice_suspendedsuspender_addedsuspender_removedzero_downtime_redeploy_endedzero_downtime_redeploy_startedauto_deploy_disabledauto_deploy_enabled

service_idstringrequired

The ID of the Render service to retrieve. Service IDs start with the `srv-` prefix and can be found via render_services_list or the Render Dashboard.

service_idstringrequired

The ID of the Render service, e.g. srv-abc123def456. Find it in the Render dashboard URL or from render_services_list.

service_idstringrequired

The ID of the Render service, e.g. srv-abc123def456. Find it in the Render dashboard URL or from render_services_list.

file_namestringrequired

The name (path) of the secret file to retrieve, e.g. .npmrc. Case-sensitive; must match an existing secret file set directly on the service.

service_idstringrequired

The ID of the Render service, e.g. srv-abc123def456. Find it in the Render dashboard URL or from render_services_list.

service_idstringrequired

The ID of the Render service, e.g. srv-abc123def456. Find it in the Render dashboard URL or from render_services_list.

cursorstring

Pagination cursor from a previous response. Each returned secret file is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of secret files to return in this page of results. Between 1 and 100; defaults to 20.default 20

created_afterstring

Only return services created after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

created_beforestring

Only return services created before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

cursorstring

Pagination cursor from a previous response. Each returned service is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to services that belong to one of these Render environment IDs. Provide an array of environment ID strings.

include_previewsboolean

Whether to include preview environment services in the results.default true

limitinteger

Maximum number of services to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to services whose name matches one of these values. Provide an array of exact service names.

owner_idarray

Filter to services owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

regionarray

Filter to services deployed in one of these regions. Valid values: frankfurt, oregon, ohio, singapore, virginia.

runtimearray

Deprecated filter on the runtime/environment a service runs in (Render's `env` query filter). Valid values: docker, elixir, go, node, python, ruby, rust, image. Prefer the type and name filters where possible, as this filter is deprecated upstream.

suspendedarray

Filter services by suspension state. Valid values: suspended, not_suspended.

typearray

Filter to services of one of these types. Valid values: static_site, web_service, private_service, background_worker, cron_job.

updated_afterstring

Only return services updated after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

updated_beforestring

Only return services updated before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

task_idstringrequired

The ID of the task to retrieve, e.g. tsk-c9h6xr7sc6c73frmyd0g.

task_run_idstringrequired

The ID of the task run to retrieve, e.g. tskr-c9h6xr7sc6c73frmyd0g.

cursorstring

Pagination cursor from a previous response. Each returned task run is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of task runs to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to task runs owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

root_task_run_idarray

Filter to task runs that descend from one of these root task run IDs (i.e. sub-runs spawned by these top-level runs). Provide an array of task run ID strings.

task_slugarray

Filter to task runs whose task slug matches one of these values. Provide an array of task slugs in the format workflow-slug/task-name, optionally with a version suffix (workflow-slug/task-name:version). If no version is given, the latest version is matched.

workflow_idarray

Filter to task runs belonging to one of these Render workflow IDs. Provide an array of workflow ID strings.

workflow_version_idarray

Filter to task runs belonging to one of these Render workflow version IDs. Provide an array of workflow version ID strings.

cursorstring

Pagination cursor from a previous response. Each returned task is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of tasks to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to tasks owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

task_slugarray

Filter to tasks whose slug matches one of these values. Provide an array of task slugs in the format workflow-slug/task-name, optionally with a version suffix (workflow-slug/task-name:version). If no version is given, the latest version is matched.

workflow_idarray

Filter to tasks belonging to one of these Render workflow IDs. Provide an array of workflow ID strings.

workflow_version_idarray

Filter to tasks belonging to one of these Render workflow version IDs. Provide an array of workflow version ID strings.

This tool takes no inputs.

webhook_idstringrequired

The ID of the webhook whose delivery history you want to list, e.g. whk-d04m9b1r0fns73ckp94f.

cursorstring

Pagination cursor from a previous response. Each returned event is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of webhook events to return in this page of results. Between 1 and 100; defaults to 20.default 20

sent_afterstring

Only return webhook events sent after this timestamp. Provide an ISO 8601 datetime, e.g. 2021-02-17T08:15:30Z.

sent_beforestring

Only return webhook events sent before this timestamp. Provide an ISO 8601 datetime, e.g. 2021-06-17T08:15:30Z.

webhook_idstringrequired

The ID of the webhook to retrieve, e.g. whk-d04m9b1r0fns73ckp94f.

cursorstring

Pagination cursor from a previous response. Each returned webhook is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of webhooks to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to webhooks owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

workflow_idstringrequired

ID of the Render workflow to retrieve. Workflow IDs use the `wfl-` prefix, e.g. wfl-c7ff2gp8fa8c73a1lj7g.

workflow_version_idstringrequired

ID of the workflow version to retrieve. Workflow version IDs use the `wfv-` prefix, e.g. wfv-c7ff2gp8fa8c73a1lj7g.

cursorstring

Pagination cursor from a previous response. Each returned version is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

limitinteger

Maximum number of workflow versions to return in this page of results. Between 1 and 100; defaults to 20.default 20

owner_idarray

Filter to versions of workflows owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

workflow_idarray

Filter to versions belonging to one of these workflows. Provide an array of workflow ID strings.

workflow_version_idarray

Filter to one or more specific workflow versions by ID. Provide an array of workflow version ID strings.

cursorstring

Pagination cursor from a previous response. Each returned workflow is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

environment_idarray

Filter to workflows that belong to one of these Render environment IDs. Provide an array of environment ID strings.

limitinteger

Maximum number of workflows to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to workflows whose name matches one of these values. Provide an array of exact workflow names.

owner_idarray

Filter to workflows owned by one of these Render workspace (owner) IDs. Provide an array of workspace ID strings.

workflow_idarray

Filter to workflows with one of these IDs. Provide an array of workflow ID strings.

owner_idstringrequired

The ID of the Render workspace (owner) whose audit logs to retrieve.

cursorstring

Pagination cursor from a previous response. Each returned audit log entry is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

directionstring

The direction to page through audit log entries. "backward" returns the most recent entries first; "forward" starts from the oldest entry in the time range. Defaults to backward.one of forwardbackwarddefault backward

end_timestring

Only return audit log entries recorded at or before this timestamp. Provide an ISO 8601 datetime, e.g. 2023-12-31T23:59:59Z.

limitinteger

Maximum number of audit log entries to return in this page of results. Between 1 and 1000; defaults to 20.default 20

start_timestring

Only return audit log entries recorded at or after this timestamp. Provide an ISO 8601 datetime, e.g. 2023-01-01T00:00:00Z.

owner_idstringrequired

The ID of the workspace to retrieve. Workspace IDs use the `tea-` prefix; a user ID (`own-` prefix) returns that user's default workspace instead.

owner_idstringrequired

The ID of the workspace (team) whose members should be listed. Workspace IDs use the `tea-` prefix.

cursorstring

Pagination cursor from a previous response. Each returned workspace is paired with a cursor value; pass the last one back here to fetch the next page. Omit for the first page.

emailarray

Filter to workspaces owned by one of these email addresses. Provide an array of exact email address strings.

limitinteger

Maximum number of workspaces to return in this page of results. Between 1 and 100; defaults to 20.default 20

namearray

Filter to workspaces whose name matches one of these values. Provide an array of exact workspace names; only exact matches are returned.

blueprint_idstringrequired

The ID of the Blueprint to update. Render Blueprint IDs use the `exs-` prefix, e.g. exs-cph1rs3idesc73a2b2mg.

auto_syncboolean

Whether changes to the render.yaml file should be automatically synced. Set true to enable automatic syncing, or false to require manual syncs.

namestring

New display name for the Blueprint. Leave blank to keep the current name.

pathstring

New path to the Blueprint (render.yaml) file within the connected repository. Leave blank to keep the current path.

cron_job_idstringrequired

The ID of the Render cron job to trigger a run for.

namestringrequired

The custom domain name to add, exactly as it will be used to reach the service (e.g. an apex domain like example.com, or a subdomain like www.example.com).

service_idstringrequired

The ID of the Render service to add the custom domain to. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

custom_domain_id_or_namestringrequired

The ID or the exact name of the custom domain to verify. Custom domain IDs use the `cdm-` prefix; alternatively, pass the domain's exact name (e.g. www.example.com).

service_idstringrequired

The ID of the Render service the custom domain belongs to. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

namestringrequired

Name for the dedicated IP set, used to identify it in the Render dashboard and API.

owner_idstringrequired

ID of the Render workspace (team/owner) that will own this dedicated IP set. Find it in your Render workspace settings or via a workspace/owners list endpoint. Example: tea-cjnxpkdhshc73d12t9i0.

regionstringrequired

Render region to provision the dedicated IP set in. Valid values: frankfurt, oregon, ohio, singapore, virginia.one of frankfurtoregonohiosingaporevirginia

descriptionstring

Free-form description for this dedicated IP set, e.g. what it's used for. Optional.

environment_idsarray

Render environment IDs to scope this dedicated IP set to. If omitted or given an empty array, the IP set applies to every service in the workspace within the selected region. If you provide one or more environment IDs, the IP set applies only to services in those specific environments (in that region) instead of the whole workspace. Provide an array of environment ID strings, e.g. ["evm-cq2u42dsc6pc73fnjrb0"].

dedicated_ip_idstringrequired

The ID of the dedicated IP set to update, as returned by render_dedicated_ips_list or render_dedicated_ip_create.

descriptionstring

New free-form description for this dedicated IP set. Leave unset to keep the current description unchanged.

environment_idsarray

New list of Render environment IDs to scope this dedicated IP set to. Leave this field out entirely to keep the current scoping unchanged. Pass an explicit empty array ([]) to remove environment scoping and make the set apply workspace-wide in its region again, or pass one or more environment IDs to scope it to just those environments. Note: an omitted field and an explicit empty array behave differently here — omit the field to leave scoping untouched; send [] on purpose to widen it back to the whole workspace.

namestring

New name for this dedicated IP set. Leave unset to keep the current name unchanged.

deploy_idstringrequired

ID of the in-progress deploy to cancel. Example: dep-cq3e6ttumphs73fk1nn0.

service_idstringrequired

ID of the Render service the deploy belongs to. Example: srv-c7ff2gp8fa8c73a1lj7g.

service_idstringrequired

ID of the Render service to deploy. Example: srv-c7ff2gp8fa8c73a1lj7g.

clear_cachestring

Whether Render should clear the service's build cache before deploying. Valid values: clear, do_not_clear. Defaults to do_not_clear. Useful if you're seeing stale build issues. Cannot be combined with deploy_mode.one of cleardo_not_cleardefault do_not_clear

commit_idstring

SHA of a specific Git commit to deploy. Defaults to the latest commit on the service's connected branch if omitted. Deploying a specific commit does not disable autodeploys. Not supported for cron jobs, and cannot be combined with deploy_mode.

deploy_modestring

Controls deploy behavior. deploy_only redeploys the last successful build without rebuilding (minimizes downtime); build_and_deploy builds new code and deploys it (default). deploy_mode cannot be combined with commit_id, image_url, or clear_cache.one of deploy_onlybuild_and_deploydefault build_and_deploy

image_urlstring

URL of the image to deploy for an image-backed service. The host, repository, and image name must all match the service's currently configured image. Cannot be combined with deploy_mode.

deploy_idstringrequired

ID of the previous deploy to roll back to. Find candidate deploy IDs via render_deploys_list. Example: dep-cq3e6ttumphs73fk1nn0.

service_idstringrequired

ID of the Render service to roll back. Example: srv-c7ff2gp8fa8c73a1lj7g.

mount_pathstringrequired

Absolute filesystem path within the service's runtime environment where the disk should be mounted, e.g. /var/data.

namestringrequired

Display name for the new disk. This is a label you choose to identify the disk; it does not need to be unique.

service_idstringrequired

ID of the Render service (web service, private service, or background worker) to attach the disk to. Render service IDs use the `srv-` prefix, e.g. srv-c7ff2gp8fa8c73a1lj7g.

size_gbintegerrequired

Size of the disk in gigabytes.

disk_idstringrequired

The ID of the disk to restore. Render disk IDs use the `dsk-` prefix, e.g. dsk-cph1rs3idesc73a2b2mg.

snapshot_keystringrequired

The snapshotKey identifying which point-in-time snapshot to restore, obtained from a prior render_disk_snapshots_list call. This key expires 24 hours after being issued -- if the restore fails with an expired-key error, call render_disk_snapshots_list again to get a fresh key and retry.

instance_idstring

ID of the specific scaled instance whose disk snapshot should be restored. Only needed when the service runs multiple scaled instances -- each instance has its own independent disk snapshots that must be restored separately. Omit for single-instance services.

disk_idstringrequired

The ID of the disk to update. Render disk IDs use the `dsk-` prefix, e.g. dsk-cph1rs3idesc73a2b2mg.

mount_pathstring

New absolute filesystem path where the disk should be mounted within the service. Leave blank to keep the current mount path.

namestring

New display name for the disk. Leave blank to keep the current name.

size_gbinteger

New size for the disk in gigabytes. Must be strictly greater than the disk's current size -- Render does not support shrinking a disk. Leave blank to keep the current size. Call render_disk_get first if you need to check the current size.

env_varsarrayrequired

Initial environment variables for this group, as a JSON array of objects. Each object must have a "key" and either a "value" (a literal string you supply) or "generateValue": true (Render generates a strong random value automatically) — provide exactly one of value or generateValue per entry, never both. Pass an empty array if you don't want to set any variables yet. Example: [{"key": "API_URL", "value": "https://api.example.com"}, {"key": "SESSION_SECRET", "generateValue": true}].

namestringrequired

Name of the environment group, used to identify it in the Render dashboard and API.

owner_idstringrequired

ID of the Render workspace (team/owner) this environment group belongs to. Find it in your Render workspace settings or via a workspace list endpoint. Example: tea-cjnxpkdhshc73d12t9i0.

environment_idstring

ID of the Render environment this group should belong to. Optional — omit to create the group without an associated environment.

secret_filesarray

Secret files to seed the group with, as a JSON array of objects, each with a "name" (file name) and "content" (the file's full text content). Example: [{"name": ".env.production", "content": "DEBUG=false\n"}]. Omit to create the group with no secret files.

service_idsarray

IDs of existing Render services to link to this group at creation time, as an array of service ID strings. Linked services gain access to the group's environment variables and secret files. Omit to create the group unlinked.

env_group_idstringrequired

ID of the environment group that contains (or should contain) the variable.

env_var_keystringrequired

Name (key) of the environment variable to add or update, e.g. DATABASE_URL. If a variable with this key already exists in the group, its value is replaced; otherwise a new variable is added.

generate_valueboolean

If true, Render generates a strong random value for this variable instead of using a literal value you provide. Provide exactly one of value or generate_value, never both.

valuestring

Literal value to set for this environment variable. Provide exactly one of value or generate_value, never both.

contentstringrequired

The full plaintext content to store in the secret file, replacing any existing content if the file already exists.

env_group_idstringrequired

The ID of the Render environment group to add or update the secret file in, as returned by render_env_groups_list or render_env_group_get. Environment group IDs use the `evg-` prefix, e.g. evg-d0m3n1a1fgac73c3jkfg.

namestringrequired

The filename of the secret file to add or update, e.g. .env or credentials.json. If a file with this name already exists in the group, its content is overwritten; otherwise a new file is created.

env_group_idstringrequired

ID of the environment group to link the service to.

service_idstringrequired

ID of the service to link to the environment group. The service will gain access to the group's environment variables and secret files.

env_group_idstringrequired

ID of the environment group to update.

namestringrequired

New name for the environment group.

namestringrequired

The name of the new environment, shown in the Render dashboard and API responses.

project_idstringrequired

The ID of the Render project this environment will belong to. Render project IDs use the `prj-` prefix, e.g. prj-c9pn6ffds738e88f0i8g.

ip_allow_listarray

List of CIDR blocks allowed to connect to resources in this environment from outside Render's private network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description explaining what it's for. If omitted, Render applies its account-level default allow list. Example: [{"cidrBlock": "203.0.113.0/24", "description": "office network"}].

network_isolation_enabledboolean

Whether network connections across environments are allowed. Set to true to isolate this environment's private network traffic from other environments in the same project; false (or omitted) leaves cross-environment connections allowed.

protected_statusstring

Whether the environment is `unprotected` or `protected`. Only admin users can perform destructive actions in `protected` environments. Defaults to `unprotected` if omitted.one of unprotectedprotected

environment_idstringrequired

The ID of the environment to add resources to, as returned by render_environments_list or render_environment_create. Render environment IDs use the `evm-` prefix, e.g. evm-cq2u42dsc6pc73fnjrb0.

resource_idsarrayrequired

The IDs of the resources to add to this environment. Each entry must be an existing env group ID (`evg-` prefix), service ID (`srv-` prefix), Postgres database ID (`dpg-` prefix), or Redis/Key Value instance ID (`red-` prefix). Example: ["srv-c81mtdvipqbc73eblq7g"].

environment_idstringrequired

The ID of the environment to update, as returned by render_environments_list or render_environment_create. Render environment IDs use the `evm-` prefix, e.g. evm-cq2u42dsc6pc73fnjrb0.

ip_allow_listarray

Replacement list of CIDR blocks allowed to connect to resources in this environment from outside Render's private network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description explaining what it's for. Providing this replaces the existing allow list entirely. Leave unset to keep the current list. Example: [{"cidrBlock": "203.0.113.0/24", "description": "office network"}].

namestring

New name for the environment. Leave unset to keep the current name.

network_isolation_enabledboolean

Whether network connections across environments are allowed. Set to true to isolate this environment's private network traffic from other environments in the same project; false allows cross-environment connections. Leave unset to keep the current setting.

protected_statusstring

Whether the environment is `unprotected` or `protected`. Only admin users can perform destructive actions in `protected` environments. Leave unset to keep the current setting.one of unprotectedprotected

namestringrequired

Name of the response header to set. Example: Cache-Control.

pathstringrequired

Request path this header applies to. Wildcards (*) apply the header to all matching paths. Example: /static/*.

service_idstringrequired

ID of the Render service to add the header rule to. Example: srv-c7ff2gp8fa8c73a1lj7g.

valuestringrequired

Value to set for the response header. Example: public, max-age=604800.

job_idstringrequired

The ID of the job to cancel, e.g. job-cph1rs3idesc73a2b2mg.

service_idstringrequired

The Render service ID the job belongs to.

service_idstringrequired

The Render service ID to run the one-off job against. The job runs using this service's environment (env vars, disks, etc.).

start_commandstringrequired

Shell command to execute for this job run, e.g. a database migration or a one-off maintenance script. This runs immediately in the service's environment and creates a real, billed job execution on the Render account — it is not a dry run.

plan_idstring

Resource plan to run the job on, overriding the service's default plan for this job only. Provide a Render plan ID, e.g. plan-srv-004. Leave blank to use the service's own plan.

namestringrequired

The name of the Key Value instance, shown in the Render dashboard and API responses.

owner_idstringrequired

ID of the Render workspace (team/owner) this instance belongs to. Find it via a workspace/owners list endpoint or your workspace settings.

planstringrequired

The instance plan, which determines memory size and pricing. Valid values: free, starter, standard, pro, pro_plus, custom, 256mb, 1g, 5g, 10g, 20g, 40g.one of freestarterstandardpropro_pluscustom256mb1g5g10g20g40g

environment_idstring

ID of the Render environment this instance should belong to. Environments group related resources (services, databases) together. Omit to create the instance without an environment.

ip_allow_listarray

List of CIDR blocks allowed to connect to this Key Value instance from outside Render's private network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description explaining what it's for. If omitted, Render applies its account-level default allow list. Example: [{"cidrBlock": "203.0.113.0/24", "description": "office network"}].

maxmemory_policystring

The key eviction policy to use once the instance reaches its memory limit. Valid values: noeviction, allkeys_lfu, allkeys_lru, allkeys_random, volatile_lfu, volatile_lru, volatile_random, volatile_ttl. Leave unset to use Render's default.one of noevictionallkeys_lfuallkeys_lruallkeys_randomvolatile_lfuvolatile_lruvolatile_randomvolatile_ttl

persistence_modestring

The persistence mode for the instance. The default for paid instances is journal_snapshot (both journaling and snapshots); only turn off persistence (off) if you're using this instance purely as a cache and can tolerate losing data. Free instances do not support persistence. Valid values: journal_snapshot, snapshot, off.one of journal_snapshotsnapshotoff

regionstring

The region to deploy the instance in. Valid values: frankfurt, oregon, ohio, singapore, virginia. Defaults to oregon. This cannot be changed after creation.one of frankfurtoregonohiosingaporevirginiadefault oregon

redis_idstringrequired

The ID of the Key Value instance to resume, as returned by render_key_value_instances_list or render_key_value_instance_create.

redis_idstringrequired

The ID of the Key Value instance to suspend, as returned by render_key_value_instances_list or render_key_value_instance_create.

redis_idstringrequired

The ID of the Key Value instance to update, as returned by render_key_value_instances_list or render_key_value_instance_create.

ip_allow_listarray

Replacement list of CIDR blocks allowed to connect to this Key Value instance from outside Render's private network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description explaining what it's for. Providing this replaces the existing allow list entirely. Example: [{"cidrBlock": "203.0.113.0/24", "description": "office network"}].

maxmemory_policystring

The key eviction policy to use once the instance reaches its memory limit. Valid values: noeviction, allkeys_lfu, allkeys_lru, allkeys_random, volatile_lfu, volatile_lru, volatile_random, volatile_ttl. Leave unset to keep the current policy. Changing this restarts the instance.one of noevictionallkeys_lfuallkeys_lruallkeys_randomvolatile_lfuvolatile_lruvolatile_randomvolatile_ttl

namestring

New name for the Key Value instance. Leave unset to keep the current name.

persistence_modestring

The persistence mode for the instance. Valid values: journal_snapshot, snapshot, off. Only turn off persistence if you're using this instance purely as a cache and can tolerate losing data. Leave unset to keep the current setting. Changing this restarts the instance.one of journal_snapshotsnapshotoff

planstring

New plan for the instance, which determines memory size and pricing. Valid values: free, starter, standard, pro, pro_plus, custom, 256mb, 1g, 5g, 10g, 20g, 40g. Leave unset to keep the current plan. Changing this restarts the instance.one of freestarterstandardpropro_pluscustom256mb1g5g10g20g40g

resource_idstringrequired

The ID of the resource (service, cron job, Postgres database, or Key Value/Redis instance) to update the log stream override for.

settingstringrequired

Whether this resource's log stream override should send logs to the configured endpoint or drop them. Valid values: send, drop.one of senddrop

endpointstring

The destination endpoint URL to stream this resource's logs to (e.g. a Datadog HTTP intake URL or another log collector's ingest URL). Must be present when setting is `send`; must be omitted or null when setting is `drop`.

tokenstring

Optional authentication token/API key sent to the log stream endpoint to authenticate the requests. Leave null if the endpoint does not require one.

owner_idstringrequired

The ID of the Render workspace (owner) to update log stream information for. Render workspace IDs use the `tea-` prefix, e.g. tea-cjnxpkdhshc73d12t9i0.

previewstringrequired

Whether the workspace default log stream should send logs to the configured endpoint or drop them. Valid values: send, drop.one of senddrop

endpointstring

The destination endpoint URL to stream logs to (e.g. a Datadog HTTP intake URL or another log collector's ingest URL). Required when preview is set to `send`; omit or leave null when preview is `drop`.

tokenstring

Optional authentication token/API key sent to the log stream endpoint to authenticate the requests. Leave null if the endpoint does not require one.

maintenance_run_idstringrequired

The ID of the maintenance run to trigger. Render maintenance run IDs use the `mrn-` prefix, e.g. mrn-cph1rs3idesc73a2b2mg.

maintenance_run_idstringrequired

The ID of the maintenance run to reschedule. Render maintenance run IDs use the `mrn-` prefix, e.g. mrn-cph1rs3idesc73a2b2mg.

scheduled_atstring

New date-time at which the maintenance run should start, as an ISO 8601 datetime. Must be before the run's pendingMaintenanceBy deadline (visible via render_maintenance_run_get), if one is set. This is the only field this endpoint updates, so it should normally be provided.

owner_idstringrequired

The ID of the Render workspace (owner) whose metrics stream integration should be created or updated. Render workspace IDs use the `tea-` prefix, e.g. tea-cjnxpkdhshc73d12t9i0.

providerstring

The external provider to stream metrics to. Valid values: BETTER_STACK, GRAFANA, DATADOG, NEW_RELIC, HONEYCOMB, SIGNOZ, GROUNDCOVER, LOGFIRE, CUSTOM. Required to actually configure a working stream, e.g. DATADOG.one of BETTER_STACKGRAFANADATADOGNEW_RELICHONEYCOMBSIGNOZGROUNDCOVERLOGFIRECUSTOM

tokenstring

Authentication token or API key used to authenticate against the destination URL. Required by most providers (e.g. a Datadog API key); leave blank only if the destination does not need one.

urlstring

The destination endpoint URL that Render should stream metrics to. Required together with provider to set up a working stream, e.g. https://metrics-intake.example.com/v1/ingest.

service_idstringrequired

The ID of the Render service whose notification override to update. Provide a service ID, not the ID of an override record.

notifications_to_sendstring

Override for which event outcomes should trigger a notification for this service. Valid values: none (never notify), failure (only failed events), all (every event), or default (inherit the workspace-wide setting). Omit to leave unchanged.one of defaultnonefailureall

preview_notifications_enabledstring

Override for preview-environment notifications on this service. Valid values: "true" (enable), "false" (disable), or "default" (inherit the workspace-wide setting). Omit to leave unchanged.one of defaultfalsetrue

owner_idstringrequired

The ID of the Render workspace (owner) whose notification settings to update.

email_enabledboolean

Whether to enable email notifications for this workspace. Set to true to enable, false to disable, or omit to leave unchanged.

notifications_to_sendstring

Which event outcomes should trigger a notification for this workspace. Valid values: none (never notify), failure (only failed events), all (every event). Omit to leave unchanged.one of nonefailureall

preview_notifications_enabledboolean

Whether to enable notifications for events in preview environments. Set to true to enable, false to disable, or omit to leave unchanged.

postgres_idstringrequired

The ID of the Render Postgres instance to export. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the highly available Render Postgres instance to fail over. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

namestringrequired

The name of the database as it will appear in the Render Dashboard.

owner_idstringrequired

The ID of the Render workspace to create the database for.

planstringrequired

The instance plan/size for the database, which determines its resources and pricing.one of freestarterstandardpropro_pluscustombasic_256mbbasic_1gbbasic_4gbpro_4gbpro_8gbpro_16gbpro_32gbpro_64gbpro_128gbpro_192gbpro_256gbpro_384gbpro_512gbaccelerated_16gbaccelerated_32gbaccelerated_64gbaccelerated_128gbaccelerated_256gbaccelerated_384gbaccelerated_512gbaccelerated_768gbaccelerated_1024gb0.1c-256mb0.5c-1g1c-2g1c-4g2c-4g2c-8g2c-16g4c-16g4c-32g8c-32g8c-64g16c-64g16c-128g32c-128g32c-256g48c-192g48c-384g64c-256g64c-512g96c-384g96c-768g128c-512g128c-1024g

versionstringrequired

The major PostgreSQL version to provision.one of 1112131415161718

connection_poolstring

Connection pooling mode for the new database. Valid values: pgbouncer, none. Defaults to none.one of pgbouncernone

database_namestring

The name of the underlying PostgreSQL database. If omitted, Render generates a random name.

database_userstring

The name of the PostgreSQL database user. If omitted, Render generates a random username.

datadog_api_keystring

Datadog API key for the Datadog agent to monitor the new database. Omit to skip Datadog monitoring.

datadog_sitestring

Datadog region/site to use for monitoring the new database, e.g. US1. Defaults to US1.

disk_size_gbinteger

The number of gigabytes of disk space to allocate for the database. If omitted, Render uses the plan's default disk size.

enable_disk_autoscalingboolean

Whether to automatically grow the database's disk as it fills up. Defaults to false.default false

enable_high_availabilityboolean

Whether to enable a high-availability standby for this database. Defaults to false.default false

environment_idstring

The ID of the Render environment to create this database in. Omit to create it outside of any environment.

ip_allow_listarray

List of CIDR blocks allowed to access this database from outside Render's network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description explaining what it's for. Example: [{"cidrBlock": "203.0.113.0/24", "description": "Office network"}]. Leave empty to block all external access.

parameter_overridesobject

Postgres configuration parameter overrides, as a JSON object mapping parameter name to string value. Example: {"max_connections": "200"}.

read_replicasarray

Read replica instances to create alongside the primary database. Each entry needs a name and may include parameterOverrides (a JSON object of parameter name to string value). Example: [{"name": "my-app-db-replica"}].

regionstring

The Render region to deploy this database in. Valid values: frankfurt, oregon, ohio, singapore, virginia. Defaults to oregon.one of frankfurtoregonohiosingaporevirginiadefault oregon

postgres_idstringrequired

The ID of the Render Postgres instance to restart. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Render Postgres instance to resume. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

postgres_idstringrequired

The ID of the Postgres instance to suspend. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

postgres_idstringrequired

The ID of the Postgres instance to update. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

connection_poolstring

Connection pooling mode for the database. Valid values: pgbouncer, none. Leave blank to keep the current setting.one of pgbouncernone

datadog_api_keystring

Datadog API key for the Datadog agent to monitor this database. Pass an empty string to remove existing monitoring. Changing this restarts Postgres.

datadog_sitestring

Datadog region/site to use for monitoring this database, e.g. US1. Leave blank to keep the current setting.

disk_size_gbinteger

The number of gigabytes of disk space to allocate for the database. Leave blank to keep the current disk size.

enable_disk_autoscalingboolean

Whether to automatically grow the database's disk as it fills up. Leave blank to keep the current setting.

enable_high_availabilityboolean

Whether to enable a high-availability standby for this database. Leave blank to keep the current setting.

ip_allow_listarray

Replacement list of CIDR blocks allowed to access this database from outside Render's network. Each entry needs a cidrBlock (e.g. 203.0.113.0/24) and a description. Example: [{"cidrBlock": "203.0.113.0/24", "description": "Office network"}]. Leave blank to keep the current list.

namestring

New display name for the database in the Render Dashboard. Leave blank to keep the current name.

parameter_overridesobject

Postgres configuration parameter overrides, as a JSON object mapping parameter name to string value. Example: {"max_connections": "200"}. Leave blank to keep the current overrides.

planstring

New instance plan/size for the database. Leave blank to keep the current plan.one of freestarterstandardpropro_pluscustombasic_256mbbasic_1gbbasic_4gbpro_4gbpro_8gbpro_16gbpro_32gbpro_64gbpro_128gbpro_192gbpro_256gbpro_384gbpro_512gbaccelerated_16gbaccelerated_32gbaccelerated_64gbaccelerated_128gbaccelerated_256gbaccelerated_384gbaccelerated_512gbaccelerated_768gbaccelerated_1024gb0.1c-256mb0.5c-1g1c-2g1c-4g2c-4g2c-8g2c-16g4c-16g4c-32g8c-32g8c-64g16c-64g16c-128g32c-128g32c-256g48c-192g48c-384g64c-256g64c-512g96c-384g96c-768g128c-512g128c-1024g

read_replicasarray

Read replica instances to create alongside the primary database. Each entry needs a name and may include parameterOverrides (a JSON object of parameter name to string value). Example: [{"name": "my-app-db-replica"}]. Leave blank to keep the current replicas.

postgres_idstringrequired

The ID of the Postgres instance to recover from. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1rs3idesc73a2b2mg.

datadog_api_keystring

Datadog API key to use for monitoring the new restored database. Defaults to the API key of the original database. Pass an empty string to prevent copying the API key to the new database.

datadog_sitestring

Datadog region/site to use for monitoring the new restored database. Defaults to the region code of the original database. Pass an empty string to prevent copying the region code.

environment_idstring

The Render environment to create the new restored database in. Defaults to the environment of the original database.

planstring

The instance plan to use for the new restored database. Defaults to the same plan as the original database. Cannot be a lower tier plan than the original database.

restore_namestring

Display name for the new database created by this recovery. If omitted, Render assigns a default name.

restore_timestring

The point in time to restore the database to, as an ISO 8601 datetime. Check render_postgres_recovery_info_get for the available restore window (startsAt through now).

postgres_idstringrequired

The ID of the Render Postgres instance to create the user on. Render Postgres IDs use the `dpg-` prefix, e.g. dpg-cph1qb3idesc73a2a3ig.

usernamestringrequired

Name for the new PostgreSQL user. This user becomes the database's new default user once created.

environmentsarrayrequired

The environments to create along with the project. Provide an array of environment objects, each with a required name, and optionally a protectedStatus ("unprotected" or "protected" — only admins can perform destructive actions in a protected environment), a networkIsolationEnabled flag (whether connections across environments are allowed), and an ipAllowList (array of {cidrBlock, description} objects restricting inbound access). Example: [{"name": "production", "protectedStatus": "protected"}].

namestringrequired

The name of the project.

owner_idstringrequired

The ID of the Render workspace (owner) that the project belongs to. Workspace IDs use the `tea-` prefix.

namestringrequired

New name for the project. Required — Render's update endpoint has no other field to change and rejects a request that omits it.

project_idstringrequired

The ID of the project to update. Render project IDs use the `prj-` prefix, e.g. prj-c9pn6ffds738e88f0i8g.

namestringrequired

The name of the new Redis instance. Must be unique within the owning workspace. Example: my-redis-cache.

owner_idstringrequired

The ID of the Render workspace (owner) that will own this Redis instance. Render workspace IDs use the `tea-` (team) or `usr-` (user) prefix.

planstringrequired

The instance plan, which determines available memory and price. Valid values: free, starter, standard, pro, pro_plus, custom, 256mb, 1g, 5g, 10g, 20g, 40g.one of freestarterstandardpropro_pluscustom256mb1g5g10g20g40g

environment_idstring

The ID of the Render environment to associate the new Redis instance with. Omit to create it without an environment.

ip_allow_listarray

List of CIDR blocks allowed to access the Redis instance from outside Render. Each entry needs a cidrBlock (e.g. "203.0.113.0/24") and a human-readable description. Omit to leave the existing/default allow list rules in place.

maxmemory_policystring

The eviction policy to use once the instance reaches its memory limit. Valid values: noeviction, allkeys_lfu, allkeys_lru, allkeys_random, volatile_lfu, volatile_lru, volatile_random, volatile_ttl. Omit to use Render's default.one of noevictionallkeys_lfuallkeys_lruallkeys_randomvolatile_lfuvolatile_lruvolatile_randomvolatile_ttl

persistence_modestring

The persistence mode for the Redis instance. Valid values: journal_snapshot (both journaling and snapshots, the default for paid instances), snapshot, or off. Only turn persistence off if you're using this instance purely as a cache and are okay with losing data on restart. Free instances do not have persistence.one of journal_snapshotsnapshotoff

regionstring

The region to deploy the Redis instance in. Valid values: frankfurt, oregon, ohio, singapore, virginia. Defaults to oregon.one of frankfurtoregonohiosingaporevirginiadefault oregon

redis_idstringrequired

The ID of the Redis instance to resume. Render Redis instance IDs use the `red-` prefix, e.g. red-abc123.

redis_idstringrequired

The ID of the Redis instance to suspend. Render Redis instance IDs use the `red-` prefix, e.g. red-abc123.

redis_idstringrequired

The ID of the Redis instance to update. Render Redis instance IDs use the `red-` prefix, e.g. red-abc123.

ip_allow_listarray

Replacement list of CIDR blocks allowed to access the Redis instance from outside Render. Each entry needs a cidrBlock (e.g. "203.0.113.0/24") and a human-readable description. Omit to leave the existing allow list unchanged.

maxmemory_policystring

The eviction policy to use once the instance reaches its memory limit. Valid values: noeviction, allkeys_lfu, allkeys_lru, allkeys_random, volatile_lfu, volatile_lru, volatile_random, volatile_ttl. Omit to leave it unchanged.one of noevictionallkeys_lfuallkeys_lruallkeys_randomvolatile_lfuvolatile_lruvolatile_randomvolatile_ttl

namestring

New name for the Redis instance. Omit to leave the current name unchanged.

persistence_modestring

The persistence mode for the Redis instance. Valid values: journal_snapshot (both journaling and snapshots), snapshot, or off. Only turn persistence off if you're using this instance purely as a cache and are okay with losing data on restart. Omit to leave it unchanged.one of journal_snapshotsnapshotoff

planstring

New instance plan, which determines available memory and price. Valid values: free, starter, standard, pro, pro_plus, custom, 256mb, 1g, 5g, 10g, 20g, 40g. Omit to leave the current plan unchanged.one of freestarterstandardpropro_pluscustom256mb1g5g10g20g40g

auth_tokenstringrequired

Authentication token or password used to pull images from the registry, e.g. a Docker Hub access token, a GitHub/GitLab personal access token with registry read scope, or the equivalent credential for Google Artifact Registry / AWS ECR. Render stores this securely and never returns it from the API.

namestringrequired

Descriptive name to identify this credential in the Render dashboard and API, e.g. "prod-docker-hub".

owner_idstringrequired

ID of the Render workspace (team/owner) this credential belongs to. Find it in your Render workspace settings or via a workspace/owners list endpoint. Example: tea-cjnxpkdhshc73d12t9i0.

registrystringrequired

Container registry provider this credential authenticates with. Valid values: GITHUB (GitHub Container Registry), GITLAB (GitLab Container Registry), DOCKER (Docker Hub), GOOGLE_ARTIFACT (Google Artifact Registry), AWS_ECR (Amazon Elastic Container Registry).one of GITHUBGITLABDOCKERGOOGLE_ARTIFACTAWS_ECR

usernamestringrequired

Username to authenticate with the registry, e.g. your Docker Hub username, GitHub/GitLab account or org name, or the specific literal username your registry provider requires (check its docs, e.g. Google Artifact Registry commonly uses "oauth2accesstoken").

auth_tokenstringrequired

New authentication token or password used to pull images from the registry, e.g. a Docker Hub access token, a GitHub/GitLab personal access token with registry read scope, or the equivalent credential for Google Artifact Registry / AWS ECR. Render stores this securely and never returns it from the API. Must be supplied on every update even if unchanged.

namestringrequired

New descriptive name to identify this credential in the Render dashboard and API, e.g. "prod-docker-hub". Must be supplied on every update even if unchanged.

registrystringrequired

Container registry provider this credential authenticates with. Valid values: GITHUB (GitHub Container Registry), GITLAB (GitLab Container Registry), DOCKER (Docker Hub), GOOGLE_ARTIFACT (Google Artifact Registry), AWS_ECR (Amazon Elastic Container Registry). Must be supplied on every update even if unchanged.one of GITHUBGITLABDOCKERGOOGLE_ARTIFACTAWS_ECR

registry_credential_idstringrequired

The ID of the registry credential to update, as returned by render_registry_credentials_list or render_registry_credential_create, e.g. rgc-d0m3n1a1fgac73c3jkfg.

usernamestringrequired

New username to authenticate with the registry, e.g. your Docker Hub username, GitHub/GitLab account or org name, or the specific literal username your registry provider requires. Must be supplied on every update even if unchanged.

destinationstringrequired

The destination path (or full URL for redirects) that matching requests are sent or rewritten to. Example: /foo/:bar.

service_idstringrequired

The ID of the Render service to add the rule to. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

sourcestringrequired

The source path pattern to match against incoming requests. Supports Render's path-matching syntax, including wildcards/placeholders like `:bar`. Example: /:bar/foo.

typestringrequired

The kind of rule to create. `redirect` sends the client an HTTP redirect to the destination; `rewrite` serves the destination's content while keeping the original URL.one of redirectrewrite

priorityinteger

Priority at which this rule is evaluated; rules are applied starting at priority 0. Leave blank to add the rule at the end of the current priority list.

priorityintegerrequired

The new priority to move this rule to. Rules are applied in priority order starting at 0; Render shifts other rules' priorities by 1 as needed to make space for this change.

route_idstringrequired

The ID of the redirect/rewrite rule to update. Get this from render_routes_list.

service_idstringrequired

The ID of the Render service the rule belongs to. Render service IDs use the `srv-` prefix, e.g. srv-abc123def456.

cpu_enabledbooleanrequired

Whether CPU utilization should be used as an autoscaling trigger for this service.

cpu_target_percentageintegerrequired

The target average CPU utilization percentage, e.g. 60. If actual utilization is significantly above or below this target, Render increases or decreases the instance count.

enabledbooleanrequired

Whether autoscaling should be enabled for this service. Set false to keep the configuration stored but inactive.

max_instancesintegerrequired

The maximum number of instances Render is allowed to scale this service up to, e.g. 5.

memory_enabledbooleanrequired

Whether memory utilization should be used as an autoscaling trigger for this service.

memory_target_percentageintegerrequired

The target average memory utilization percentage, e.g. 60. If actual utilization is significantly above or below this target, Render increases or decreases the instance count.

min_instancesintegerrequired

The minimum number of instances Render should keep running for this service, e.g. 1.

service_idstringrequired

The ID of the Render service whose autoscaling config to update. Render service IDs use the `srv-` prefix, e.g. srv-abc123.

service_idstringrequired

The ID of the Render web service whose cache should be purged. Service IDs start with the `srv-` prefix and can be found via render_services_list or the Render Dashboard.

namestringrequired

The service's name. Must be unique within the workspace.

owner_idstringrequired

The ID of the Render workspace the service belongs to. Find it on the workspace's Settings page in the Render Dashboard.

typestringrequired

The kind of service to create. Valid values: static_site (static frontend assets), web_service (an app that serves HTTP traffic), private_service (an app reachable only from other services in the same workspace), background_worker (a long-running process with no public endpoint), or cron_job (a task that runs on a schedule).one of static_siteweb_serviceprivate_servicebackground_workercron_job

auto_deploystring

Whether Render automatically deploys new commits pushed to the configured branch. Valid values: yes, no. Defaults to yes.one of yesnodefault yes

branchstring

The repo branch to pull, build, and deploy. If omitted, uses the repository's default branch.

build_commandstring

Shell command Render runs to build the service. For static_site this is the only build field needed. For web_service/private_service/background_worker/cron_job with a native (non-docker) runtime, this is required together with start_command.

build_filter_ignored_pathsarray

List of path glob patterns; a new commit does not trigger a deploy if it only changes files matching these paths. Provide together with build_filter_paths.

build_filter_pathsarray

List of path glob patterns; a new commit only triggers a deploy if it changes a file matching one of these paths. Provide together with build_filter_ignored_paths.

disk_mount_pathstring

Filesystem path where the persistent disk is mounted inside the service. Applies to web_service, private_service, and background_worker only. Provide together with disk_name.

disk_namestring

Name for a persistent disk to attach to the service. Applies to web_service, private_service, and background_worker only. Provide together with disk_mount_path.

disk_size_gbinteger

Size of the persistent disk in gigabytes. Only used when disk_name/disk_mount_path are set. Defaults to 1.default 1

docker_commandstring

Overrides the Dockerfile's CMD instruction. Only used when runtime is docker.

docker_contextstring

Path to the Docker build context, relative to the repo root. Only used when runtime is docker.

docker_dockerfile_pathstring

Path to the Dockerfile, relative to the repo root. Only used when runtime is docker. Defaults to ./Dockerfile if omitted.

docker_registry_credential_idstring

ID of a stored registry credential to use when pulling the base image for this docker build. Only used when runtime is docker, for web_service, private_service, and background_worker. Not supported for cron_job via this tool (Render's API models the cron job registry credential differently); create the cron job without one and attach a credential from the Render Dashboard afterward if needed.

env_varsarray

Environment variables to set on the new service. Each item is an object with a key and either a literal value string, or generateValue: true to have Render generate a strong random value for that key. Example: [{"key": "NODE_ENV", "value": "production"}, {"key": "SESSION_SECRET", "generateValue": true}].

environment_idstring

The ID of the Render environment this service belongs to, if any. Find it on the environment's Settings page in the Render Dashboard.

health_check_pathstring

HTTP path Render polls to determine whether the web service is healthy. Applies to web_service only.

image_owner_idstring

ID of the workspace that owns this image; should match owner_id and the owner of any registry credential. Required when image_path is set. Defaults to owner_id if left blank.

image_pathstring

Path to the container image to deploy, e.g. docker.io/library/nginx:latest. Set this (with image_owner_id) instead of repo/branch to create an image-backed service without a connected Git repo.

image_registry_credential_idstring

ID of a stored registry credential used to pull the image, if the registry requires authentication.

ip_allow_listarray

List of CIDR blocks allowed to access the service; requests from other IPs are blocked. Each item needs a cidrBlock and a human-readable description. Applies to static_site and web_service only. Example: [{"cidrBlock": "203.0.113.0/24", "description": "office network"}].

maintenance_mode_enabledboolean

Whether to put the web service into maintenance mode, serving a maintenance page instead of the app. Applies to web_service only. Provide together with maintenance_mode_uri.

maintenance_mode_uristring

The page to serve when maintenance mode is enabled. When empty, Render's default maintenance page is served. Applies to web_service only. Provide together with maintenance_mode_enabled.

max_shutdown_delay_secondsinteger

Maximum time, in seconds (1-300), Render waits for your process to exit gracefully after sending SIGTERM. Applies to web_service, private_service, and background_worker. Defaults to 30.default 30

num_instancesinteger

For a manually-scaled service, the number of instances to run. Applies to web_service, private_service, and background_worker only (not static_site or cron_job). Defaults to 1.default 1

planstring

The compute plan to use. Applies to web_service, private_service, background_worker, and cron_job (not static_site, which is free). Web Services may additionally use free, custom, or a *_legacy plan. If omitted, Private Services, Background Workers, and Cron Jobs default to 0.5c-512mb; Web Services require an explicit choice.one of starterstarter_plusstandardstandard_pluspropro_pluspro_maxpro_ultrafreecustomstarter_legacystandard_legacystandard_plus_legacypro_legacypro_plus_legacy0.5c-512mb1c-2g2c-4g2c-8g2c-16g4c-8g4c-16g4c-32g8c-16g8c-32g8c-64g12c-24g12c-48g12c-96g

pre_deploy_commandstring

Shell command Render runs before starting a new deploy (e.g. database migrations). Applies to web_service, private_service, background_worker, and cron_job (not static_site).

previews_generationstring

Controls automatic preview environments for pull requests. Valid values: off, manual, automatic. Applies to static_site, web_service, private_service, and background_worker (not cron_job). Defaults to off.one of offmanualautomaticdefault off

publish_pathstring

Directory (relative to the repo root, after build) that Render serves as the site's contents. Applies to static_site only. Defaults to public.default public

regionstring

Region to deploy the service in. Valid values: frankfurt, oregon, ohio, singapore, virginia. Applies to web_service, private_service, background_worker, and cron_job (not static_site). Defaults to oregon.one of frankfurtoregonohiosingaporevirginiadefault oregon

render_subdomain_policystring

Controls whether the service's *.onrender.com subdomain is reachable. Valid values: enabled, disabled. Applies to static_site and web_service only.one of enableddisabled

repostring

The service's Git repository URL. Do not include a branch in this string; use branch instead. Required for repo-backed services unless image_path/image_owner_id are provided instead for an image-backed service.

root_dirstring

Directory (relative to the repo root) where Render looks for code to build and deploy, e.g. for a monorepo.

runtimestring

The runtime/language environment the service runs in. Valid values: docker, elixir, go, node, python, ruby, rust, image. Required for web_service, private_service, background_worker, and cron_job (not used for static_site). When set to docker, use the docker_* fields below instead of build_command/start_command; use image for a service deployed purely from a container image.one of dockerelixirgonodepythonrubyrustimage

schedulestring

Cron expression controlling when the job runs, e.g. 0 0 * * * for daily at midnight UTC. Required for cron_job; not used for other service types.

secret_filesarray

Secret files to create on the new service. Each item is an object with a name and its content as a string. Example: [{"name": ".env", "content": "KEY=value"}].

start_commandstring

Shell command Render runs to start the service. Required together with build_command for web_service, private_service, background_worker, and cron_job when runtime is a native (non-docker) runtime. Not used for static_site or when runtime is docker.