{"note":"OpenAPI conversion -- returning structured metadata","name":"render","description":"Render Public API","version":"1.0.0","base_url":"https://api.render.com/v1","endpoints":196,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Render Public API\n@base https://api.render.com/v1\n@version 1.0.0\n@auth Bearer bearer\n@endpoints 196\n@hint download_for_search\n@toc blueprints(6), owners(6), disks(7), users(1), organizations(1), notification-settings(5), registrycredentials(5), services(48), cron-jobs(2), events(1), logs(10), metrics-stream(3), metrics(20), key-value(8), redis(6), postgres(17), projects(5), environments(7), env-groups(13), maintenance(4), webhooks(6), workflows(5), workflowversions(3), tasks(2), task-runs(5)\n\n@group blueprints\n@endpoint GET /blueprints\n@desc List Blueprints\n@optional {ownerId: [str] # The ID of the workspaces to return resources for, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /blueprints/validate\n@desc Validate Blueprint\n@returns(200) {valid: bool, errors: [map], plan: map{services: [str], databases: [str], keyValue: [str], envGroups: [str], totalActions: int}} # Validation complete\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred.}\n\n@endgroup\n\n@group owners\n@endpoint PATCH /owners/{ownerId}/members/{userId}\n@desc Update workspace member role\n@required {role: str(ADMIN/DEVELOPER/WORKSPACE_CONTRIBUTOR/WORKSPACE_BILLING/WORKSPACE_VIEWER) # The member's workspace role. Values are always returned in uppercase.}\n@returns(200) {userId: str, name: str, email: str, status: str, role: str, mfaEnabled: bool} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n@example_request {\"role\":\"ADMIN\"}\n\n@endpoint DELETE /owners/{ownerId}/members/{userId}\n@desc Remove workspace member\n@returns(204) No Content\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group blueprints\n@endpoint GET /blueprints/{blueprintId}\n@desc Retrieve Blueprint\n@returns(200) {id: any, name: str, status: str, autoSync: bool, repo: str, branch: str, path: str, lastSync: str(date-time), resources: [map]} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /blueprints/{blueprintId}\n@desc Update Blueprint\n@optional {name: str, autoSync: bool # Automatically sync changes to render.yaml, path: str # Path to the Blueprint file in the repository}\n@returns(200) {id: any, name: str, status: str, autoSync: bool, repo: str, branch: str, path: str, lastSync: str(date-time)} # Updated\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /blueprints/{blueprintId}\n@desc Disconnect Blueprint\n@returns(204) Blueprint disconnected\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /blueprints/{blueprintId}/syncs\n@desc List Blueprint syncs\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group disks\n@endpoint GET /disks\n@desc List disks\n@optional {ownerId: [str] # The ID of the workspaces to return resources for, diskId: [any] # Filter by disk IDs, name: [str] # Filter by name, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), serviceId: [str] # Filter for resources by service ID, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /disks\n@desc Add disk\n@required {name: str, sizeGB: int, mountPath: str, serviceId: str}\n@returns(201) {id: any, name: str, sizeGB: int, mountPath: str, serviceId: str, createdAt: str(date-time), updatedAt: str(date-time)} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /disks/{diskId}\n@desc Retrieve disk\n@returns(200) {id: any, name: str, sizeGB: int, mountPath: str, serviceId: str, createdAt: str(date-time), updatedAt: str(date-time)} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /disks/{diskId}\n@desc Update disk\n@optional {name: str, sizeGB: int, mountPath: str}\n@returns(200) {id: any, name: str, sizeGB: int, mountPath: str, serviceId: str, createdAt: str(date-time), updatedAt: str(date-time)} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /disks/{diskId}\n@desc Delete disk\n@returns(204) Disk deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /disks/{diskId}/snapshots\n@desc List snapshots\n@returns(201) Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /disks/{diskId}/snapshots/restore\n@desc Restore snapshot\n@required {snapshotKey: str}\n@optional {instanceId: str # When a service with a disk is scaled, the instanceId is used to identify the instance that the disk is attached to. Each instance's disks get their own snapshots, and can be restored separately.}\n@returns(200) {id: any, name: str, sizeGB: int, mountPath: str, serviceId: str, createdAt: str(date-time), updatedAt: str(date-time)} # Restored\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group users\n@endpoint GET /users\n@desc Get the authenticated user\n@returns(200) {email: str, name: str} # OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group owners\n@endpoint GET /owners\n@desc List workspaces\n@optional {name: [str] # Only return workspaces with one of the provided names. Only exact matches are returned., email: [str] # Only return workspaces owned by one of the provided email addresses., cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /owners/{ownerId}\n@desc Retrieve workspace\n@returns(200) {id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str} # OK\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /owners/{ownerId}/members\n@desc List workspace members\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /owners/{ownerId}/audit-logs\n@desc List workspace audit logs\n@optional {startTime: str(date-time) # Start time for filtering audit logs (ISO 8601 format), endTime: str(date-time) # End time for filtering audit logs (ISO 8601 format), cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group organizations\n@endpoint GET /organizations/{orgId}/audit-logs\n@desc List organization audit logs\n@optional {startTime: str(date-time) # Start time for filtering audit logs (ISO 8601 format), endTime: str(date-time) # End time for filtering audit logs (ISO 8601 format), cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of audit log items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group notification-settings\n@endpoint GET /notification-settings/owners/{ownerId}\n@desc Retrieve notification settings\n@returns(200) {ownerId: str, slackEnabled: bool, emailEnabled: bool, previewNotificationsEnabled: bool, notificationsToSend: any} # OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /notification-settings/owners/{ownerId}\n@desc Update notification settings\n@optional {emailEnabled: bool, previewNotificationsEnabled: bool, notificationsToSend: str(none/failure/all)}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /notification-settings/overrides\n@desc List notification overrides\n@optional {ownerId: [str] # The ID of the workspaces to return resources for, serviceId: [str] # Filter for resources by service ID, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /notification-settings/overrides/services/{serviceId}\n@desc Retrieve notification override\n@returns(200) {serviceId: str, previewNotificationsEnabled: str, notificationsToSend: str} # OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /notification-settings/overrides/services/{serviceId}\n@desc Update notification override\n@optional {previewNotificationsEnabled: str(default/false/true), notificationsToSend: str(default/none/failure/all)}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group registrycredentials\n@endpoint GET /registrycredentials\n@desc List registry credentials\n@optional {name: [str] # Filter for the name of a credential, username: [str] # Filter for the username of a credential, type: [str] # Filter for the registry type for the credential, createdBefore: str(date-time) # Filter for services created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for services created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for services updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for services updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /registrycredentials\n@desc Create registry credential\n@required {registry: str(GITHUB/GITLAB/DOCKER/GOOGLE_ARTIFACT/AWS_ECR) # The registry to use this credential with, name: str, username: str, authToken: str, ownerId: str}\n@returns(200) {id: str, name: str, registry: str, username: str, updatedAt: str(date-time)} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 402: You must enter payment information to perform this request., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /registrycredentials/{registryCredentialId}\n@desc Retrieve registry credential\n@returns(200) {id: str, name: str, registry: str, username: str, updatedAt: str(date-time)} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /registrycredentials/{registryCredentialId}\n@desc Update registry credential\n@required {registry: str(GITHUB/GITLAB/DOCKER/GOOGLE_ARTIFACT/AWS_ECR) # The registry to use this credential with, name: str, username: str, authToken: str}\n@returns(200) {id: str, name: str, registry: str, username: str, updatedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 402: You must enter payment information to perform this request., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /registrycredentials/{registryCredentialId}\n@desc Delete registry credential\n@returns(204) Registry credential deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group services\n@endpoint GET /services\n@desc List services\n@optional {name: [str] # Filter by name, type: [str] # Filter for types of services, environmentId: [str] # Filter for resources that belong to an environment, env: [str] # Filter for environments (runtimes) of services (deprecated; use `runtime` instead), region: [str] # Filter by resource region, suspended: [str] # Filter resources based on whether they're suspended or not suspended, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, includePreviews: bool=true # Include previews in the response, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services\n@desc Create service\n@required {type: str(static_site/web_service/private_service/background_worker/cron_job), name: str # The service's name. Must be unique within the workspace., ownerId: str # The ID of the workspace the service belongs to. Obtain your workspace's ID from its Settings page in the Render Dashboard.}\n@optional {repo: str # The service's repository URL. Do not specify a branch in this string (use the `branch` parameter instead)., autoDeploy: str(yes/no)=yes, branch: str # The repo branch to pull, build, and deploy. If omitted, uses the repository's default branch., image: map{ownerId!: str, registryCredentialId: str, imagePath!: str}, buildFilter: map{paths!: [str], ignoredPaths!: [str]}, rootDir: str, envVars: [map], secretFiles: [map{name!: str, content!: str}], environmentId: str # The ID of the environment the service belongs to, if any. Obtain an environment's ID from its Settings page in the Render Dashboard., serviceDetails: any}\n@returns(201) {service: map{id: str, autoDeploy: str, branch: str, buildFilter: map{paths: [str], ignoredPaths: [str]}, createdAt: str(date-time), dashboardUrl: str, environmentId: str, imagePath: str, name: str, notifyOnFail: str, ownerId: str, registryCredential: map{id: str, name: str}, repo: str, rootDir: str, slug: str, suspended: str, suspenders: [str], type: str, updatedAt: str(date-time), serviceDetails: any}, deployId: str} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 402: You must enter payment information to perform this request., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}\n@desc Retrieve service\n@returns(200) {id: str, autoDeploy: str, branch: str, buildFilter: map{paths: [str], ignoredPaths: [str]}, createdAt: str(date-time), dashboardUrl: str, environmentId: str, imagePath: str, name: str, notifyOnFail: str, ownerId: str, registryCredential: map{id: str, name: str}, repo: str, rootDir: str, slug: str, suspended: str, suspenders: [str], type: str, updatedAt: str(date-time), serviceDetails: any} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /services/{serviceId}\n@desc Update service\n@optional {autoDeploy: str(yes/no)=yes, repo: str, branch: str, image: map{ownerId!: str, registryCredentialId: str, imagePath!: str}, name: str, buildFilter: map{paths!: [str], ignoredPaths!: [str]}, rootDir: str, serviceDetails: any}\n@returns(200) {id: str, autoDeploy: str, branch: str, buildFilter: map{paths: [str], ignoredPaths: [str]}, createdAt: str(date-time), dashboardUrl: str, environmentId: str, imagePath: str, name: str, notifyOnFail: str, ownerId: str, registryCredential: map{id: str, name: str}, repo: str, rootDir: str, slug: str, suspended: str, suspenders: [str], type: str, updatedAt: str(date-time), serviceDetails: any} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 402: You must enter payment information to perform this request., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}\n@desc Delete service\n@returns(204) Service deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/cache/purge\n@desc Purge Web Service Cache\n@returns(202) Cache purge request accepted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/deploys\n@desc List deploys\n@optional {status: [str] # Filter for deploys with the specified statuses, createdBefore: str(date-time) # Filter for deploys created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for deploys created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for deploys updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for deploys updated after a certain time (specified as an ISO 8601 timestamp), finishedBefore: str(date-time) # Filter for deploys finished before a certain time (specified as an ISO 8601 timestamp), finishedAfter: str(date-time) # Filter for deploys finished after a certain time (specified as an ISO 8601 timestamp), cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/deploys\n@desc Trigger deploy\n@optional {clearCache: str(clear/do_not_clear)=do_not_clear # If `clear`, Render clears the service's build cache before deploying. This can be useful if you're experiencing issues with your build., commitId: str # The SHA of a specific Git commit to deploy for a service. Defaults to the latest commit on the service's connected branch.  Note that deploying a specific commit with this endpoint does not disable autodeploys for the service.  You can toggle autodeploys for your service with the [Update service](https://api-docs.render.com/reference/update-service) endpoint or in the Render Dashboard.  Not supported for cron jobs., imageUrl: str # The URL of the image to deploy for an image-backed service.  The host, repository, and image name all must match the currently configured image for the service., deployMode: str(deploy_only/build_and_deploy)=build_and_deploy # Controls deployment behavior when triggering a deploy.  - `deploy_only`: Deploy the last successful build without rebuilding (minimizes downtime) - `build_and_deploy`: Build new code and deploy it (default behavior when not specified)  **Note:** `deploy_only` cannot be combined with `commitId`, `imageUrl` or `clearCache` parameters, as those are build related fields.}\n@returns(201) {id: str, commit: map{id: str, message: str, createdAt: str(date-time)}, image: map{ref: str, sha: str, registryCredential: str}, status: str, trigger: str, startedAt: str(date-time), finishedAt: str(date-time), createdAt: str(date-time), updatedAt: str(date-time)} # Created\n@returns(202) Queued\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/deploys/{deployId}\n@desc Retrieve deploy\n@returns(200) {id: str, commit: map{id: str, message: str, createdAt: str(date-time)}, image: map{ref: str, sha: str, registryCredential: str}, status: str, trigger: str, startedAt: str(date-time), finishedAt: str(date-time), createdAt: str(date-time), updatedAt: str(date-time)} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/deploys/{deployId}/cancel\n@desc Cancel deploy\n@returns(200) {id: str, commit: map{id: str, message: str, createdAt: str(date-time)}, image: map{ref: str, sha: str, registryCredential: str}, status: str, trigger: str, startedAt: str(date-time), finishedAt: str(date-time), createdAt: str(date-time), updatedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/rollback\n@desc Roll back deploy\n@required {deployId: str # The ID of the deploy to roll back to}\n@returns(201) {id: str, commit: map{id: str, message: str, createdAt: str(date-time)}, image: map{ref: str, sha: str, registryCredential: str}, status: str, trigger: str, startedAt: str(date-time), finishedAt: str(date-time), createdAt: str(date-time), updatedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/env-vars\n@desc List environment variables\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/env-vars\n@desc Update environment variables\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/env-vars/{envVarKey}\n@desc Retrieve environment variable\n@returns(200) {key: str, value: str} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/env-vars/{envVarKey}\n@desc Add or update environment variable\n@returns(200) {key: str, value: str} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/env-vars/{envVarKey}\n@desc Delete environment variable\n@returns(204) Environment variable deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/secret-files\n@desc List secret files\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/secret-files\n@desc Update secret files\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/secret-files/{secretFileName}\n@desc Retrieve secret file\n@returns(200) {name: str, content: str} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/secret-files/{secretFileName}\n@desc Add or update secret file\n@optional {content: str}\n@returns(201) {name: str, content: str} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/secret-files/{secretFileName}\n@desc Delete secret file\n@returns(204) Secret file deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/events\n@desc List events\n@required {serviceId: str # The ID of the service}\n@optional {type: any # The type of event to filter to, startTime: str(date-time) # Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`., endTime: str(date-time) # Epoch/Unix timestamp of end of time range to return. Defaults to `now()`., cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/headers\n@desc List header rules\n@optional {path: [str] # Filter for specific paths that headers apply to, name: [str] # Filter for header names, value: [str] # Filter for header values, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/headers\n@desc Add header rule\n@required {path: str # The request path to add the header to. Wildcards will cause headers to be applied to all matching paths., name: str # Header name, value: str # Header value}\n@returns(201) {headers: map{id: str, path: str, name: str, value: str}} # Created\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/headers\n@desc Replace header rules\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/headers/{headerId}\n@desc Delete header rule\n@returns(204) Header deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/routes\n@desc List redirect/rewrite rules\n@optional {type: [str] # Filter for the type of route rule, source: [str] # Filter for the source path of the route, destination: [str] # Filter for the destination path of the route, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/routes\n@desc Add redirect/rewrite rules\n@required {type: str(redirect/rewrite), source: str, destination: str}\n@optional {priority: int # Redirect and Rewrite Rules are applied in priority order starting at 0. Defaults to last in the priority list.}\n@returns(201) {id: str, type: str, source: str, destination: str, priority: int} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /services/{serviceId}/routes\n@desc Update redirect/rewrite rule priority\n@required {priority: int # Redirect and Rewrite Rules are applied in priority order starting at 0. Moves this route to the specified priority and adjusts other route priorities accordingly.}\n@returns(200) {headers: map{id: str, type: str, source: str, destination: str, priority: int}} # Updated\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/routes\n@desc Update redirect/rewrite rules\n@returns(200) Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/routes/{routeId}\n@desc Delete redirect/rewrite rule\n@returns(204) Route deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/custom-domains\n@desc List custom domains\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., name: [str] # Filter for the names of custom domain, domainType: str(apex/subdomain) # Filter for domain type, verificationStatus: str(verified/unverified) # Filter for domain verification status (`verified` or `unverified`), createdBefore: str(date-time) # Filter for custom domains created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for custom domains created after a certain time (specified as an ISO 8601 timestamp)}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/custom-domains\n@desc Add custom domain\n@required {name: str}\n@returns(201) Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 402: You must enter payment information to perform this request., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 409: The current state of the resource conflicts with this request., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/custom-domains/{customDomainIdOrName}\n@desc Retrieve custom domain\n@returns(200) {id: str, name: str, domainType: str, publicSuffix: str, redirectForName: str, verificationStatus: str, createdAt: str(date-time), server: map{id: str, name: str}} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/custom-domains/{customDomainIdOrName}\n@desc Delete custom domain\n@returns(204) Custom domain deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/custom-domains/{customDomainIdOrName}/verify\n@desc Verify DNS configuration\n@returns(202) Custom domain verification triggered\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/suspend\n@desc Suspend service\n@returns(202) Service suspended successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/resume\n@desc Resume service\n@returns(202) Service resumed successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/restart\n@desc Restart service\n@returns(200) Service restarted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/scale\n@desc Scale instance count\n@required {numInstances: int}\n@returns(202) Service scaled successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/autoscaling\n@desc Update autoscaling config\n@required {enabled: bool=false, min: int # The minimum number of instances for the service, max: int # The maximum number of instances for the service, criteria: map{cpu!: map, memory!: map}}\n@returns(200) {enabled: bool, min: int, max: int, criteria: map{cpu: map{enabled: bool, percentage: int}, memory: map{enabled: bool, percentage: int}}} # Autoscaling configuration updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/autoscaling\n@desc Delete autoscaling config\n@returns(204) Autoscaling config deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/preview\n@desc Create service preview (image-backed)\n@required {imagePath: str # Must be either a full URL or the relative path to an image. If a relative path, Render uses the base service's image URL as its root. For example, if the base service's image URL is `docker.io/library/nginx:latest`, then valid values are: `docker.io/library/nginx:`, `library/nginx:`, or `nginx:`. Note that the path must match (only the tag or SHA can vary).}\n@optional {name: str # A name for the service preview instance. If not specified, Render generates the name using the base service's name and the specified tag or SHA., plan: str(starter/starter_plus/standard/standard_plus/pro/pro_plus/pro_max/pro_ultra/free/custom) # The instance type to use. Note that base services on any paid instance type can't create preview instances with the `free` instance type.}\n@returns(200) {service: map{id: str, autoDeploy: str, branch: str, buildFilter: map{paths: [str], ignoredPaths: [str]}, createdAt: str(date-time), dashboardUrl: str, environmentId: str, imagePath: str, name: str, notifyOnFail: str, ownerId: str, registryCredential: map{id: str, name: str}, repo: str, rootDir: str, slug: str, suspended: str, suspenders: [str], type: str, updatedAt: str(date-time), serviceDetails: any}, deployId: str} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/jobs\n@desc List jobs\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., status: [str] # Filter for the status of the job (`pending`, `running`, `succeeded`, `failed`, or `canceled`), createdBefore: str(date-time) # Filter for jobs created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for jobs created after a certain time (specified as an ISO 8601 timestamp), startedBefore: str(date-time) # Filter for jobs started before a certain time (specified as an ISO 8601 timestamp), startedAfter: str(date-time) # Filter for jobs started after a certain time (specified as an ISO 8601 timestamp), finishedBefore: str(date-time) # Filter for jobs finished before a certain time (specified as an ISO 8601 timestamp), finishedAfter: str(date-time) # Filter for jobs finished after a certain time (specified as an ISO 8601 timestamp)}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/jobs\n@desc Create job\n@required {startCommand: str}\n@optional {planId: str}\n@returns(201) {id: any, serviceId: str, startCommand: str, planId: str, status: any, createdAt: str(date-time), startedAt: str(date-time), finishedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/jobs/{jobId}\n@desc Retrieve job\n@returns(200) {id: any, serviceId: str, startCommand: str, planId: str, status: any, createdAt: str(date-time), startedAt: str(date-time), finishedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/jobs/{jobId}/cancel\n@desc Cancel running job\n@returns(200) {id: any, serviceId: str, startCommand: str, planId: str, status: any, createdAt: str(date-time), startedAt: str(date-time), finishedAt: str(date-time)} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/instances\n@desc List instances\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group cron-jobs\n@endpoint POST /cron-jobs/{cronJobId}/runs\n@desc Trigger cron job run\n@returns(200) {id: str, status: str, startedAt: str(date-time), finishedAt: str(date-time), triggeredBy: str, canceledBy: str} # OK\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /cron-jobs/{cronJobId}/runs\n@desc Cancel running cron job\n@returns(204) Cancelled\n@errors {401: Authorization information is missing or invalid., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group events\n@endpoint GET /events/{eventId}\n@desc Retrieve event\n@returns(200) {id: any, timestamp: str(date-time), serviceId: str, type: str, details: any} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group logs\n@endpoint GET /logs\n@desc List logs\n@required {ownerId: str # The ID of the workspace to return logs for, resource: [str] # Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow.}\n@optional {startTime: str(date-time) # Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`., endTime: str(date-time) # Epoch/Unix timestamp of end of time range to return. Defaults to `now()`., direction: str(forward/backward)=backward # The direction to query logs for. Backward will return most recent logs first. Forward will start with the oldest logs in the time range., instance: [str] # Filter logs by the instance they were emitted from. An instance is the id of a specific running server., host: [str] # Filter request logs by their host. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., statusCode: [str] # Filter request logs by their status code. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., method: [str] # Filter request logs by their requests method. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., task: [str] # Filter logs by their task(s), taskRun: [str] # Filter logs by their task run id(s), level: [str] # Filter logs by their severity level. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., type: [str] # 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., text: [str] # Filter by the text of the logs. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., path: [str] # Filter request logs by their path. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) {hasMore: bool, nextStartTime: str(date-time), nextEndTime: str(date-time), logs: [any]} # A collection of logs with pagination metadata\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /logs/subscribe\n@desc Subscribe to new logs\n@required {ownerId: str # The ID of the workspace to return logs for}\n@optional {startTime: str(date-time) # Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`., endTime: str(date-time) # Epoch/Unix timestamp of end of time range to return. Defaults to `now()`., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@errors {101: The connection has been upgraded to a websocket. The server will send log messages as they are generated in the format defined below., 400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /logs/values\n@desc List log label values\n@required {ownerId: str # The ID of the workspace to return log label values for, label: str(instance/host/statusCode/method/level/type) # The label to query logs for}\n@optional {startTime: str(date-time) # Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`., endTime: str(date-time) # Epoch/Unix timestamp of end of time range to return. Defaults to `now()`., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) An array of possible values for a log label\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /logs/streams/owner/{ownerId}\n@desc Retrieve log stream\n@required {ownerId: str # The ID of the workspace to return log stream information for}\n@returns(200) {ownerId: str, endpoint: str, preview: any} # Owner log stream setting\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /logs/streams/owner/{ownerId}\n@desc Update log stream\n@required {ownerId: str # The ID of the workspace to update log stream information for, preview: str(send/drop) # Whether to send logs or drop them.}\n@optional {endpoint: str # The endpoint to stream logs to., token: str # The optional token to authenticate the log stream.}\n@returns(200)\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /logs/streams/owner/{ownerId}\n@desc Delete log stream\n@required {ownerId: str # The ID of the workspace to delete the log stream for}\n@returns(204) Log stream setting deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /logs/streams/resource\n@desc List log stream overrides\n@optional {ownerId: [str] # The ID of the workspaces to return resources for, logStreamId: [str] # Filter log streams by their id., resourceId: [str] # IDs of resources (server, cron job, postgres, or redis) to filter by, setting: [str] # Filter log streams by their setting., cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Resource log stream override\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /logs/streams/resource/{resourceId}\n@desc Retrieve log stream override\n@required {resourceId: str # The ID of the resource (server, cron job, postgres, or redis) to return log stream override information for}\n@returns(200) {resourceId: str, endpoint: str, setting: any} # Resource log stream override\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /logs/streams/resource/{resourceId}\n@desc Update log stream override\n@required {resourceId: str # The ID of the resource (server, cron job, postgres, or redis) to update log stream override information for, setting: any}\n@optional {endpoint: any, token: any}\n@returns(200)\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /logs/streams/resource/{resourceId}\n@desc Delete log stream override\n@required {resourceId: str # The ID of the resource (server, cron job, postgres, or redis) whose log streams should be returned}\n@returns(204) Log stream setting deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group metrics-stream\n@endpoint GET /metrics-stream/{ownerId}\n@desc Retrieve metrics stream\n@returns(200) The metrics stream integration for the owner\n@errors {400: The request could not be understood by the server., 404: metrics stream not found, 500: An unexpected server error has occurred.}\n\n@endpoint PUT /metrics-stream/{ownerId}\n@desc Create or update metrics stream\n@optional {provider: str(BETTER_STACK/GRAFANA/DATADOG/NEW_RELIC/HONEYCOMB/SIGNOZ/GROUNDCOVER/CUSTOM) # Provider to send metrics to, url: str # The endpoint URL to stream metrics to, token: str # Authentication token for the metrics stream}\n@returns(200) {ownerId: str, provider: any, url: str} # metrics stream successfully updated\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint DELETE /metrics-stream/{ownerId}\n@desc Delete metrics stream\n@returns(204) metrics stream integration deleted successfully\n@errors {400: The request could not be understood by the server., 404: metrics stream not found, 500: An unexpected server error has occurred.}\n\n@endgroup\n\n@group metrics\n@endpoint GET /metrics/cpu\n@desc Get CPU usage\n@returns(200) A successful response\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/cpu-limit\n@desc Get CPU limit\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/cpu-target\n@desc Get CPU target\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/memory\n@desc Get memory usage\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/memory-limit\n@desc Get memory limit\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/memory-target\n@desc Get memory target\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/http-requests\n@desc Get HTTP request count\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/http-latency\n@desc Get HTTP latency\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/bandwidth\n@desc Get bandwidth usage\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/bandwidth-sources\n@desc Get bandwidth usage breakdown by traffic source\n@returns(200) {data: [map]} # A successful response with traffic source breakdown\n@errors {400: Bad request - invalid date range, 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/disk-usage\n@desc Get disk usage\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/disk-capacity\n@desc Get disk capacity\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/instance-count\n@desc Get instance count\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/active-connections\n@desc Get active connection count\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/replication-lag\n@desc Get replica lag\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/filters/application\n@desc List queryable instance values\n@returns(200) A successful response\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/filters/http\n@desc List queryable status codes and host values\n@returns(200) A successful response\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/filters/path\n@desc List queryable paths\n@returns(200) A successful response\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/task-runs-queued\n@desc Get task runs queued count\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endpoint GET /metrics/task-runs-completed\n@desc Get task runs completed count\n@returns(200)\n@errors {400: The request could not be understood by the server., 500: An unexpected server error has occurred.}\n\n@endgroup\n\n@group key-value\n@endpoint GET /key-value\n@desc List Key Value instances\n@optional {name: [str] # Filter by name, region: [str] # Filter by resource region, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, environmentId: [str] # Filter for resources that belong to an environment, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /key-value\n@desc Create Key Value instance\n@required {name: str # The name of the Key Value instance, ownerId: str # The ID of the owner of the Key Value instance, plan: str(free/starter/standard/pro/pro_plus/custom)}\n@optional {region: str # The region where the Key Value instance is located, environmentId: str, maxmemoryPolicy: str(noeviction/allkeys_lfu/allkeys_lru/allkeys_random/volatile_lfu/volatile_lru/volatile_random/volatile_ttl) # The eviction policy for the Key Value instance, ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(201) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /key-value/{keyValueId}\n@desc Retrieve Key Value instance\n@required {keyValueId: str}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /key-value/{keyValueId}\n@desc Update Key Value instance\n@required {keyValueId: str}\n@optional {name: str # The name of the Key Value instance, plan: str(free/starter/standard/pro/pro_plus/custom), maxmemoryPolicy: str(noeviction/allkeys_lfu/allkeys_lru/allkeys_random/volatile_lfu/volatile_lru/volatile_random/volatile_ttl) # The eviction policy for the Key Value instance, ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /key-value/{keyValueId}\n@desc Delete Key Value instance\n@required {keyValueId: str}\n@returns(204) Key Value instance deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /key-value/{keyValueId}/connection-info\n@desc Retrieve Key Value connection info\n@required {keyValueId: str}\n@returns(200) {internalConnectionString: str, externalConnectionString: str(password), cliCommand: str(password)} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /key-value/{keyValueId}/suspend\n@desc Suspend Key Value instance\n@returns(202) Service suspended successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /key-value/{keyValueId}/resume\n@desc Resume Key Value instance\n@returns(202) Service resumed successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group redis\n@endpoint GET /redis\n@desc List Redis instances\n@optional {name: [str] # Filter by name, region: [str] # Filter by resource region, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, environmentId: [str] # Filter for resources that belong to an environment, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /redis\n@desc Create Redis instance\n@required {name: str # The name of the Redis instance, ownerId: str # The ID of the owner of the Redis instance, plan: str(free/starter/standard/pro/pro_plus/custom)}\n@optional {region: str # The region where the Redis instance is located, environmentId: str, maxmemoryPolicy: str(noeviction/allkeys_lfu/allkeys_lru/allkeys_random/volatile_lfu/volatile_lru/volatile_random/volatile_ttl) # The eviction policy for the Key Value instance, ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(201) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /redis/{redisId}\n@desc Retrieve Redis instance\n@required {redisId: str}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /redis/{redisId}\n@desc Update Redis instance\n@required {redisId: str}\n@optional {name: str # The name of the Redis instance, plan: str(free/starter/standard/pro/pro_plus/custom), maxmemoryPolicy: str(noeviction/allkeys_lfu/allkeys_lru/allkeys_random/volatile_lfu/volatile_lru/volatile_random/volatile_ttl) # The eviction policy for the Key Value instance, ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), status: str, region: str, plan: str, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, options: map{maxmemoryPolicy: str}, ipAllowList: [map], environmentId: str, version: str, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /redis/{redisId}\n@desc Delete Redis instance\n@required {redisId: str}\n@returns(204) Redis instance deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /redis/{redisId}/connection-info\n@desc Retrieve Redis connection info\n@required {redisId: str}\n@returns(200) {internalConnectionString: str, externalConnectionString: str(password), redisCLICommand: str(password)} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group postgres\n@endpoint GET /postgres\n@desc List Postgres instances\n@optional {name: [str] # Filter by name, region: [str] # Filter by resource region, suspended: [str] # Filter resources based on whether they're suspended or not suspended, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, environmentId: [str] # Filter for resources that belong to an environment, includeReplicas: bool=true # Include replicas in the response, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres\n@desc Create Postgres instance\n@required {name: str # The name of the database as it will appear in the Render Dashboard, ownerId: str # The ID of the workspace to create the database for, plan: str(free/starter/standard/pro/pro_plus/custom/basic_256mb/basic_1gb/basic_4gb/pro_4gb/pro_8gb/pro_16gb/pro_32gb/pro_64gb/pro_128gb/pro_192gb/pro_256gb/pro_384gb/pro_512gb/accelerated_16gb/accelerated_32gb/accelerated_64gb/accelerated_128gb/accelerated_256gb/accelerated_384gb/accelerated_512gb/accelerated_768gb/accelerated_1024gb), version: str(11/12/13/14/15/16/17/18) # The PostgreSQL version}\n@optional {databaseName: str=randomly generated, databaseUser: str=randomly generated, datadogAPIKey: str # The Datadog API key for the Datadog agent to monitor the new database., datadogSite: str # Datadog region to use for monitoring the new database. Defaults to 'US1'., enableHighAvailability: bool=false, environmentId: str, diskSizeGB: int # The number of gigabytes of disk space to allocate for the database, enableDiskAutoscaling: bool=false, region: str, ipAllowList: [map{cidrBlock!: str, description!: str}], parameterOverrides: map, readReplicas: [map{name!: str, parameterOverrides: map}]}\n@returns(201) {id: str, ipAllowList: [map], createdAt: str(date-time), updatedAt: str(date-time), expiresAt: str(date-time), dashboardUrl: str, databaseName: str, databaseUser: str, environmentId: str, highAvailabilityEnabled: bool, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, plan: str, diskSizeGB: int, parameterOverrides: map, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}\n@desc Retrieve Postgres instance\n@required {postgresId: str}\n@returns(200) {id: str, ipAllowList: [map], createdAt: str(date-time), updatedAt: str(date-time), expiresAt: str(date-time), dashboardUrl: str, databaseName: str, databaseUser: str, environmentId: str, highAvailabilityEnabled: bool, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, plan: str, diskSizeGB: int, parameterOverrides: map, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /postgres/{postgresId}\n@desc Update Postgres instance\n@required {postgresId: str}\n@optional {name: str, plan: str(free/starter/standard/pro/pro_plus/custom/basic_256mb/basic_1gb/basic_4gb/pro_4gb/pro_8gb/pro_16gb/pro_32gb/pro_64gb/pro_128gb/pro_192gb/pro_256gb/pro_384gb/pro_512gb/accelerated_16gb/accelerated_32gb/accelerated_64gb/accelerated_128gb/accelerated_256gb/accelerated_384gb/accelerated_512gb/accelerated_768gb/accelerated_1024gb), diskSizeGB: int # The number of gigabytes of disk space to allocate for the database, enableDiskAutoscaling: bool, enableHighAvailability: bool, datadogAPIKey: str # The Datadog API key for the Datadog agent to monitor the database. Pass empty string to remove. Restarts Postgres on change., datadogSite: str # Datadog region to use for monitoring the new database. Defaults to 'US1'., ipAllowList: [map{cidrBlock!: str, description!: str}], parameterOverrides: map, readReplicas: [map{name!: str, parameterOverrides: map}]}\n@returns(200) {id: str, ipAllowList: [map], createdAt: str(date-time), updatedAt: str(date-time), expiresAt: str(date-time), dashboardUrl: str, databaseName: str, databaseUser: str, environmentId: str, highAvailabilityEnabled: bool, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, plan: str, diskSizeGB: int, parameterOverrides: map, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /postgres/{postgresId}\n@desc Delete Postgres instance\n@required {postgresId: str}\n@returns(204) Postgres instance deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/connection-info\n@desc Retrieve Postgres connection info\n@required {postgresId: str}\n@returns(200) {password: str(password), internalConnectionString: str(password), externalConnectionString: str(password), psqlCommand: str(password)} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/recovery\n@desc Retrieve point-in-time recovery status\n@required {postgresId: str}\n@returns(200) {recoveryStatus: str, startsAt: str(date-time)} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/recovery\n@desc Trigger point-in-time recovery\n@required {postgresId: str, restoreTime: str(date-time) # The point in time to restore the database to. See `/recovery-info` for restore availability}\n@optional {restoreName: str # Name of the new database., datadogApiKey: str # Datadog API key to use for monitoring the new database. Defaults to the API key of the original database. Use an empty string to prevent copying of the API key to the new database., datadogSite: str # Datadog region code to use for monitoring the new database. Defaults to the region code of the original database. Use an empty string to prevent copying of the region code to the new database., plan: str # The plan to use for the new database. Defaults to the same plan as the original database. Cannot be a lower tier plan than the original database., environmentId: str # The environment to create the new database in. Defaults to the environment of the original database.}\n@returns(200) {id: str, ipAllowList: [map], createdAt: str(date-time), updatedAt: str(date-time), expiresAt: str(date-time), dashboardUrl: str, databaseName: str, databaseUser: str, environmentId: str, highAvailabilityEnabled: bool, maintenance: map{id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any}, name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, plan: str, diskSizeGB: int, parameterOverrides: map, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool} # Recovery initiated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/suspend\n@desc Suspend Postgres instance\n@returns(202) Service suspended successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/resume\n@desc Resume Postgres instance\n@returns(202) Service resumed successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/restart\n@desc Restart Postgres instance\n@returns(202) Service restarted successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/failover\n@desc Failover Postgres instance\n@returns(202) Service failed over successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/export\n@desc List Postgres exports\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/export\n@desc Create Postgres export\n@returns(202) Export started successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/credentials\n@desc List PostgreSQL Users\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /postgres/{postgresId}/credentials\n@desc Create PostgreSQL User\n@required {username: str # Name of the new user.}\n@returns(202) PostgreSQL user created successfully\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 410: The requested resource is no longer available., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /postgres/{postgresId}/credentials/{username}\n@desc Delete PostgreSQL User\n@returns(200) PostgreSQL user deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group projects\n@endpoint GET /projects\n@desc List projects\n@optional {name: [str] # Filter by name, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /projects\n@desc Create project\n@required {name: str # The name of the project, ownerId: str # The ID of the owner that the project belongs to, environments: [map{name!: str, protectedStatus: str, networkIsolationEnabled: bool, ipAllowList: [map]}] # The environments to create when creating the project}\n@returns(201) {id: str, createdAt: str(date-time), updatedAt: str(date-time), name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, environmentIds: [str]} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /projects/{projectId}\n@desc Retrieve Project\n@required {projectId: str}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, environmentIds: [str]} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /projects/{projectId}\n@desc Update project\n@required {projectId: str}\n@optional {name: str}\n@returns(200) {id: str, createdAt: str(date-time), updatedAt: str(date-time), name: str, owner: map{id: str, name: str, email: str, ipAllowList: [map], twoFactorAuthEnabled: bool, type: str}, environmentIds: [str]} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /projects/{projectId}\n@desc Delete project\n@required {projectId: str}\n@returns(204) Project deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group environments\n@endpoint POST /environments\n@desc Create environment\n@required {name: str, projectId: str}\n@optional {protectedStatus: str(unprotected/protected) # Indicates whether an environment is `unprotected` or `protected`. Only admin users can perform destructive actions in `protected` environments., networkIsolationEnabled: bool # Indicates whether network connections across environments are allowed., ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(201) {id: str, name: str, projectId: str, databasesIds: [str], ipAllowList: [map], redisIds: [str], serviceIds: [str], envGroupIds: [str], protectedStatus: str, networkIsolationEnabled: bool} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /environments\n@desc List environments\n@required {projectId: [str] # Filter for resources that belong to a project}\n@optional {name: [str] # Filter by name, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, environmentId: [str] # Filter for resources that belong to an environment, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /environments/{environmentId}\n@desc Retrieve environment\n@required {environmentId: str}\n@returns(200) {id: str, name: str, projectId: str, databasesIds: [str], ipAllowList: [map], redisIds: [str], serviceIds: [str], envGroupIds: [str], protectedStatus: str, networkIsolationEnabled: bool} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /environments/{environmentId}\n@desc Update environment\n@required {environmentId: str}\n@optional {name: str, networkIsolationEnabled: bool # Indicates whether network connections across environments are allowed., protectedStatus: str(unprotected/protected) # Indicates whether an environment is `unprotected` or `protected`. Only admin users can perform destructive actions in `protected` environments., ipAllowList: [map{cidrBlock!: str, description!: str}]}\n@returns(200) {id: str, name: str, projectId: str, databasesIds: [str], ipAllowList: [map], redisIds: [str], serviceIds: [str], envGroupIds: [str], protectedStatus: str, networkIsolationEnabled: bool} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /environments/{environmentId}\n@desc Delete environment\n@required {environmentId: str}\n@returns(204) Environment deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /environments/{environmentId}/resources\n@desc Add resources to environment\n@required {environmentId: str, resourceIds: [str]}\n@returns(200) {id: str, name: str, projectId: str, databasesIds: [str], ipAllowList: [map], redisIds: [str], serviceIds: [str], envGroupIds: [str], protectedStatus: str, networkIsolationEnabled: bool} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /environments/{environmentId}/resources\n@desc Remove resources from environment\n@required {environmentId: str, resourceIds: [str]}\n@returns(204) Resources removed from environment\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group env-groups\n@endpoint GET /env-groups\n@desc List environment groups\n@optional {name: [str] # Filter by name, createdBefore: str(date-time) # Filter for resources created before a certain time (specified as an ISO 8601 timestamp), createdAfter: str(date-time) # Filter for resources created after a certain time (specified as an ISO 8601 timestamp), updatedBefore: str(date-time) # Filter for resources updated before a certain time (specified as an ISO 8601 timestamp), updatedAfter: str(date-time) # Filter for resources updated after a certain time (specified as an ISO 8601 timestamp), ownerId: [str] # The ID of the workspaces to return resources for, environmentId: [str] # Filter for resources that belong to an environment, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /env-groups\n@desc Create environment group\n@required {name: str, ownerId: str, envVars: [map]}\n@optional {secretFiles: [map{name!: str, content!: str}], serviceIds: [str], environmentId: str}\n@returns(201) Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /env-groups/{envGroupId}\n@desc Retrieve environment group\n@required {envGroupId: str # Filter for resources that belong to an environment group}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /env-groups/{envGroupId}\n@desc Update environment group\n@required {envGroupId: str, name: str}\n@returns(200) Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /env-groups/{envGroupId}\n@desc Delete environment group\n@required {envGroupId: str}\n@returns(204) environment group deleted\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /env-groups/{envGroupId}/services/{serviceId}\n@desc Link service\n@required {envGroupId: str # Filter for resources that belong to an environment group, serviceId: str # The ID of the service}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /env-groups/{envGroupId}/services/{serviceId}\n@desc Unlink service\n@required {envGroupId: str, serviceId: str}\n@returns(204) service unlinked from environment group\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /env-groups/{envGroupId}/env-vars/{envVarKey}\n@desc Retrieve environment variable\n@required {envGroupId: str # Filter for resources that belong to an environment group, envVarKey: str # The name of the environment variable}\n@returns(200) {key: str, value: str} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /env-groups/{envGroupId}/env-vars/{envVarKey}\n@desc Add or update environment variable\n@required {envGroupId: str # Filter for resources that belong to an environment group, envVarKey: str # The name of the environment variable}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /env-groups/{envGroupId}/env-vars/{envVarKey}\n@desc Remove environment variable\n@required {envGroupId: str, envVarKey: str # The name of the environment variable}\n@returns(204) environment variable removed from environment group\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /env-groups/{envGroupId}/secret-files/{secretFileName}\n@desc Retrieve secret file\n@required {envGroupId: str # Filter for resources that belong to an environment group, secretFileName: str # The name of the secret file}\n@returns(200) {name: str, content: str} # OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /env-groups/{envGroupId}/secret-files/{secretFileName}\n@desc Add or update secret file\n@required {envGroupId: str, secretFileName: str}\n@optional {content: str}\n@returns(200) OK\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /env-groups/{envGroupId}/secret-files/{secretFileName}\n@desc Remove secret file\n@required {envGroupId: str # Filter for resources that belong to an environment group, secretFileName: str # The name of the secret file}\n@returns(204) secret file removed from environment group\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group maintenance\n@endpoint GET /maintenance\n@desc List maintenance runs\n@optional {resourceId: [str], ownerId: [str] # The ID of the workspaces to return resources for, state: [str]}\n@returns(200) Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /maintenance/{maintenanceRunParam}\n@desc Retrieve maintenance run\n@required {maintenanceRunParam: str}\n@returns(200) {id: any, type: str, scheduledAt: str(date-time), pendingMaintenanceBy: str(date-time), state: any, resourceId: any} # Successful response\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /maintenance/{maintenanceRunParam}\n@desc Update maintenance run\n@optional {scheduledAt: str(date-time) # The date-time at which the maintenance is scheduled to start. This must be before the pendingMaintenanceBy date-time.}\n@returns(202) Maintenance run updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /maintenance/{maintenanceRunParam}/trigger\n@desc Trigger maintenance run\n@returns(202) Maintenance run triggered\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group webhooks\n@endpoint POST /webhooks\n@desc Create a webhook\n@required {ownerId: str # The ID of the owner (team or personal user) whose resources should be returned, url: str, name: str, enabled: bool, eventFilter: [str] # The event types that will trigger the webhook. An empty list means all event types will trigger the webhook.}\n@returns(201) {id: any, url: str, name: str, secret: str, enabled: bool, eventFilter: [str]} # Created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /webhooks\n@desc List webhooks\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., ownerId: [str] # The ID of the workspaces to return resources for}\n@returns(200) Success\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /webhooks/{webhookId}\n@desc Retrieve a webhook\n@returns(200) {id: any, url: str, name: str, secret: str, enabled: bool, eventFilter: [str]} # Success\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /webhooks/{webhookId}\n@desc Update a webhook\n@optional {name: str, url: str, enabled: bool, eventFilter: [str] # The event types that will trigger the webhook. An empty list means all event types will trigger the webhook.}\n@returns(200) {id: any, url: str, name: str, secret: str, enabled: bool, eventFilter: [str]} # Updated\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /webhooks/{webhookId}\n@desc Delete a webhook\n@returns(204) Webhook deleted\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /webhooks/{webhookId}/events\n@desc List webhook events\n@optional {sentBefore: str(date-time) # Filter events sent before this time (specified as an ISO 8601 timestamp), sentAfter: str(date-time) # Filter for resources sent after a certain time (specified as an ISO 8601 timestamp), limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) Success\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group workflows\n@endpoint GET /workflows\n@desc List workflows\n@optional {name: [str] # Filter by name, ownerId: [str] # The ID of the workspaces to return resources for, workflowID: [str] # The IDs of the workflows to return resources for, environmentId: [str] # Filter for resources that belong to an environment, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) List of workflows\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /workflows\n@desc Create a workflow\n@required {name: str, ownerId: str, buildConfig: map{branch: str, buildCommand!: str, repo!: str, rootDir: str, runtime!: str}, runCommand: str # The command to run the workflow, region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\"}\n@returns(201) {id: str, name: str, ownerId: str, createdAt: str(date-time), updatedAt: str(date-time), buildConfig: map{branch: str, buildCommand: str, repo: str, rootDir: str, runtime: str}, runCommand: str, region: str, environmentId: str, slug: str} # Workflow created\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /workflows/{workflowId}\n@desc Retrieve workflow\n@returns(200) {id: str, name: str, ownerId: str, createdAt: str(date-time), updatedAt: str(date-time), buildConfig: map{branch: str, buildCommand: str, repo: str, rootDir: str, runtime: str}, runCommand: str, region: str, environmentId: str, slug: str} # Workflow details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /workflows/{workflowId}\n@desc Update workflow\n@optional {name: str, buildConfig: map{branch: str, buildCommand!: str, repo!: str, rootDir: str, runtime!: str}, runCommand: str # The command to run the workflow}\n@returns(200) {id: str, name: str, ownerId: str, createdAt: str(date-time), updatedAt: str(date-time), buildConfig: map{branch: str, buildCommand: str, repo: str, rootDir: str, runtime: str}, runCommand: str, region: str, environmentId: str, slug: str} # Workflow updated\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /workflows/{workflowId}\n@desc Delete workflow\n@returns(204) Workflow deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group workflowversions\n@endpoint GET /workflowversions\n@desc List workflow versions\n@optional {ownerId: [str] # The ID of the workspaces to return resources for, workflowID: [str] # The IDs of the workflows to return resources for, workflowVersionId: [str] # The IDs of the workflow versions to return resources for, cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) List of workflow versions\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /workflowversions\n@desc Deploy a workflow version\n@required {workflowId: str}\n@optional {commit: str}\n@returns(202) Workflow version created\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /workflowversions/{workflowVersionId}\n@desc Retrieve workflow version\n@returns(200) {id: str, workflowId: str, name: str, createdAt: str(date-time), status: str} # Workflow version details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group tasks\n@endpoint GET /tasks\n@desc List tasks\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).}\n@returns(200) List of tasks\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /tasks/{taskId}\n@desc Retrieve task\n@returns(200) {id: str, name: str, createdAt: str(date-time), workflowId: str, workflowVersionId: str} # Task details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group task-runs\n@endpoint GET /task-runs\n@desc List task runs\n@optional {cursor: str # The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., limit: int=20 # The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination)., rootTaskRunId: [str] # An array of root task run IDs to filter on, ownerId: [str] # The ID of the workspaces to return resources for}\n@returns(200) List of task runs\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /task-runs\n@desc Run task\n@required {task: str # A task slug 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., input: any # Input data for a task. Can be either an array (for positional arguments) or an object (for named parameters).}\n@returns(202) {id: str, taskId: str, status: str, startedAt: str(date-time), completedAt: str(date-time), parentTaskRunId: str, rootTaskRunId: str, retries: int, attempts: [map]} # Task run created\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /task-runs/events\n@desc Stream realtime events (SSE)\n@required {taskRunIds: [str] # Filter to a subset of task run IDs.}\n@optional {Accept: str # Must be `text/event-stream`.}\n@returns(200) Event stream established\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /task-runs/{taskRunId}\n@desc Retrieve task run\n@returns(200) {id: str, taskId: str, status: str, results: [any], error: str, startedAt: str(date-time), completedAt: str(date-time), input: any, parentTaskRunId: str, rootTaskRunId: str, retries: int, attempts: [map]} # Task run details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /task-runs/{taskRunId}\n@desc Cancel task run\n@returns(204) Task run canceled\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource., 404: Unable to find the requested resource., 429: Rate limit has been surpassed., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@end\n"}