{ "opencollection": "1.0.0", "info": { "name": "Render Public API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Blueprints", "type": "folder" }, "items": [ { "info": { "name": "List Blueprints", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/blueprints", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has access to.\n" }, { "info": { "name": "Validate Blueprint", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/blueprints/validate", "body": { "type": "multipart-form", "data": [ { "name": "ownerId", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Validate a `render.yaml` Blueprint file without creating or modifying any resources. This endpoint checks the syntax and structure of the Blueprint, validates that all required fields are present, and returns a plan indicating the resources that would be created.\n\nRequests to this endpoint use `Content-Type: multipart/form-data`. The provided Blueprint file cannot exceed 10MB in size.\n" }, { "info": { "name": "Retrieve Blueprint", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/blueprints/:blueprintId", "params": [ { "name": "blueprintId", "value": "", "type": "path", "description": "The ID of the Blueprint" } ] }, "docs": "Retrieve the Blueprint with the provided ID.\n" }, { "info": { "name": "Update Blueprint", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/blueprints/:blueprintId", "params": [ { "name": "blueprintId", "value": "", "type": "path", "description": "The ID of the Blueprint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Blueprint with the provided ID.\n" }, { "info": { "name": "Disconnect Blueprint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/blueprints/:blueprintId", "params": [ { "name": "blueprintId", "value": "", "type": "path", "description": "The ID of the Blueprint" } ] }, "docs": "Disconnect the Blueprint with the provided ID.\n\nDisconnecting a Blueprint stops automatic resource syncing via the associated `render.yaml` file. It does not _delete_ any services or other resources that were managed by the blueprint.\n" }, { "info": { "name": "List Blueprint syncs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/blueprints/:blueprintId/syncs", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List syncs for the Blueprint with the provided ID.\n" } ] }, { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "Update workspace member role", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/owners/:ownerId/members/:userId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return resources for" }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user (Render object ID with a `usr-` prefix)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role of an existing workspace member.\n" }, { "info": { "name": "Remove workspace member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/owners/:ownerId/members/:userId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return resources for" }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user (Render object ID with a `usr-` prefix)." } ] }, "docs": "Remove a user from the specified workspace.\n" }, { "info": { "name": "List workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/owners", "params": [ { "name": "name", "value": "", "type": "query", "description": "Only return workspaces with one of the provided names. Only exact matches are returned." }, { "name": "email", "value": "", "type": "query", "description": "Only return workspaces owned by one of the provided email addresses." }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List the workspaces that your API key has access to, optionally filtered by name or owner email address.\n" }, { "info": { "name": "Retrieve workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/owners/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the user or team" } ] }, "docs": "Retrieve the workspace with the provided ID.\n\nWorkspace IDs start with `tea-`. If you provide a user ID (starts with `own-`), this endpoint returns the user's default workspace.\n" }, { "info": { "name": "List workspace members", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/owners/:ownerId/members", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the team" } ] }, "docs": "Retrieves the list of users belonging to the workspace with the provided ID.\n" } ] }, { "info": { "name": "Disks", "type": "folder" }, "items": [ { "info": { "name": "List disks", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/disks", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "diskId", "value": "", "type": "query", "description": "Filter by disk IDs" }, { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "serviceId", "value": "", "type": "query", "description": "Filter for resources by service ID" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view.\n" }, { "info": { "name": "Add disk", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/disks", "body": { "type": "json", "data": "{}" } }, "docs": "Attach a persistent disk to a web service, private service, or background worker.\n\nThe service must be redeployed for the disk to be attached.\n" }, { "info": { "name": "Retrieve disk", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/disks/:diskId", "params": [ { "name": "diskId", "value": "", "type": "path", "description": "The ID of the disk" } ] }, "docs": "Retrieve the persistent disk with the provided ID.\n" }, { "info": { "name": "Update disk", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/disks/:diskId", "params": [ { "name": "diskId", "value": "", "type": "path", "description": "The ID of the disk" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the persistent disk with the provided ID.\n\nThe disk's associated service must be deployed and active for updates to take effect.\n\nWhen resizing a disk, the new size must be greater than the current size.\n" }, { "info": { "name": "Delete disk", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/disks/:diskId", "params": [ { "name": "diskId", "value": "", "type": "path", "description": "The ID of the disk" } ] }, "docs": "Delete a persistent disk attached to a service.\n\n**All data on the disk will be lost.** The disk's associated service will immediately lose access to it.\n" }, { "info": { "name": "List snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/disks/:diskId/snapshots", "params": [ { "name": "diskId", "value": "", "type": "path", "description": "The ID of the disk" } ] }, "docs": "List snapshots for the persistent disk with the provided ID. Each snapshot is a point-in-time copy of the disk's data.\n" }, { "info": { "name": "Restore snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/disks/:diskId/snapshots/restore", "params": [ { "name": "diskId", "value": "", "type": "path", "description": "The ID of the disk" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore a persistent disk to an available snapshot.\n\n**This operation is irreversible.** It will overwrite the current disk data. It might also trigger a service deploy.\n\nSnapshot keys returned from the [List snapshots](https://api-docs.render.com/reference/list-snapshots) endpoint expire after 24 hours. If a snapshot key has expired, query the endpoint again for a new key.\n" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/users" }, "docs": "Retrieve the user associated with the provided API key.\n" } ] }, { "info": { "name": "Audit Logs", "type": "folder" }, "items": [ { "info": { "name": "List workspace audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/owners/:ownerId/audit-logs", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return resources for" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time for filtering audit logs (ISO 8601 format)" }, { "name": "endTime", "value": "", "type": "query", "description": "End time for filtering audit logs (ISO 8601 format)" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to query logs for. Backward will return most recent logs first.\nForward will start with the oldest logs in the time range.\n" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "Retrieve audit logs for a specific workspace with optional filtering and pagination.\n" }, { "info": { "name": "List organization audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/organizations/:orgId/audit-logs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time for filtering audit logs (ISO 8601 format)" }, { "name": "endTime", "value": "", "type": "query", "description": "End time for filtering audit logs (ISO 8601 format)" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to query logs for. Backward will return most recent logs first.\nForward will start with the oldest logs in the time range.\n" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "Retrieve audit logs for a specific organization with optional filtering and pagination.\n" } ] }, { "info": { "name": "Notification Settings", "type": "folder" }, "items": [ { "info": { "name": "Retrieve notification settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/notification-settings/owners/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return resources for" } ] }, "docs": "Retrieve notification settings for the owner with the provided ID.\n\nNote that you provide an owner ID to this endpoint, not the ID for a particular resource.\n" }, { "info": { "name": "Update notification settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/notification-settings/owners/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return resources for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update notification settings for the owner with the provided ID.\n" }, { "info": { "name": "List notification overrides", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/notification-settings/overrides", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "serviceId", "value": "", "type": "query", "description": "Filter for resources by service ID" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List notification overrides matching the provided filters. If no filters are provided, returns all notification overrides for all workspaces the user belongs to.\n" }, { "info": { "name": "Retrieve notification override", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/notification-settings/overrides/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Retrieve the notification override for the service with the provided ID.\n\nNote that you provide a service ID to this endpoint, not the ID for a particular override.\n" }, { "info": { "name": "Update notification override", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/notification-settings/overrides/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the notification override for the service with the provided ID.\n" } ] }, { "info": { "name": "Registry Credentials", "type": "folder" }, "items": [ { "info": { "name": "List registry credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/registrycredentials", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter for the name of a credential" }, { "name": "username", "value": "", "type": "query", "description": "Filter for the username of a credential" }, { "name": "type", "value": "", "type": "query", "description": "Filter for the registry type for the credential" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for services created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for services created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for services updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for services updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List registry credentials matching the provided filters. If no filters are provided, returns all registry credentials you have permissions to view.\n" }, { "info": { "name": "Create registry credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/registrycredentials", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new registry credential." }, { "info": { "name": "Retrieve registry credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/registrycredentials/:registryCredentialId", "params": [ { "name": "registryCredentialId", "value": "", "type": "path", "description": "The ID of the registry credential" } ] }, "docs": "Retrieve the registry credential with the provided ID." }, { "info": { "name": "Update registry credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/registrycredentials/:registryCredentialId", "params": [ { "name": "registryCredentialId", "value": "", "type": "path", "description": "The ID of the registry credential" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the registry credential with the provided ID. Services that use this credential must be redeployed to use updated values." }, { "info": { "name": "Delete registry credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/registrycredentials/:registryCredentialId", "params": [ { "name": "registryCredentialId", "value": "", "type": "path", "description": "The ID of the registry credential" } ] }, "docs": "Delete the registry credential with the provided ID." } ] }, { "info": { "name": "Services", "type": "folder" }, "items": [ { "info": { "name": "List services", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "type", "value": "", "type": "query", "description": "Filter for types of services" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "env", "value": "", "type": "query", "description": "Filter for environments (runtimes) of services (deprecated; use `runtime` instead)" }, { "name": "region", "value": "", "type": "query", "description": "Filter by resource region" }, { "name": "suspended", "value": "", "type": "query", "description": "Filter resources based on whether they're suspended or not suspended" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "includePreviews", "value": "", "type": "query", "description": "Include previews in the response" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List services matching the provided filters. If no filters are provided, returns all services you have permissions to view.\n" }, { "info": { "name": "Create service", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Render service in the specified workspace with the specified configuration.\n" }, { "info": { "name": "Retrieve service", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Retrieve the service with the provided ID.\n" }, { "info": { "name": "Update service", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the service with the provided ID.\n" }, { "info": { "name": "Delete service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Delete the service with the provided ID.\n" }, { "info": { "name": "Purge Web Service Cache", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/cache/purge", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Trigger cache purge for the web service if caching is enabled.\n" }, { "info": { "name": "List environment variables", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/env-vars", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List all environment variables for the service with the provided ID.\n" }, { "info": { "name": "Update environment variables", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/env-vars", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace all environment variables for a service with the provided list of environment variables." }, { "info": { "name": "Retrieve environment variable", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ] }, "docs": "Retrieve a particular environment variable for a particular service.\n\nThis only applies to environment variables set directly on the service, not to environment variables in a linked environment group.\n" }, { "info": { "name": "Add or update environment variable", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update a particular environment variable for a particular service.\n\nThis only applies to environment variables set directly on the service, not to environment variables in a linked environment group.\n" }, { "info": { "name": "Delete environment variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/env-vars/:envVarKey", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ] }, "docs": "Delete a particular environment variable from a particular service.\n\nThis only applies to environment variables set directly on the service, not to environment variables in a linked environment group.\n" }, { "info": { "name": "List secret files", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/secret-files", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List all secret files for the service with the provided ID.\n" }, { "info": { "name": "Update secret files", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/secret-files", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace all secret files for a service with the provided list of secret files.\n\n**Any of the service's existing secret files not included in this request will be deleted.**\n\nThis only applies to secret files set directly on the service, not to secret files in a linked environment group.\n" }, { "info": { "name": "Retrieve secret file", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "secretFileName", "value": "", "type": "path", "description": "The file name of the secret file" } ] }, "docs": "Retrieve a particular secret file for a particular service.\n\nThis only applies to secret files set directly on the service, not to secret files in a linked environment group.\n" }, { "info": { "name": "Add or update secret file", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "secretFileName", "value": "", "type": "path", "description": "The file name of the secret file" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update a particular secret file for a particular service.\n\nThis only applies to secret files set directly on the service, not to secret files in a linked environment group.\n" }, { "info": { "name": "Delete secret file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/secret-files/:secretFileName", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "secretFileName", "value": "", "type": "path", "description": "The file name of the secret file" } ] }, "docs": "Delete a particular secret file from a particular service.\n\nThis only applies to secret files set directly on the service, not to secret files in a linked environment group.\n" }, { "info": { "name": "List events", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/events", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "type", "value": "", "type": "query", "description": "The type of event to filter to" }, { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List recent events that occurred for the service with the provided ID." }, { "info": { "name": "Suspend service", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/suspend", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Suspend the service with the provided ID.\n" }, { "info": { "name": "Resume service", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/resume", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Resume the service with the provided ID (if it's currently suspended).\n" }, { "info": { "name": "Restart service", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/restart", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Restart the service with the provided ID.\n\nNot supported for cron jobs.\n" }, { "info": { "name": "Scale instance count", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/scale", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "[Scale](https://render.com/docs/scaling#manual-scaling) the service with the provided ID to a fixed number of instances.\n\nRender ignores this value as long as autoscaling is enabled for the service.\n" }, { "info": { "name": "Update autoscaling config", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/autoscaling", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the [autoscaling](https://render.com/docs/scaling#autoscaling) config for the service with the provided ID.\n" }, { "info": { "name": "Delete autoscaling config", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/autoscaling", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Delete the autoscaling config for a service given the service id.\n" }, { "info": { "name": "Create service preview (image-backed)", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/preview", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a preview instance for an image-backed service. The preview uses the settings of the base service (referenced by `serviceId`), except settings overridden via provided parameters.\n\nView all active previews from your service's Previews tab in the Render Dashboard.\n\nNote that you can't create previews for Git-backed services using the Render API.\n" }, { "info": { "name": "List instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/instances", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "List instances for the provided service." } ] }, { "info": { "name": "Deploys", "type": "folder" }, "items": [ { "info": { "name": "List deploys", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/deploys", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "status", "value": "", "type": "query", "description": "Filter for deploys with the specified statuses" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for deploys created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for deploys created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for deploys updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for deploys updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "finishedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for deploys finished before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "finishedAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for deploys finished after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List deploys matching the provided filters. If no filters are provided, all deploys for the service are returned.\n" }, { "info": { "name": "Trigger deploy", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/deploys", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger a deploy for the service with the provided ID.\n" }, { "info": { "name": "Retrieve deploy", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/deploys/:deployId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "deployId", "value": "", "type": "path", "description": "The ID of the deploy" } ] }, "docs": "Retrieve the details of a particular deploy for a particular service.\n" }, { "info": { "name": "Cancel deploy", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/deploys/:deployId/cancel", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "deployId", "value": "", "type": "path", "description": "The ID of the deploy" } ] }, "docs": "Cancel an in-progress deploy for a service.\n\nNot supported for cron jobs.\n" }, { "info": { "name": "Roll back deploy", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/rollback", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger a rollback to a previous deploy of the specified service.\n\nTriggering a rollback with this endpoint does not disable autodeploys for the service. This means an autodeploy might restore changes you had intentionally rolled back.\n\nYou can toggle autodeploys for your service with the [Update service](https://api-docs.render.com/reference/update-service) endpoint or in the Render Dashboard.\n" } ] }, { "info": { "name": "Services - Headers", "type": "folder" }, "items": [ { "info": { "name": "List header rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/headers", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "path", "value": "", "type": "query", "description": "Filter for specific paths that headers apply to" }, { "name": "name", "value": "", "type": "query", "description": "Filter for header names" }, { "name": "value", "value": "", "type": "query", "description": "Filter for header values" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List a particular service's response header rules that match the provided filters. If no filters are provided, all rules for the service are returned.\n" }, { "info": { "name": "Add header rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/headers", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a response header rule to the service with the provided ID.\n" }, { "info": { "name": "Replace header rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/headers", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace all header rules for a particular service with the provided list.\n\n**This deletes all existing header rules for the service that aren't included in the request.**\n" }, { "info": { "name": "Delete header rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/headers/:headerId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "headerId", "value": "", "type": "path", "description": "The id of the header" } ] }, "docs": "Delete a particular response header rule for a particular service.\n" } ] }, { "info": { "name": "Services - Routes", "type": "folder" }, "items": [ { "info": { "name": "List redirect/rewrite rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/routes", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "type", "value": "", "type": "query", "description": "Filter for the type of route rule" }, { "name": "source", "value": "", "type": "query", "description": "Filter for the source path of the route" }, { "name": "destination", "value": "", "type": "query", "description": "Filter for the destination path of the route" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List a particular service's redirect/rewrite rules that match the provided filters. If no filters are provided, all rules for the service are returned.\n" }, { "info": { "name": "Add redirect/rewrite rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/routes", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add redirect/rewrite rules to the service with the provided ID.\n" }, { "info": { "name": "Update redirect/rewrite rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/services/:serviceId/routes", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace all redirect/rewrite rules for a particular service with the provided list.\n\n**This deletes all existing redirect/rewrite rules for the service that aren't included in the request.**\n\nRule priority is assigned according to list order (the first rule in the list has the highest priority).\n" }, { "info": { "name": "Update redirect/rewrite rule priority", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/services/:serviceId/routes", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the priority for a particular redirect/rewrite rule.\n\nTo apply redirect/rewrite rules to an incoming request, Render starts from the rule with priority `0` and applies the first encountered rule that matches the request's path (if any).\n\nRender increments the priority of other rules by `1` as necessary to make space for the updated rule.\n" }, { "info": { "name": "Delete redirect/rewrite rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/routes/:routeId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "routeId", "value": "", "type": "path", "description": "The id of the route" } ] }, "docs": "Delete a particular redirect/rewrite rule for a particular service.\n" } ] }, { "info": { "name": "Custom Domains", "type": "folder" }, "items": [ { "info": { "name": "List custom domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/custom-domains", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "name", "value": "", "type": "query", "description": "Filter for the names of custom domain" }, { "name": "domainType", "value": "", "type": "query", "description": "Filter for domain type" }, { "name": "verificationStatus", "value": "", "type": "query", "description": "Filter for domain verification status (`verified` or `unverified`)" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for custom domains created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for custom domains created after a certain time (specified as an ISO 8601 timestamp)" } ] }, "docs": "List a particular service's custom domains that match the provided filters. If no filters are provided, all custom domains for the service are returned.\n" }, { "info": { "name": "Add custom domain", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/custom-domains", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a custom domain to the service with the provided ID.\n" }, { "info": { "name": "Retrieve custom domain", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/custom-domains/:customDomainIdOrName", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "customDomainIdOrName", "value": "", "type": "path", "description": "The ID or name of the custom domain" } ] }, "docs": "Retrieve a particular custom domain for a particular service.\n" }, { "info": { "name": "Delete custom domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/services/:serviceId/custom-domains/:customDomainIdOrName", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "customDomainIdOrName", "value": "", "type": "path", "description": "The ID or name of the custom domain" } ] }, "docs": "Delete a custom domain for a service given the service id and custom domain id or name.\n" }, { "info": { "name": "Verify DNS configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/custom-domains/:customDomainIdOrName/verify", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "customDomainIdOrName", "value": "", "type": "path", "description": "The ID or name of the custom domain" } ] }, "docs": "Verify the DNS configuration for a custom domain.\n" } ] }, { "info": { "name": "One-Off Jobs", "type": "folder" }, "items": [ { "info": { "name": "List jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/jobs", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "status", "value": "", "type": "query", "description": "Filter for the status of the job (`pending`, `running`, `succeeded`, `failed`, or `canceled`)" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for jobs created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for jobs created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "startedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for jobs started before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "startedAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for jobs started after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "finishedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for jobs finished before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "finishedAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for jobs finished after a certain time (specified as an ISO 8601 timestamp)" } ] }, "docs": "List jobs for the provided service that match the provided filters. If no filters are provided, all jobs for the service are returned.\n" }, { "info": { "name": "Create job", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/jobs", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a one-off job using the provided service. For details, see [One-Off Jobs](https://render.com/docs/one-off-jobs).\n" }, { "info": { "name": "Retrieve job", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/services/:serviceId/jobs/:jobId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job" } ] }, "docs": "Retrieve the details of a particular one-off job for a particular service.\n" }, { "info": { "name": "Cancel running job", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/services/:serviceId/jobs/:jobId/cancel", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Cancel a particular one-off job for a particular service.\n" } ] }, { "info": { "name": "Services - Cron Jobs", "type": "folder" }, "items": [ { "info": { "name": "Trigger cron job run", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/cron-jobs/:cronJobId/runs", "params": [ { "name": "cronJobId", "value": "", "type": "path", "description": "The ID of the cron job" } ] }, "docs": "Trigger a run for a cron job and cancel any active runs." }, { "info": { "name": "Cancel running cron job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/cron-jobs/:cronJobId/runs", "params": [ { "name": "cronJobId", "value": "", "type": "path", "description": "The ID of the cron job" } ] }, "docs": "Cancel a currently running cron job." } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Retrieve event", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "The ID of the event" } ] }, "docs": "Retrieve the details of a particular event\n" } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "List logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspace to return logs for" }, { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to query logs for. Backward will return most recent logs first.\nForward will start with the oldest logs in the time range.\n" }, { "name": "resource", "value": "", "type": "query", "description": "Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow." }, { "name": "instance", "value": "", "type": "query", "description": "Filter logs by the instance they were emitted from. An instance is the id of a specific running server." }, { "name": "host", "value": "", "type": "query", "description": "Filter request logs by their host. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "statusCode", "value": "", "type": "query", "description": "Filter request logs by their status code. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "method", "value": "", "type": "query", "description": "Filter request logs by their requests method. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "task", "value": "", "type": "query", "description": "Filter logs by their task(s)" }, { "name": "taskRun", "value": "", "type": "query", "description": "Filter logs by their task run id(s)" }, { "name": "level", "value": "", "type": "query", "description": "Filter logs by their severity level. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "type", "value": "", "type": "query", "description": "Filter logs by their type. Types include `app` for application logs, `request` for request logs, and `build` for build logs. You can find the full set of types available for a query by using the `GET /logs/values` endpoint." }, { "name": "text", "value": "", "type": "query", "description": "Filter by the text of the logs. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "path", "value": "", "type": "query", "description": "Filter request logs by their path. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List logs matching the provided filters. Logs are paginated by start and end timestamps.\nThere are more logs to fetch if `hasMore` is true in the response. Provide the `nextStartTime`\nand `nextEndTime` timestamps as the `startTime` and `endTime` query parameters to fetch the next page of logs.\n\nYou can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner.\n" }, { "info": { "name": "Subscribe to new logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs/subscribe", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspace to return logs for" }, { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to query logs for. Backward will return most recent logs first.\nForward will start with the oldest logs in the time range.\n" }, { "name": "resource", "value": "", "type": "query", "description": "Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow." }, { "name": "instance", "value": "", "type": "query", "description": "Filter logs by the instance they were emitted from. An instance is the id of a specific running server." }, { "name": "host", "value": "", "type": "query", "description": "Filter request logs by their host. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "statusCode", "value": "", "type": "query", "description": "Filter request logs by their status code. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "method", "value": "", "type": "query", "description": "Filter request logs by their requests method. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "task", "value": "", "type": "query", "description": "Filter logs by their task(s)" }, { "name": "taskRun", "value": "", "type": "query", "description": "Filter logs by their task run id(s)" }, { "name": "level", "value": "", "type": "query", "description": "Filter logs by their severity level. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "type", "value": "", "type": "query", "description": "Filter logs by their type. Types include `app` for application logs, `request` for request logs, and `build` for build logs. You can find the full set of types available for a query by using the `GET /logs/values` endpoint." }, { "name": "text", "value": "", "type": "query", "description": "Filter by the text of the logs. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "path", "value": "", "type": "query", "description": "Filter request logs by their path. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "Open a websocket connection to subscribe to logs matching the provided filters. Logs are streamed in real-time as they are generated.\n\nYou can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner.\n" }, { "info": { "name": "List log label values", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs/values", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspace to return log label values for" }, { "name": "label", "value": "", "type": "query", "description": "The label to query logs for" }, { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to query logs for. Backward will return most recent logs first.\nForward will start with the oldest logs in the time range.\n" }, { "name": "resource", "value": "", "type": "query", "description": "Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow." }, { "name": "instance", "value": "", "type": "query", "description": "Filter logs by the instance they were emitted from. An instance is the id of a specific running server." }, { "name": "host", "value": "", "type": "query", "description": "Filter request logs by their host. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "statusCode", "value": "", "type": "query", "description": "Filter request logs by their status code. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "method", "value": "", "type": "query", "description": "Filter request logs by their requests method. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "task", "value": "", "type": "query", "description": "Filter logs by their task(s)" }, { "name": "taskRun", "value": "", "type": "query", "description": "Filter logs by their task run id(s)" }, { "name": "level", "value": "", "type": "query", "description": "Filter logs by their severity level. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "type", "value": "", "type": "query", "description": "Filter logs by their type. Types include `app` for application logs, `request` for request logs, and `build` for build logs. You can find the full set of types available for a query by using the `GET /logs/values` endpoint." }, { "name": "text", "value": "", "type": "query", "description": "Filter by the text of the logs. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "path", "value": "", "type": "query", "description": "Filter request logs by their path. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List all values for a given log label in the logs matching the provided filters." }, { "info": { "name": "Retrieve log stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs/streams/owner/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return log stream information for" } ] }, "docs": "Returns log stream information for the specified workspace." }, { "info": { "name": "Update log stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/logs/streams/owner/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to update log stream information for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates log stream information for the specified workspace. All logs for resources owned by this workspace will be sent to this log stream unless overridden by individual resources." }, { "info": { "name": "Delete log stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/logs/streams/owner/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to delete the log stream for" } ] }, "docs": "Removes the log stream for the specified workspace." }, { "info": { "name": "List log stream overrides", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs/streams/resource", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "logStreamId", "value": "", "type": "query", "description": "Filter log streams by their id." }, { "name": "resourceId", "value": "", "type": "query", "description": "IDs of resources (server, cron job, postgres, or redis) to filter by" }, { "name": "setting", "value": "", "type": "query", "description": "Filter log streams by their setting." }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "Lists log stream overrides for the provided workspace that match the provided filters. These overrides take precedence over the workspace's default log stream." }, { "info": { "name": "Retrieve log stream override", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/logs/streams/resource/:resourceId", "params": [ { "name": "resourceId", "value": "", "type": "path", "description": "The ID of the resource (server, cron job, postgres, or redis) to return log stream override information for" } ] }, "docs": "Returns log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream." }, { "info": { "name": "Update log stream override", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/logs/streams/resource/:resourceId", "params": [ { "name": "resourceId", "value": "", "type": "path", "description": "The ID of the resource (server, cron job, postgres, or redis) to update log stream override information for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates log stream override information for the specified resource. A log stream override takes precedence over a workspace's default log stream." }, { "info": { "name": "Delete log stream override", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/logs/streams/resource/:resourceId", "params": [ { "name": "resourceId", "value": "", "type": "path", "description": "The ID of the resource (server, cron job, postgres, or redis) whose log streams should be returned" } ] }, "docs": "Removes the log stream override for the specified resource. After deletion, the resource will use the workspace's default log stream setting." } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Retrieve metrics stream", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics-stream/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return metrics stream information for" } ] }, "docs": "Returns metrics stream information for the specified workspace." }, { "info": { "name": "Create or update metrics stream", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/metrics-stream/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return metrics stream information for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the metrics stream for the specified workspace." }, { "info": { "name": "Delete metrics stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/metrics-stream/:ownerId", "params": [ { "name": "ownerId", "value": "", "type": "path", "description": "The ID of the workspace to return metrics stream information for" } ] }, "docs": "Deletes the metrics stream for the specified workspace." }, { "info": { "name": "Get CPU usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/cpu", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" }, { "name": "aggregationMethod", "value": "", "type": "query", "description": "The aggregation method to apply to multiple time series" } ] }, "docs": "Get CPU usage for one or more resources.\n" }, { "info": { "name": "Get CPU limit", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/cpu-limit", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" } ] }, "docs": "Get the CPU limit for one or more resources.\n" }, { "info": { "name": "Get CPU target", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/cpu-target", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" } ] }, "docs": "Get CPU target for one or more resources.\n" }, { "info": { "name": "Get memory usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/memory", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" } ] }, "docs": "Get memory usage for one or more resources.\n" }, { "info": { "name": "Get memory limit", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/memory-limit", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" } ] }, "docs": "Get the memory limit for one or more resources.\n" }, { "info": { "name": "Get memory target", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/memory-target", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "instance", "value": "", "type": "query", "description": "Instance ID to query. When multiple instance ID query params are provided, they are ORed together" } ] }, "docs": "Get memory target for one or more resources.\n" }, { "info": { "name": "Get HTTP request count", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/http-requests", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "host", "value": "", "type": "query", "description": "The hosts of HTTP requests to filter to. When multiple host query params are provided, they are ORed together" }, { "name": "path", "value": "", "type": "query", "description": "The paths of HTTP requests to filter to. When multiple path query params are provided, they are ORed together" }, { "name": "aggregateBy", "value": "", "type": "query", "description": "The field to aggregate by" } ] }, "docs": "Get the HTTP request count for one or more resources.\n" }, { "info": { "name": "Get HTTP latency", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/http-latency", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "host", "value": "", "type": "query", "description": "The hosts of HTTP requests to filter to. When multiple host query params are provided, they are ORed together" }, { "name": "path", "value": "", "type": "query", "description": "The paths of HTTP requests to filter to. When multiple path query params are provided, they are ORed together" }, { "name": "quantile", "value": "", "type": "query", "description": "The quantile of latencies to fetch. When multiple quantile query params are provided, they are ORed together" } ] }, "docs": "Get HTTP latency metrics for one or more resources.\n" }, { "info": { "name": "Get bandwidth usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/bandwidth", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "Get bandwidth usage for one or more resources.\n" }, { "info": { "name": "Get bandwidth usage breakdown by traffic source", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/bandwidth-sources", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "Get bandwidth usage for one or more resources broken down by traffic source (HTTP, WebSocket, NAT, PrivateLink).\n\nReturns hourly data points with traffic source breakdown. Traffic source data is available from March 9, 2025 onwards.\nQueries for earlier dates will return a 400 Bad Request error.\n" }, { "info": { "name": "Get disk usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/disk-usage", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "Get persistent disk usage for one or more resources.\n" }, { "info": { "name": "Get disk capacity", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/disk-capacity", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "Get persistent disk capacity for one or more resources.\n" }, { "info": { "name": "Get instance count", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/instance-count", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources can be service ids, Postgres ids, or Redis ids" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "Get the instance count for one or more resources.\n" }, { "info": { "name": "Get active connection count", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/active-connections", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Resource ID to query. When multiple resource query params are provided, they are ORed together. Resources Postgres ids or Redis ids" } ] }, "docs": "Get the number of active connections for one or more Postgres databases or Redis instances.\n" }, { "info": { "name": "Get replica lag", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/replication-lag", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Postgres ID to query. When multiple resource query params are provided, they are ORed together" } ] }, "docs": "Get seconds of replica lag of a Postgres replica.\n" }, { "info": { "name": "List queryable instance values", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/filters/application", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" } ] }, "docs": "List instance values to filter by for one or more resources.\n" }, { "info": { "name": "List queryable status codes and host values", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/filters/http", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "host", "value": "", "type": "query", "description": "The hosts of HTTP requests to filter to. When multiple host query params are provided, they are ORed together" }, { "name": "statusCode", "value": "", "type": "query", "description": "The status codes of HTTP requests to filter to. When multiple status code query params are provided, they are ORed together" } ] }, "docs": "List status codes and host values to filter by for one or more resources.\n" }, { "info": { "name": "List queryable paths", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/filters/path", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Service ID to query. When multiple service ids are provided, they are ORed together" }, { "name": "service", "value": "", "type": "query", "description": "This parameter is deprecated. Please use `resource` instead" }, { "name": "host", "value": "", "type": "query", "description": "The hosts of HTTP requests to filter to. When multiple host query params are provided, they are ORed together" }, { "name": "statusCode", "value": "", "type": "query", "description": "The status codes of HTTP requests to filter to. When multiple status code query params are provided, they are ORed together" }, { "name": "path", "value": "", "type": "query", "description": "The paths of HTTP requests to filter to. When multiple path query params are provided, they are ORed together" } ] }, "docs": "The path suggestions are based on the most recent 5000 log lines as filtered by the provided filters" }, { "info": { "name": "Get task runs queued count", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/task-runs-queued", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Task ID to query. When multiple task IDs are provided, they are ORed together" } ] }, "docs": "Get the total number of task runs queued for one or more tasks.\n" }, { "info": { "name": "Get task runs completed count", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/metrics/task-runs-completed", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`." }, { "name": "endTime", "value": "", "type": "query", "description": "Epoch/Unix timestamp of end of time range to return. Defaults to `now()`." }, { "name": "resolutionSeconds", "value": "", "type": "query", "description": "The resolution of the returned data" }, { "name": "resource", "value": "", "type": "query", "description": "Task ID to query. When multiple task IDs are provided, they are ORed together" }, { "name": "state", "value": "", "type": "query", "description": "The state of task runs to filter to. When multiple state query params are provided, they are ORed together" }, { "name": "aggregateBy", "value": "", "type": "query", "description": "The field to aggregate by" } ] }, "docs": "Get the total number of task runs completed for one or more tasks. Optionally filter by state (succeeded/failed) or aggregate by state.\n" } ] }, { "info": { "name": "Key Value", "type": "folder" }, "items": [ { "info": { "name": "List Key Value instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/key-value", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "region", "value": "", "type": "query", "description": "Filter by resource region" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are returned.\n" }, { "info": { "name": "Create Key Value instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/key-value", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Key Value instance.\n" }, { "info": { "name": "Retrieve Key Value instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/key-value/:keyValueId", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ] }, "docs": "Retrieve a Key Value instance by ID.\n" }, { "info": { "name": "Update Key Value instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/key-value/:keyValueId", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Key Value instance by ID.\n" }, { "info": { "name": "Delete Key Value instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/key-value/:keyValueId", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ] }, "docs": "Delete a Key Value instance by ID.\n" }, { "info": { "name": "Retrieve Key Value connection info", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/key-value/:keyValueId/connection-info", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ] }, "docs": "Retrieve connection info for a Key Value instance by ID. Connection info includes sensitive information.\n" }, { "info": { "name": "Suspend Key Value instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/key-value/:keyValueId/suspend", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ] }, "docs": "Suspend a Key Value instance by ID.\n" }, { "info": { "name": "Resume Key Value instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/key-value/:keyValueId/resume", "params": [ { "name": "keyValueId", "value": "", "type": "path" } ] }, "docs": "Resume a Key Value instance by ID.\n" } ] }, { "info": { "name": "Redis (Deprecated)", "type": "folder" }, "items": [ { "info": { "name": "List Redis instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/redis", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "region", "value": "", "type": "query", "description": "Filter by resource region" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List Redis instances matching the provided filters. If no filters are provided, all Redis instances are returned.\nThis API is deprecated in favor of the Key Value API.\n" }, { "info": { "name": "Create Redis instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/redis", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Redis instance. This API is deprecated in favor of the Key Value API.\n" }, { "info": { "name": "Retrieve Redis instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/redis/:redisId", "params": [ { "name": "redisId", "value": "", "type": "path" } ] }, "docs": "Retrieve a Redis instance by ID. This API is deprecated in favor of the Key Value API.\n" }, { "info": { "name": "Update Redis instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/redis/:redisId", "params": [ { "name": "redisId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Redis instance by ID. This API is deprecated in favor of the Key Value API.\n" }, { "info": { "name": "Delete Redis instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/redis/:redisId", "params": [ { "name": "redisId", "value": "", "type": "path" } ] }, "docs": "Delete a Redis instance by ID. This API is deprecated in favor of the Key Value API.\n" }, { "info": { "name": "Retrieve Redis connection info", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/redis/:redisId/connection-info", "params": [ { "name": "redisId", "value": "", "type": "path" } ] }, "docs": "Retrieve connection info for a Redis instance by ID. Connection info includes sensitive information.\nThis API is deprecated in favor of the Key Value API.\n" } ] }, { "info": { "name": "Postgres", "type": "folder" }, "items": [ { "info": { "name": "List Postgres instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "region", "value": "", "type": "query", "description": "Filter by resource region" }, { "name": "suspended", "value": "", "type": "query", "description": "Filter resources based on whether they're suspended or not suspended" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "includeReplicas", "value": "", "type": "query", "description": "Include replicas in the response" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.\n" }, { "info": { "name": "Create Postgres instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Postgres instance.\n" }, { "info": { "name": "Retrieve Postgres instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres/:postgresId", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Retrieve a Postgres instance by ID.\n" }, { "info": { "name": "Update Postgres instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/postgres/:postgresId", "params": [ { "name": "postgresId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Postgres instance by ID.\n" }, { "info": { "name": "Delete Postgres instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/postgres/:postgresId", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Delete a Postgres instance by ID. This operation is irreversible, and\nall data will be lost.\n" }, { "info": { "name": "Retrieve Postgres connection info", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres/:postgresId/connection-info", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Retrieve connection info for a Postgres instance by ID. Connection info includes sensitive information.\n" }, { "info": { "name": "Retrieve point-in-time recovery status", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres/:postgresId/recovery", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Retrieve information on the availability of Postgres point-in-time recovery for a Postgres instance by ID.\n" }, { "info": { "name": "Trigger point-in-time recovery", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/recovery", "params": [ { "name": "postgresId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger [point-in-time recovery](https://render.com/docs/postgresql-backups) on the Postgres instance with the provided ID.\n" }, { "info": { "name": "Suspend Postgres instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/suspend", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Suspend a Postgres instance by ID.\n" }, { "info": { "name": "Resume Postgres instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/resume", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Resume a Postgres instance by ID.\n" }, { "info": { "name": "Restart Postgres instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/restart", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Restart a Postgres instance by ID.\n" }, { "info": { "name": "Failover Postgres instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/failover", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Failover a [highly available Postgres](https://render.com/docs/postgresql-high-availability) instance.\n" }, { "info": { "name": "List Postgres exports", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres/:postgresId/export", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "List [exports](https://render.com/docs/postgresql-backups#logical-backups) for a Postgres instance by ID. Returns a URL to download the export.\n" }, { "info": { "name": "Create Postgres export", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/export", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "Create an [export](https://render.com/docs/postgresql-backups#logical-backups) of a Postgres instance by ID.\n" }, { "info": { "name": "List PostgreSQL Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/postgres/:postgresId/credentials", "params": [ { "name": "postgresId", "value": "", "type": "path" } ] }, "docs": "List PostgreSQL users for the Render Postgres instance with the provided ID.\n" }, { "info": { "name": "Create PostgreSQL User", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/postgres/:postgresId/credentials", "params": [ { "name": "postgresId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new PostgreSQL user for the Render Postgres instance with the provided ID. This becomes the database's new \"default\" user.\n" }, { "info": { "name": "Delete PostgreSQL User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/postgres/:postgresId/credentials/:username", "params": [ { "name": "postgresId", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Delete a PostgreSQL user from the Render Postgres instance with the provided ID.\n" } ] }, { "info": { "name": "Projects & Environments", "type": "folder" }, "items": [ { "info": { "name": "List projects", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/projects", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List projects matching the provided filters. If no filters are provided, all projects are returned.\n" }, { "info": { "name": "Create project", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new project.\n" }, { "info": { "name": "Retrieve Project", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Retrieve the project with the provided ID.\n" }, { "info": { "name": "Update project", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of a project.\n\nTo update the details of a particular _environment_ in the project, instead use the [Update environment](https://api-docs.render.com/reference/update-environment) endpoint.\n" }, { "info": { "name": "Delete project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Delete the project with the provided ID.\n\nRequires _all_ of the project's environments to be empty (i.e., they must contain no services or other resources). Otherwise, deletion fails with a `409` response.\n\nTo delete a non-empty project, do one of the following:\n- First move or delete all contained services and other resources.\n- Delete the project in the [Render Dashboard](https://dashboard.render.com).\n" }, { "info": { "name": "List environments", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/environments", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "projectId", "value": "", "type": "query", "description": "Filter for resources that belong to a project" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned.\n" }, { "info": { "name": "Create environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/environments", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new environment belonging to the project with the provided ID.\n" }, { "info": { "name": "Retrieve environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/environments/:environmentId", "params": [ { "name": "environmentId", "value": "", "type": "path" } ] }, "docs": "Retrieve the environment with the provided ID." }, { "info": { "name": "Update environment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/environments/:environmentId", "params": [ { "name": "environmentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of the environment with the provided ID." }, { "info": { "name": "Delete environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/environments/:environmentId", "params": [ { "name": "environmentId", "value": "", "type": "path" } ] }, "docs": "Delete the environment with the provided ID.\n\nRequires the environment to be empty (i.e., it must contain no services or other resources). Otherwise, deletion fails with a `409` response.\n\nTo delete a non-empty environment, do one of the following:\n- First move or delete all contained services and other resources.\n- Delete the environment in the [Render Dashboard](https://dashboard.render.com).\n" }, { "info": { "name": "Add resources to environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/environments/:environmentId/resources", "params": [ { "name": "environmentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add resources to the environment with the provided ID.\n" }, { "info": { "name": "Remove resources from environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/environments/:environmentId/resources", "params": [ { "name": "environmentId", "value": "", "type": "path" }, { "name": "resourceIds", "value": "", "type": "query" } ] }, "docs": "Remove resources from the environment with the provided ID.\n" } ] }, { "info": { "name": "Environment Groups", "type": "folder" }, "items": [ { "info": { "name": "List environment groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/env-groups", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "createdBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources created before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "createdAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources created after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)" }, { "name": "updatedAfter", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List environment groups matching the provided filters. If no filters are provided, all environment groups are returned.\n" }, { "info": { "name": "Create environment group", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/env-groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new environment group.\n" }, { "info": { "name": "Retrieve environment group", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/env-groups/:envGroupId", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" } ] }, "docs": "Retrieve an environment group by ID.\n" }, { "info": { "name": "Update environment group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/env-groups/:envGroupId", "params": [ { "name": "envGroupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the attributes of an environment group." }, { "info": { "name": "Delete environment group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/env-groups/:envGroupId", "params": [ { "name": "envGroupId", "value": "", "type": "path" } ] }, "docs": "Delete the environment group with the provided ID, including all environment variables and secret files it contains." }, { "info": { "name": "Link service", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/env-groups/:envGroupId/services/:serviceId", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" }, { "name": "serviceId", "value": "", "type": "path", "description": "The ID of the service" } ] }, "docs": "Link a particular service to a particular environment group.\n\nThe linked service will have access to the environment variables and secret files in the group.\n" }, { "info": { "name": "Unlink service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/env-groups/:envGroupId/services/:serviceId", "params": [ { "name": "envGroupId", "value": "", "type": "path" }, { "name": "serviceId", "value": "", "type": "path" } ] }, "docs": "Unlink a particular service from a particular environment group.\n\nThe service will lose access to the environment variables and secret files in the group.\n" }, { "info": { "name": "Retrieve environment variable", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/env-groups/:envGroupId/env-vars/:envVarKey", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ] }, "docs": "Retrieve a particular environment variable in a particular environment group.\n" }, { "info": { "name": "Add or update environment variable", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/env-groups/:envGroupId/env-vars/:envVarKey", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update a particular environment variable in a particular environment group.\n" }, { "info": { "name": "Remove environment variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/env-groups/:envGroupId/env-vars/:envVarKey", "params": [ { "name": "envGroupId", "value": "", "type": "path" }, { "name": "envVarKey", "value": "", "type": "path", "description": "The name of the environment variable" } ] }, "docs": "Remove a particular environment variable from a particular environment group.\n" }, { "info": { "name": "Retrieve secret file", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/env-groups/:envGroupId/secret-files/:secretFileName", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" }, { "name": "secretFileName", "value": "", "type": "path", "description": "The name of the secret file" } ] }, "docs": "Retrieve a particular secret file in a particular environment group.\n" }, { "info": { "name": "Add or update secret file", "type": "http" }, "http": { "method": "PUT", "url": "https://api.render.com/v1/env-groups/:envGroupId/secret-files/:secretFileName", "params": [ { "name": "envGroupId", "value": "", "type": "path" }, { "name": "secretFileName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update a particular secret file in an particular environment group.\n" }, { "info": { "name": "Remove secret file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/env-groups/:envGroupId/secret-files/:secretFileName", "params": [ { "name": "envGroupId", "value": "", "type": "path", "description": "Filter for resources that belong to an environment group" }, { "name": "secretFileName", "value": "", "type": "path", "description": "The name of the secret file" } ] }, "docs": "Remove a particular secret file from a particular environment group.\n" } ] }, { "info": { "name": "Maintenance", "type": "folder" }, "items": [ { "info": { "name": "List maintenance runs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/maintenance", "params": [ { "name": "resourceId", "value": "", "type": "query" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "state", "value": "", "type": "query" } ] }, "docs": "List scheduled and/or recent maintenance runs for specified resources.\n" }, { "info": { "name": "Retrieve maintenance run", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/maintenance/:maintenanceRunParam", "params": [ { "name": "maintenanceRunParam", "value": "", "type": "path" } ] }, "docs": "Retrieve the maintenance run with the provided ID." }, { "info": { "name": "Update maintenance run", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/maintenance/:maintenanceRunParam", "body": { "type": "json", "data": "{}" } }, "docs": "Update the maintenance run with the provided ID.\n\nUpdates from this endpoint are asynchronous. To check your update's status, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint.\n" }, { "info": { "name": "Trigger maintenance run", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/maintenance/:maintenanceRunParam/trigger" }, "docs": "Trigger the scheduled maintenance run with the provided ID.\n\nTriggering maintenance is asynchronous. To check whether maintenance has started, use the [Retrieve maintenance run](https://api-docs.render.com/reference/retrieve-maintenance) endpoint.\n\nAs maintenance progresses, the run's `state` will change from `scheduled` to other values, such as `in_progress` and `succeeded`.\n" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/webhooks", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" } ] }, "docs": "List webhooks" }, { "info": { "name": "Create a webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/webhooks", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new webhook.\n" }, { "info": { "name": "Retrieve a webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier for the webhook" } ] }, "docs": "Retrieve the webhook with the provided ID" }, { "info": { "name": "Update a webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier for the webhook" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the webhook with the provided ID.\n" }, { "info": { "name": "Delete a webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier for the webhook" } ] }, "docs": "Delete the webhook with the provided ID.\n" }, { "info": { "name": "List webhook events", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/webhooks/:webhookId/events", "params": [ { "name": "sentBefore", "value": "2021-06-17T08:15:30Z", "type": "query", "description": "Filter events sent before this time (specified as an ISO 8601 timestamp)" }, { "name": "sentAfter", "value": "2021-02-17T08:15:30Z", "type": "query", "description": "Filter for resources sent after a certain time (specified as an ISO 8601 timestamp)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "Retrieve a list of events that have been sent to this webhook, with optional filtering by timestamp.\n" } ] }, { "info": { "name": "Workflows (Beta)", "type": "folder" }, "items": [ { "info": { "name": "List workflows", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/workflows", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by name" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "workflowID", "value": "", "type": "query", "description": "The IDs of the workflows to return resources for" }, { "name": "environmentId", "value": "", "type": "query", "description": "Filter for resources that belong to an environment" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List workflows that match the provided filters. If no filters are provided, all workflows accessible by the authenticated user are returned." }, { "info": { "name": "Create a workflow", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/workflows", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new workflow service with the specified configuration." }, { "info": { "name": "Retrieve workflow", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "The ID of the workflow" } ] }, "docs": "Retrieve the workflow service with the provided ID." }, { "info": { "name": "Update workflow", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.render.com/v1/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "The ID of the workflow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the workflow service with the provided ID." }, { "info": { "name": "Delete workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path", "description": "The ID of the workflow" } ] }, "docs": "Delete the workflow service with the provided ID." }, { "info": { "name": "List workflow versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/workflowversions", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "workflowID", "value": "", "type": "query", "description": "The IDs of the workflows to return resources for" }, { "name": "workflowVersionId", "value": "", "type": "query", "description": "The IDs of the workflow versions to return resources for" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List known versions of the workflow service with the provided ID." }, { "info": { "name": "Deploy a workflow version", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/workflowversions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates and deploys a new version of a workflow." }, { "info": { "name": "Retrieve workflow version", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/workflowversions/:workflowVersionId", "params": [ { "name": "workflowVersionId", "value": "", "type": "path", "description": "The ID of the workflow version" } ] }, "docs": "Retrieve the specific workflow service version with the provided ID." } ] }, { "info": { "name": "Workflow Tasks (Beta)", "type": "folder" }, "items": [ { "info": { "name": "List tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/tasks", "params": [ { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "taskSlug", "value": "my-workflow-slug/my-task,my-workflow-slug/my-task:SHA123", "type": "query", "description": "An array of task slugs in the format workflow-slug/task-name. An optional version can be appended (workflow-slug/task-name:version). If no version is provided, the latest version is used." }, { "name": "workflowVersionId", "value": "", "type": "query", "description": "An array of workflow version IDs" }, { "name": "workflowId", "value": "", "type": "query", "description": "An array of workflow IDs" }, { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." } ] }, "docs": "List workflow tasks that match the provided filters. If no filters are provided, all task definitions accessible by the authenticated user are returned." }, { "info": { "name": "Retrieve task", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "The ID of the task" } ] }, "docs": "Retrieve the workflow task with the provided ID." }, { "info": { "name": "List task runs", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/task-runs", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)." }, { "name": "taskSlug", "value": "my-workflow-slug/my-task,my-workflow-slug/my-task:SHA123", "type": "query", "description": "An array of task slugs in the format workflow-slug/task-name. An optional version can be appended (workflow-slug/task-name:version). If no version is provided, the latest version is used." }, { "name": "rootTaskRunId", "value": "", "type": "query", "description": "An array of root task run IDs to filter on" }, { "name": "ownerId", "value": "", "type": "query", "description": "The ID of the workspaces to return resources for" }, { "name": "workflowVersionId", "value": "", "type": "query", "description": "An array of workflow version IDs" }, { "name": "workflowId", "value": "", "type": "query", "description": "An array of workflow IDs" } ] }, "docs": "List task runs that match the provided filters. If no filters are provided, all task runs accessible by the authenticated user are returned." }, { "info": { "name": "Run task", "type": "http" }, "http": { "method": "POST", "url": "https://api.render.com/v1/task-runs", "body": { "type": "json", "data": "{}" } }, "docs": "Kicks off a run of the workflow task with the provided ID, passing the provided input data." }, { "info": { "name": "Stream realtime events (SSE)", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/task-runs/events", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "taskRunIds", "value": "", "type": "query", "description": "Filter to a subset of task run IDs." } ] }, "docs": "Establishes a unidirectional event stream. The server sends events as lines\nformatted per the SSE spec. Clients SHOULD set `Accept: text/event-stream`\nand keep the connection open.\n" }, { "info": { "name": "Retrieve task run", "type": "http" }, "http": { "method": "GET", "url": "https://api.render.com/v1/task-runs/:taskRunId", "params": [ { "name": "taskRunId", "value": "", "type": "path", "description": "The ID of the task run" } ] }, "docs": "Retrieve the workflow task run with the provided ID." }, { "info": { "name": "Cancel task run", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.render.com/v1/task-runs/:taskRunId", "params": [ { "name": "taskRunId", "value": "", "type": "path", "description": "The ID of the task run" } ] }, "docs": "Cancel a running task run with the provided ID." } ] } ], "bundled": true }