{"files":{"SKILL.md":"---\nname: render-public-api\ndescription: \"Render Public API skill. Use when working with Render Public for blueprints, owners, dedicated-ips. Covers 263 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Render Public API\nAPI version: 1.0.0\n\n## Auth\nBearer bearer\n\n## Base URL\nhttps://api.render.com/v1\n\n## Setup\n1. Set Authorization header with your Bearer token\n2. GET /blueprints -- verify access\n3. POST /blueprints/validate -- create first validate\n\n## Endpoints\n\n263 endpoints across 31 groups. See references/api-spec.lap for full details.\n\n### blueprints\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /blueprints | List Blueprints |\n| POST | /blueprints/validate | Validate Blueprint |\n| GET | /blueprints/{blueprintId} | Retrieve Blueprint |\n| PATCH | /blueprints/{blueprintId} | Update Blueprint |\n| DELETE | /blueprints/{blueprintId} | Disconnect Blueprint |\n| GET | /blueprints/{blueprintId}/syncs | List Blueprint syncs |\n\n### owners\n| Method | Path | Description |\n|--------|------|-------------|\n| PATCH | /owners/{ownerId}/members/{userId} | Update workspace member role |\n| DELETE | /owners/{ownerId}/members/{userId} | Remove workspace member |\n| GET | /owners | List workspaces |\n| GET | /owners/{ownerId} | Retrieve workspace |\n| GET | /owners/{ownerId}/members | List workspace members |\n| GET | /owners/{ownerId}/audit-logs | List workspace audit logs |\n\n### dedicated-ips\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /dedicated-ips | List dedicated IPs |\n| POST | /dedicated-ips | Create dedicated IP set |\n| GET | /dedicated-ips/{dedicatedIpId} | Retrieve dedicated IP set |\n| PATCH | /dedicated-ips/{dedicatedIpId} | Update dedicated IP set |\n| DELETE | /dedicated-ips/{dedicatedIpId} | Delete dedicated IP set |\n\n### disks\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /disks | List disks |\n| POST | /disks | Add disk |\n| GET | /disks/{diskId} | Retrieve disk |\n| PATCH | /disks/{diskId} | Update disk |\n| DELETE | /disks/{diskId} | Delete disk |\n| GET | /disks/{diskId}/snapshots | List snapshots |\n| POST | /disks/{diskId}/snapshots/restore | Restore snapshot |\n\n### users\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /users | Get the authenticated user |\n\n### organizations\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /organizations/{orgId}/audit-logs | List organization audit logs |\n\n### notification-settings\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /notification-settings/owners/{ownerId} | Retrieve notification settings |\n| PATCH | /notification-settings/owners/{ownerId} | Update notification settings |\n| GET | /notification-settings/overrides | List notification overrides |\n| GET | /notification-settings/overrides/services/{serviceId} | Retrieve notification override |\n| PATCH | /notification-settings/overrides/services/{serviceId} | Update notification override |\n\n### registrycredentials\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /registrycredentials | List registry credentials |\n| POST | /registrycredentials | Create registry credential |\n| GET | /registrycredentials/{registryCredentialId} | Retrieve registry credential |\n| PATCH | /registrycredentials/{registryCredentialId} | Update registry credential |\n| DELETE | /registrycredentials/{registryCredentialId} | Delete registry credential |\n\n### services\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /services | List services |\n| POST | /services | Create service |\n| GET | /services/{serviceId} | Retrieve service |\n| PATCH | /services/{serviceId} | Update service |\n| DELETE | /services/{serviceId} | Delete service |\n| POST | /services/{serviceId}/cache/purge | Purge Web Service Cache |\n| GET | /services/{serviceId}/deploys | List deploys |\n| POST | /services/{serviceId}/deploys | Trigger deploy |\n| GET | /services/{serviceId}/deploys/{deployId} | Retrieve deploy |\n| POST | /services/{serviceId}/deploys/{deployId}/cancel | Cancel deploy |\n| POST | /services/{serviceId}/rollback | Roll back deploy |\n| GET | /services/{serviceId}/env-vars | List environment variables |\n| PUT | /services/{serviceId}/env-vars | Update environment variables |\n| GET | /services/{serviceId}/env-vars/{envVarKey} | Retrieve environment variable |\n| PUT | /services/{serviceId}/env-vars/{envVarKey} | Add or update environment variable |\n| DELETE | /services/{serviceId}/env-vars/{envVarKey} | Delete environment variable |\n| GET | /services/{serviceId}/secret-files | List secret files |\n| PUT | /services/{serviceId}/secret-files | Update secret files |\n| GET | /services/{serviceId}/secret-files/{envVarKey} | Retrieve secret file |\n| PUT | /services/{serviceId}/secret-files/{envVarKey} | Add or update secret file |\n| DELETE | /services/{serviceId}/secret-files/{envVarKey} | Delete secret file |\n| GET | /services/{serviceId}/events | List events |\n| GET | /services/{serviceId}/headers | List header rules |\n| POST | /services/{serviceId}/headers | Add header rule |\n| PUT | /services/{serviceId}/headers | Replace header rules |\n| DELETE | /services/{serviceId}/headers/{headerId} | Delete header rule |\n| GET | /services/{serviceId}/routes | List redirect/rewrite rules |\n| POST | /services/{serviceId}/routes | Add redirect/rewrite rules |\n| PUT | /services/{serviceId}/routes | Update redirect/rewrite rules |\n| PATCH | /services/{serviceId}/routes/{routeId} | Update redirect/rewrite rule priority |\n| DELETE | /services/{serviceId}/routes/{routeId} | Delete redirect/rewrite rule |\n| GET | /services/{serviceId}/custom-domains | List custom domains |\n| POST | /services/{serviceId}/custom-domains | Add custom domain |\n| GET | /services/{serviceId}/custom-domains/{customDomainNameOrID} | Retrieve custom domain |\n| DELETE | /services/{serviceId}/custom-domains/{customDomainNameOrID} | Delete custom domain |\n| POST | /services/{serviceId}/custom-domains/{customDomainNameOrID}/verify | Verify DNS configuration |\n| POST | /services/{serviceId}/suspend | Suspend service |\n| POST | /services/{serviceId}/resume | Resume service |\n| POST | /services/{serviceId}/restart | Restart service |\n| POST | /services/{serviceId}/scale | Scale instance count |\n| PUT | /services/{serviceId}/autoscaling | Update autoscaling config |\n| DELETE | /services/{serviceId}/autoscaling | Delete autoscaling config |\n| POST | /services/{serviceId}/preview | Create service preview (image-backed) |\n| GET | /services/{serviceId}/jobs | List jobs |\n| POST | /services/{serviceId}/jobs | Create job |\n| GET | /services/{serviceId}/jobs/{jobId} | Retrieve job |\n| POST | /services/{serviceId}/jobs/{jobId}/cancel | Cancel running job |\n| GET | /services/{serviceId}/instances | List instances |\n| GET | /services/{serviceId}/outbound-ips | Retrieve service outbound IPs |\n\n### cron-jobs\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /cron-jobs/{cronJobId}/runs | Trigger cron job run |\n| DELETE | /cron-jobs/{cronJobId}/runs | Cancel running cron job |\n\n### events\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /events/{eventId} | Retrieve event |\n\n### logs\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /logs | List logs |\n| GET | /logs/subscribe | Subscribe to new logs |\n| GET | /logs/values | List log label values |\n| GET | /logs/streams/owner/{ownerId} | Retrieve log stream |\n| PUT | /logs/streams/owner/{ownerId} | Update log stream |\n| DELETE | /logs/streams/owner/{ownerId} | Delete log stream |\n| GET | /logs/streams/resource | List log stream overrides |\n| GET | /logs/streams/resource/{resourceId} | Retrieve log stream override |\n| PUT | /logs/streams/resource/{resourceId} | Update log stream override |\n| DELETE | /logs/streams/resource/{resourceId} | Delete log stream override |\n\n### metrics-stream\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /metrics-stream/{ownerId} | Retrieve metrics stream |\n| PUT | /metrics-stream/{ownerId} | Create or update metrics stream |\n| DELETE | /metrics-stream/{ownerId} | Delete metrics stream |\n\n### metrics\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /metrics/cpu | Get CPU usage |\n| GET | /metrics/cpu-limit | Get CPU limit |\n| GET | /metrics/cpu-target | Get CPU target |\n| GET | /metrics/memory | Get memory usage |\n| GET | /metrics/memory-limit | Get memory limit |\n| GET | /metrics/memory-target | Get memory target |\n| GET | /metrics/http-requests | Get HTTP request count |\n| GET | /metrics/http-latency | Get HTTP latency |\n| GET | /metrics/bandwidth | Get bandwidth usage |\n| GET | /metrics/bandwidth-sources | Get bandwidth usage breakdown by traffic source |\n| GET | /metrics/disk-usage | Get disk usage |\n| GET | /metrics/disk-capacity | Get disk capacity |\n| GET | /metrics/instance-count | Get instance count |\n| GET | /metrics/active-connections | Get active connection count |\n| GET | /metrics/replication-lag | Get replica lag |\n| GET | /metrics/filters/application | List queryable instance values |\n| GET | /metrics/filters/http | List queryable status codes and host values |\n| GET | /metrics/filters/path | List queryable paths |\n| GET | /metrics/task-runs-queued | Get task runs queued count |\n| GET | /metrics/task-runs-completed | Get task runs completed count |\n\n### key-value\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /key-value | List Key Value instances |\n| POST | /key-value | Create Key Value instance |\n| GET | /key-value/{redisId} | Retrieve Key Value instance |\n| PATCH | /key-value/{redisId} | Update Key Value instance |\n| DELETE | /key-value/{redisId} | Delete Key Value instance |\n| GET | /key-value/{redisId}/connection-info | Retrieve Key Value connection info |\n| POST | /key-value/{redisId}/suspend | Suspend Key Value instance |\n| POST | /key-value/{redisId}/resume | Resume Key Value instance |\n\n### redis\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /redis | List Redis instances |\n| POST | /redis | Create Redis instance |\n| GET | /redis/{redisId} | Retrieve Redis instance |\n| PATCH | /redis/{redisId} | Update Redis instance |\n| DELETE | /redis/{redisId} | Delete Redis instance |\n| GET | /redis/{redisId}/connection-info | Retrieve Redis connection info |\n| POST | /redis/{redisId}/suspend | Suspend Redis instance |\n| POST | /redis/{redisId}/resume | Resume Redis instance |\n\n### postgres\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /postgres | List Postgres instances |\n| POST | /postgres | Create Postgres instance |\n| GET | /postgres/{postgresId} | Retrieve Postgres instance |\n| PATCH | /postgres/{postgresId} | Update Postgres instance |\n| DELETE | /postgres/{postgresId} | Delete Postgres instance |\n| GET | /postgres/{postgresId}/connection-info | Retrieve Postgres connection info |\n| GET | /postgres/{postgresId}/recovery | Retrieve point-in-time recovery status |\n| POST | /postgres/{postgresId}/recovery | Trigger point-in-time recovery |\n| POST | /postgres/{postgresId}/suspend | Suspend Postgres instance |\n| POST | /postgres/{postgresId}/resume | Resume Postgres instance |\n| POST | /postgres/{postgresId}/restart | Restart Postgres instance |\n| POST | /postgres/{postgresId}/failover | Failover Postgres instance |\n| GET | /postgres/{postgresId}/export | List Postgres exports |\n| POST | /postgres/{postgresId}/export | Create Postgres export |\n| GET | /postgres/{postgresId}/credentials | List PostgreSQL Users |\n| POST | /postgres/{postgresId}/credentials | Create PostgreSQL User |\n| DELETE | /postgres/{postgresId}/credentials/{username} | Delete PostgreSQL User |\n| GET | /postgres/{postgresId}/query/processes | List live queries |\n| GET | /postgres/{postgresId}/query/top-queries | List top queries |\n| GET | /postgres/{postgresId}/query/sizes | List database, table, and index sizes |\n| GET | /postgres/{postgresId}/query/table-scans | List table scans |\n\n### projects\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /projects | List projects |\n| POST | /projects | Create project |\n| GET | /projects/{projectId} | Retrieve Project |\n| PATCH | /projects/{projectId} | Update project |\n| DELETE | /projects/{projectId} | Delete project |\n\n### environments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /environments | Create environment |\n| GET | /environments | List environments |\n| GET | /environments/{environmentId} | Retrieve environment |\n| PATCH | /environments/{environmentId} | Update environment |\n| DELETE | /environments/{environmentId} | Delete environment |\n| POST | /environments/{environmentId}/resources | Add resources to environment |\n| DELETE | /environments/{environmentId}/resources | Remove resources from environment |\n\n### env-groups\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /env-groups | List environment groups |\n| POST | /env-groups | Create environment group |\n| GET | /env-groups/{envGroupId} | Retrieve environment group |\n| PATCH | /env-groups/{envGroupId} | Update environment group |\n| DELETE | /env-groups/{envGroupId} | Delete environment group |\n| POST | /env-groups/{envGroupId}/services/{serviceId} | Link service |\n| DELETE | /env-groups/{envGroupId}/services/{serviceId} | Unlink service |\n| GET | /env-groups/{envGroupId}/env-vars/{envVarKey} | Retrieve environment variable |\n| PUT | /env-groups/{envGroupId}/env-vars/{envVarKey} | Add or update environment variable |\n| DELETE | /env-groups/{envGroupId}/env-vars/{envVarKey} | Remove environment variable |\n| GET | /env-groups/{envGroupId}/secret-files/{envVarKey} | Retrieve secret file |\n| PUT | /env-groups/{envGroupId}/secret-files/{envVarKey} | Add or update secret file |\n| DELETE | /env-groups/{envGroupId}/secret-files/{envVarKey} | Remove secret file |\n\n### maintenance\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /maintenance | List maintenance runs |\n| GET | /maintenance/{maintenanceRunID} | Retrieve maintenance run |\n| PATCH | /maintenance/{maintenanceRunID} | Update maintenance run |\n| POST | /maintenance/{maintenanceRunID}/trigger | Trigger maintenance run |\n\n### build-sources\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /build-sources | Create a build source |\n| GET | /build-sources | List build sources |\n| GET | /build-sources/{buildSourceId} | Retrieve a build source |\n| PATCH | /build-sources/{buildSourceId} | Update a build source |\n| DELETE | /build-sources/{buildSourceId} | Delete a build source |\n| GET | /build-sources/{buildSourceId}/builds | List builds in a build source |\n| POST | /build-sources/{buildSourceId}/builds | Trigger a build |\n| GET | /build-sources/{buildSourceId}/builds/{buildId} | Retrieve a build |\n| GET | /build-sources/{buildSourceId}/env-vars | List environment variables |\n| PUT | /build-sources/{buildSourceId}/env-vars | Update environment variables |\n| GET | /build-sources/{buildSourceId}/env-vars/{envVarKey} | Retrieve environment variable |\n| PUT | /build-sources/{buildSourceId}/env-vars/{envVarKey} | Add or update environment variable |\n| DELETE | /build-sources/{buildSourceId}/env-vars/{envVarKey} | Delete environment variable |\n| GET | /build-sources/{buildSourceId}/secret-files | List secret files |\n| PUT | /build-sources/{buildSourceId}/secret-files | Update secret files |\n| GET | /build-sources/{buildSourceId}/secret-files/{envVarKey} | Retrieve secret file |\n| PUT | /build-sources/{buildSourceId}/secret-files/{envVarKey} | Add or update secret file |\n| DELETE | /build-sources/{buildSourceId}/secret-files/{envVarKey} | Delete secret file |\n| POST | /build-sources/{buildSourceId}/env-groups/{envGroupId} | Link environment group |\n| DELETE | /build-sources/{buildSourceId}/env-groups/{envGroupId} | Unlink environment group |\n\n### webhooks\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /webhooks | Create a webhook |\n| GET | /webhooks | List webhooks |\n| GET | /webhooks/{webhookId} | Retrieve a webhook |\n| PATCH | /webhooks/{webhookId} | Update a webhook |\n| DELETE | /webhooks/{webhookId} | Delete a webhook |\n| GET | /webhooks/{webhookId}/events | List webhook events |\n\n### workflows\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /workflows | List workflows |\n| POST | /workflows | Create a workflow |\n| GET | /workflows/{workflowId} | Retrieve workflow |\n| PATCH | /workflows/{workflowId} | Update workflow |\n| DELETE | /workflows/{workflowId} | Delete workflow |\n\n### workflowversions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /workflowversions | List workflow versions |\n| POST | /workflowversions | Deploy a workflow version |\n| GET | /workflowversions/{workflowVersionId} | Retrieve workflow version |\n\n### tasks\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /tasks | List tasks |\n| GET | /tasks/{taskId} | Retrieve task |\n\n### task-runs\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /task-runs | List task runs |\n| POST | /task-runs | Run task |\n| GET | /task-runs/events | Stream realtime events (SSE) |\n| GET | /task-runs/{taskRunId} | Retrieve task run |\n| DELETE | /task-runs/{taskRunId} | Cancel task run |\n\n### flows\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /flows | List flows |\n| GET | /flows/{flowId} | Retrieve flow |\n\n### flow-runs\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /flow-runs | List flow runs |\n| POST | /flow-runs | Start flow run |\n| GET | /flow-runs/{flowRunId} | Retrieve flow run |\n| DELETE | /flow-runs/{flowRunId} | Cancel flow run |\n| GET | /flow-runs/{flowRunId}/steps | List flow run steps |\n| GET | /flow-runs/{flowRunId}/steps/{stepSeq} | Retrieve flow run step |\n\n### sandboxes\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /sandboxes | Create sandbox |\n| GET | /sandboxes | List sandboxes |\n| GET | /sandboxes/{sandboxId} | Retrieve sandbox |\n| GET | /sandboxes/{sandboxId}/execs | List executions |\n| GET | /sandboxes/{sandboxId}/execs/{execId} | Retrieve execution |\n| POST | /sandboxes/{sandboxId}/terminate | Terminate sandbox |\n| POST | /sandboxes/{sandboxId}/snapshots | Create sandbox snapshot |\n| POST | /sandboxes/{sandboxId}/runs/{operation}/token | Create a connect token for a sandbox run |\n| POST | /sandboxes/{sandboxId}/files/{operation}/token | Mint a connect token for a sandbox file transfer |\n\n### sandbox-groups\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /sandbox-groups | Create sandbox group |\n| GET | /sandbox-groups | List sandbox groups |\n| GET | /sandbox-groups/{sandboxGroupId} | Retrieve sandbox group |\n| PATCH | /sandbox-groups/{sandboxGroupId} | Update sandbox group |\n| GET | /sandbox-groups/{sandboxGroupId}/credentials | List sandbox group credentials |\n| POST | /sandbox-groups/{sandboxGroupId}/credentials | Create sandbox group credential |\n| GET | /sandbox-groups/{sandboxGroupId}/credentials/{credentialId} | Retrieve sandbox group credential |\n| PATCH | /sandbox-groups/{sandboxGroupId}/credentials/{credentialId} | Update sandbox group credential |\n| DELETE | /sandbox-groups/{sandboxGroupId}/credentials/{credentialId} | Delete sandbox group credential |\n| GET | /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/versions | List sandbox credential versions |\n| POST | /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/restore | Restore sandbox credential configuration |\n| GET | /sandbox-groups/{sandboxGroupId}/builds | List sandbox builds |\n| POST | /sandbox-groups/{sandboxGroupId}/builds | Create sandbox build |\n| GET | /sandbox-groups/{sandboxGroupId}/builds/{buildId} | Retrieve sandbox build |\n| DELETE | /sandbox-groups/{sandboxGroupId}/builds/{buildId} | Delete sandbox build |\n| GET | /sandbox-groups/{sandboxGroupId}/snapshots | List sandbox snapshots |\n| GET | /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId} | Retrieve sandbox snapshot |\n| DELETE | /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId} | Delete sandbox snapshot |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all blueprints?\" -> GET /blueprints\n- \"Create a validate?\" -> POST /blueprints/validate\n- \"Partially update a member?\" -> PATCH /owners/{ownerId}/members/{userId}\n- \"Delete a member?\" -> DELETE /owners/{ownerId}/members/{userId}\n- \"Get blueprint details?\" -> GET /blueprints/{blueprintId}\n- \"Partially update a blueprint?\" -> PATCH /blueprints/{blueprintId}\n- \"Delete a blueprint?\" -> DELETE /blueprints/{blueprintId}\n- \"List all syncs?\" -> GET /blueprints/{blueprintId}/syncs\n- \"List all dedicated-ips?\" -> GET /dedicated-ips\n- \"Create a dedicated-ip?\" -> POST /dedicated-ips\n- \"Get dedicated-ip details?\" -> GET /dedicated-ips/{dedicatedIpId}\n- \"Partially update a dedicated-ip?\" -> PATCH /dedicated-ips/{dedicatedIpId}\n- \"Delete a dedicated-ip?\" -> DELETE /dedicated-ips/{dedicatedIpId}\n- \"List all disks?\" -> GET /disks\n- \"Create a disk?\" -> POST /disks\n- \"Get disk details?\" -> GET /disks/{diskId}\n- \"Partially update a disk?\" -> PATCH /disks/{diskId}\n- \"Delete a disk?\" -> DELETE /disks/{diskId}\n- \"List all snapshots?\" -> GET /disks/{diskId}/snapshots\n- \"Create a restore?\" -> POST /disks/{diskId}/snapshots/restore\n- \"List all users?\" -> GET /users\n- \"List all owners?\" -> GET /owners\n- \"Get owner details?\" -> GET /owners/{ownerId}\n- \"List all members?\" -> GET /owners/{ownerId}/members\n- \"List all audit-logs?\" -> GET /owners/{ownerId}/audit-logs\n- \"List all audit-logs?\" -> GET /organizations/{orgId}/audit-logs\n- \"Get owner details?\" -> GET /notification-settings/owners/{ownerId}\n- \"Partially update a owner?\" -> PATCH /notification-settings/owners/{ownerId}\n- \"List all overrides?\" -> GET /notification-settings/overrides\n- \"Get service details?\" -> GET /notification-settings/overrides/services/{serviceId}\n- \"Partially update a service?\" -> PATCH /notification-settings/overrides/services/{serviceId}\n- \"List all registrycredentials?\" -> GET /registrycredentials\n- \"Create a registrycredential?\" -> POST /registrycredentials\n- \"Get registrycredential details?\" -> GET /registrycredentials/{registryCredentialId}\n- \"Partially update a registrycredential?\" -> PATCH /registrycredentials/{registryCredentialId}\n- \"Delete a registrycredential?\" -> DELETE /registrycredentials/{registryCredentialId}\n- \"List all services?\" -> GET /services\n- \"Create a service?\" -> POST /services\n- \"Get service details?\" -> GET /services/{serviceId}\n- \"Partially update a service?\" -> PATCH /services/{serviceId}\n- \"Delete a service?\" -> DELETE /services/{serviceId}\n- \"Create a purge?\" -> POST /services/{serviceId}/cache/purge\n- \"List all deploys?\" -> GET /services/{serviceId}/deploys\n- \"Create a deploy?\" -> POST /services/{serviceId}/deploys\n- \"Get deploy details?\" -> GET /services/{serviceId}/deploys/{deployId}\n- \"Create a cancel?\" -> POST /services/{serviceId}/deploys/{deployId}/cancel\n- \"Create a rollback?\" -> POST /services/{serviceId}/rollback\n- \"List all env-vars?\" -> GET /services/{serviceId}/env-vars\n- \"Get env-var details?\" -> GET /services/{serviceId}/env-vars/{envVarKey}\n- \"Update a env-var?\" -> PUT /services/{serviceId}/env-vars/{envVarKey}\n- \"Delete a env-var?\" -> DELETE /services/{serviceId}/env-vars/{envVarKey}\n- \"List all secret-files?\" -> GET /services/{serviceId}/secret-files\n- \"Get secret-file details?\" -> GET /services/{serviceId}/secret-files/{envVarKey}\n- \"Update a secret-file?\" -> PUT /services/{serviceId}/secret-files/{envVarKey}\n- \"Delete a secret-file?\" -> DELETE /services/{serviceId}/secret-files/{envVarKey}\n- \"List all events?\" -> GET /services/{serviceId}/events\n- \"List all headers?\" -> GET /services/{serviceId}/headers\n- \"Create a header?\" -> POST /services/{serviceId}/headers\n- \"Delete a header?\" -> DELETE /services/{serviceId}/headers/{headerId}\n- \"List all routes?\" -> GET /services/{serviceId}/routes\n- \"Create a route?\" -> POST /services/{serviceId}/routes\n- \"Partially update a route?\" -> PATCH /services/{serviceId}/routes/{routeId}\n- \"Delete a route?\" -> DELETE /services/{serviceId}/routes/{routeId}\n- \"List all custom-domains?\" -> GET /services/{serviceId}/custom-domains\n- \"Create a custom-domain?\" -> POST /services/{serviceId}/custom-domains\n- \"Get custom-domain details?\" -> GET /services/{serviceId}/custom-domains/{customDomainNameOrID}\n- \"Delete a custom-domain?\" -> DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID}\n- \"Create a verify?\" -> POST /services/{serviceId}/custom-domains/{customDomainNameOrID}/verify\n- \"Create a suspend?\" -> POST /services/{serviceId}/suspend\n- \"Create a resume?\" -> POST /services/{serviceId}/resume\n- \"Create a restart?\" -> POST /services/{serviceId}/restart\n- \"Create a scale?\" -> POST /services/{serviceId}/scale\n- \"Create a preview?\" -> POST /services/{serviceId}/preview\n- \"List all jobs?\" -> GET /services/{serviceId}/jobs\n- \"Create a job?\" -> POST /services/{serviceId}/jobs\n- \"Get job details?\" -> GET /services/{serviceId}/jobs/{jobId}\n- \"Create a cancel?\" -> POST /services/{serviceId}/jobs/{jobId}/cancel\n- \"List all instances?\" -> GET /services/{serviceId}/instances\n- \"List all outbound-ips?\" -> GET /services/{serviceId}/outbound-ips\n- \"Create a run?\" -> POST /cron-jobs/{cronJobId}/runs\n- \"Get event details?\" -> GET /events/{eventId}\n- \"List all logs?\" -> GET /logs\n- \"List all subscribe?\" -> GET /logs/subscribe\n- \"List all values?\" -> GET /logs/values\n- \"Get owner details?\" -> GET /logs/streams/owner/{ownerId}\n- \"Update a owner?\" -> PUT /logs/streams/owner/{ownerId}\n- \"Delete a owner?\" -> DELETE /logs/streams/owner/{ownerId}\n- \"List all resource?\" -> GET /logs/streams/resource\n- \"Get resource details?\" -> GET /logs/streams/resource/{resourceId}\n- \"Update a resource?\" -> PUT /logs/streams/resource/{resourceId}\n- \"Delete a resource?\" -> DELETE /logs/streams/resource/{resourceId}\n- \"Get metrics-stream details?\" -> GET /metrics-stream/{ownerId}\n- \"Update a metrics-stream?\" -> PUT /metrics-stream/{ownerId}\n- \"Delete a metrics-stream?\" -> DELETE /metrics-stream/{ownerId}\n- \"List all cpu?\" -> GET /metrics/cpu\n- \"List all cpu-limit?\" -> GET /metrics/cpu-limit\n- \"List all cpu-target?\" -> GET /metrics/cpu-target\n- \"List all memory?\" -> GET /metrics/memory\n- \"List all memory-limit?\" -> GET /metrics/memory-limit\n- \"List all memory-target?\" -> GET /metrics/memory-target\n- \"List all http-requests?\" -> GET /metrics/http-requests\n- \"List all http-latency?\" -> GET /metrics/http-latency\n- \"List all bandwidth?\" -> GET /metrics/bandwidth\n- \"List all bandwidth-sources?\" -> GET /metrics/bandwidth-sources\n- \"List all disk-usage?\" -> GET /metrics/disk-usage\n- \"List all disk-capacity?\" -> GET /metrics/disk-capacity\n- \"List all instance-count?\" -> GET /metrics/instance-count\n- \"List all active-connections?\" -> GET /metrics/active-connections\n- \"List all replication-lag?\" -> GET /metrics/replication-lag\n- \"List all application?\" -> GET /metrics/filters/application\n- \"List all http?\" -> GET /metrics/filters/http\n- \"List all path?\" -> GET /metrics/filters/path\n- \"List all task-runs-queued?\" -> GET /metrics/task-runs-queued\n- \"List all task-runs-completed?\" -> GET /metrics/task-runs-completed\n- \"List all key-value?\" -> GET /key-value\n- \"Create a key-value?\" -> POST /key-value\n- \"Get key-value details?\" -> GET /key-value/{redisId}\n- \"Partially update a key-value?\" -> PATCH /key-value/{redisId}\n- \"Delete a key-value?\" -> DELETE /key-value/{redisId}\n- \"List all connection-info?\" -> GET /key-value/{redisId}/connection-info\n- \"Create a suspend?\" -> POST /key-value/{redisId}/suspend\n- \"Create a resume?\" -> POST /key-value/{redisId}/resume\n- \"List all redis?\" -> GET /redis\n- \"Create a redis?\" -> POST /redis\n- \"Get redis details?\" -> GET /redis/{redisId}\n- \"Partially update a redis?\" -> PATCH /redis/{redisId}\n- \"Delete a redis?\" -> DELETE /redis/{redisId}\n- \"List all connection-info?\" -> GET /redis/{redisId}/connection-info\n- \"Create a suspend?\" -> POST /redis/{redisId}/suspend\n- \"Create a resume?\" -> POST /redis/{redisId}/resume\n- \"List all postgres?\" -> GET /postgres\n- \"Create a postgre?\" -> POST /postgres\n- \"Get postgre details?\" -> GET /postgres/{postgresId}\n- \"Partially update a postgre?\" -> PATCH /postgres/{postgresId}\n- \"Delete a postgre?\" -> DELETE /postgres/{postgresId}\n- \"List all connection-info?\" -> GET /postgres/{postgresId}/connection-info\n- \"List all recovery?\" -> GET /postgres/{postgresId}/recovery\n- \"Create a recovery?\" -> POST /postgres/{postgresId}/recovery\n- \"Create a suspend?\" -> POST /postgres/{postgresId}/suspend\n- \"Create a resume?\" -> POST /postgres/{postgresId}/resume\n- \"Create a restart?\" -> POST /postgres/{postgresId}/restart\n- \"Create a failover?\" -> POST /postgres/{postgresId}/failover\n- \"List all export?\" -> GET /postgres/{postgresId}/export\n- \"Create a export?\" -> POST /postgres/{postgresId}/export\n- \"List all credentials?\" -> GET /postgres/{postgresId}/credentials\n- \"Create a credential?\" -> POST /postgres/{postgresId}/credentials\n- \"Delete a credential?\" -> DELETE /postgres/{postgresId}/credentials/{username}\n- \"List all processes?\" -> GET /postgres/{postgresId}/query/processes\n- \"List all top-queries?\" -> GET /postgres/{postgresId}/query/top-queries\n- \"List all sizes?\" -> GET /postgres/{postgresId}/query/sizes\n- \"List all table-scans?\" -> GET /postgres/{postgresId}/query/table-scans\n- \"List all projects?\" -> GET /projects\n- \"Create a project?\" -> POST /projects\n- \"Get project details?\" -> GET /projects/{projectId}\n- \"Partially update a project?\" -> PATCH /projects/{projectId}\n- \"Delete a project?\" -> DELETE /projects/{projectId}\n- \"Create a environment?\" -> POST /environments\n- \"List all environments?\" -> GET /environments\n- \"Get environment details?\" -> GET /environments/{environmentId}\n- \"Partially update a environment?\" -> PATCH /environments/{environmentId}\n- \"Delete a environment?\" -> DELETE /environments/{environmentId}\n- \"Create a resource?\" -> POST /environments/{environmentId}/resources\n- \"List all env-groups?\" -> GET /env-groups\n- \"Create a env-group?\" -> POST /env-groups\n- \"Get env-group details?\" -> GET /env-groups/{envGroupId}\n- \"Partially update a env-group?\" -> PATCH /env-groups/{envGroupId}\n- \"Delete a env-group?\" -> DELETE /env-groups/{envGroupId}\n- \"Delete a service?\" -> DELETE /env-groups/{envGroupId}/services/{serviceId}\n- \"Get env-var details?\" -> GET /env-groups/{envGroupId}/env-vars/{envVarKey}\n- \"Update a env-var?\" -> PUT /env-groups/{envGroupId}/env-vars/{envVarKey}\n- \"Delete a env-var?\" -> DELETE /env-groups/{envGroupId}/env-vars/{envVarKey}\n- \"Get secret-file details?\" -> GET /env-groups/{envGroupId}/secret-files/{envVarKey}\n- \"Update a secret-file?\" -> PUT /env-groups/{envGroupId}/secret-files/{envVarKey}\n- \"Delete a secret-file?\" -> DELETE /env-groups/{envGroupId}/secret-files/{envVarKey}\n- \"List all maintenance?\" -> GET /maintenance\n- \"Get maintenance details?\" -> GET /maintenance/{maintenanceRunID}\n- \"Partially update a maintenance?\" -> PATCH /maintenance/{maintenanceRunID}\n- \"Create a trigger?\" -> POST /maintenance/{maintenanceRunID}/trigger\n- \"Create a build-source?\" -> POST /build-sources\n- \"List all build-sources?\" -> GET /build-sources\n- \"Get build-source details?\" -> GET /build-sources/{buildSourceId}\n- \"Partially update a build-source?\" -> PATCH /build-sources/{buildSourceId}\n- \"Delete a build-source?\" -> DELETE /build-sources/{buildSourceId}\n- \"List all builds?\" -> GET /build-sources/{buildSourceId}/builds\n- \"Create a build?\" -> POST /build-sources/{buildSourceId}/builds\n- \"Get build details?\" -> GET /build-sources/{buildSourceId}/builds/{buildId}\n- \"List all env-vars?\" -> GET /build-sources/{buildSourceId}/env-vars\n- \"Get env-var details?\" -> GET /build-sources/{buildSourceId}/env-vars/{envVarKey}\n- \"Update a env-var?\" -> PUT /build-sources/{buildSourceId}/env-vars/{envVarKey}\n- \"Delete a env-var?\" -> DELETE /build-sources/{buildSourceId}/env-vars/{envVarKey}\n- \"List all secret-files?\" -> GET /build-sources/{buildSourceId}/secret-files\n- \"Get secret-file details?\" -> GET /build-sources/{buildSourceId}/secret-files/{envVarKey}\n- \"Update a secret-file?\" -> PUT /build-sources/{buildSourceId}/secret-files/{envVarKey}\n- \"Delete a secret-file?\" -> DELETE /build-sources/{buildSourceId}/secret-files/{envVarKey}\n- \"Delete a env-group?\" -> DELETE /build-sources/{buildSourceId}/env-groups/{envGroupId}\n- \"Create a webhook?\" -> POST /webhooks\n- \"List all webhooks?\" -> GET /webhooks\n- \"Get webhook details?\" -> GET /webhooks/{webhookId}\n- \"Partially update a webhook?\" -> PATCH /webhooks/{webhookId}\n- \"Delete a webhook?\" -> DELETE /webhooks/{webhookId}\n- \"List all events?\" -> GET /webhooks/{webhookId}/events\n- \"List all workflows?\" -> GET /workflows\n- \"Create a workflow?\" -> POST /workflows\n- \"Get workflow details?\" -> GET /workflows/{workflowId}\n- \"Partially update a workflow?\" -> PATCH /workflows/{workflowId}\n- \"Delete a workflow?\" -> DELETE /workflows/{workflowId}\n- \"List all workflowversions?\" -> GET /workflowversions\n- \"Create a workflowversion?\" -> POST /workflowversions\n- \"Get workflowversion details?\" -> GET /workflowversions/{workflowVersionId}\n- \"List all tasks?\" -> GET /tasks\n- \"Get task details?\" -> GET /tasks/{taskId}\n- \"List all task-runs?\" -> GET /task-runs\n- \"Create a task-run?\" -> POST /task-runs\n- \"List all events?\" -> GET /task-runs/events\n- \"Get task-run details?\" -> GET /task-runs/{taskRunId}\n- \"Delete a task-run?\" -> DELETE /task-runs/{taskRunId}\n- \"List all flows?\" -> GET /flows\n- \"Get flow details?\" -> GET /flows/{flowId}\n- \"List all flow-runs?\" -> GET /flow-runs\n- \"Create a flow-run?\" -> POST /flow-runs\n- \"Get flow-run details?\" -> GET /flow-runs/{flowRunId}\n- \"Delete a flow-run?\" -> DELETE /flow-runs/{flowRunId}\n- \"List all steps?\" -> GET /flow-runs/{flowRunId}/steps\n- \"Get step details?\" -> GET /flow-runs/{flowRunId}/steps/{stepSeq}\n- \"Create a sandboxe?\" -> POST /sandboxes\n- \"List all sandboxes?\" -> GET /sandboxes\n- \"Create a sandbox-group?\" -> POST /sandbox-groups\n- \"List all sandbox-groups?\" -> GET /sandbox-groups\n- \"Get sandboxe details?\" -> GET /sandboxes/{sandboxId}\n- \"List all execs?\" -> GET /sandboxes/{sandboxId}/execs\n- \"Get exec details?\" -> GET /sandboxes/{sandboxId}/execs/{execId}\n- \"Create a terminate?\" -> POST /sandboxes/{sandboxId}/terminate\n- \"Create a snapshot?\" -> POST /sandboxes/{sandboxId}/snapshots\n- \"Get sandbox-group details?\" -> GET /sandbox-groups/{sandboxGroupId}\n- \"Partially update a sandbox-group?\" -> PATCH /sandbox-groups/{sandboxGroupId}\n- \"List all credentials?\" -> GET /sandbox-groups/{sandboxGroupId}/credentials\n- \"Create a credential?\" -> POST /sandbox-groups/{sandboxGroupId}/credentials\n- \"Get credential details?\" -> GET /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n- \"Partially update a credential?\" -> PATCH /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n- \"Delete a credential?\" -> DELETE /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n- \"List all versions?\" -> GET /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/versions\n- \"Create a restore?\" -> POST /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/restore\n- \"List all builds?\" -> GET /sandbox-groups/{sandboxGroupId}/builds\n- \"Create a build?\" -> POST /sandbox-groups/{sandboxGroupId}/builds\n- \"Get build details?\" -> GET /sandbox-groups/{sandboxGroupId}/builds/{buildId}\n- \"Delete a build?\" -> DELETE /sandbox-groups/{sandboxGroupId}/builds/{buildId}\n- \"List all snapshots?\" -> GET /sandbox-groups/{sandboxGroupId}/snapshots\n- \"Get snapshot details?\" -> GET /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId}\n- \"Delete a snapshot?\" -> DELETE /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId}\n- \"Create a token?\" -> POST /sandboxes/{sandboxId}/runs/{operation}/token\n- \"Create a token?\" -> POST /sandboxes/{sandboxId}/files/{operation}/token\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- List endpoints may support pagination; check for limit, offset, or cursor params\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get render-public-api -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search render-public-api\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@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 263\n@hint download_for_search\n@toc blueprints(6), owners(6), dedicated-ips(5), disks(7), users(1), organizations(1), notification-settings(5), registrycredentials(5), services(49), cron-jobs(2), events(1), logs(10), metrics-stream(3), metrics(20), key-value(8), redis(8), postgres(21), projects(5), environments(7), env-groups(13), maintenance(4), build-sources(20), webhooks(6), workflows(5), workflowversions(3), tasks(2), task-runs(5), flows(2), flow-runs(6), sandboxes(9), sandbox-groups(18)\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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], workflows: [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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 413: The request body exceeded the maximum allowed size., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, ownerId: str, name: str, status: str, autoSync: any, repo: str, branch: str, path: any, 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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 # Configuration value that controls whether or not this blueprint will be re-synced on each git push to the configured branch. Even when true, autoSync will not apply when the blueprint has the Created status, which indicates its first sync has not yet been approved. Other conditions, such as a locked workspace, can also prevent automatic syncing even when this is true., path: str # Path to the Blueprint file in the repository, branch: str # The Git branch to read the Blueprint file from. Requires Blueprint onboarding early access. The branch must contain a Blueprint file at the configured path. Updating this field does not plan a sync.}\n@returns(200) {id: any, ownerId: str, name: str, status: any, autoSync: any, repo: str, branch: str, path: any, lastSync: str(date-time)} # Updated\n@errors {400: The request contains invalid values (such as an empty branch or path), branch updates are not available for the workspace, or the Blueprint file could not be read and validated after changing the branch., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The Blueprint was not found, or the Blueprint file could not be found at the requested path when the branch is unchanged., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /blueprints/{blueprintId}/syncs\n@desc List Blueprint syncs\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group dedicated-ips\n@endpoint GET /dedicated-ips\n@desc List dedicated IPs\n@required {ownerId: str # The ID of the workspace to list dedicated IP sets for.}\n@optional {environmentId: str # Filter dedicated IP sets limited to this environment. Excludes workspace-scoped dedicated IP sets.  The environment must belong to the workspace named by `ownerId`.}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /dedicated-ips\n@desc Create dedicated IP set\n@required {name: str # Name for the dedicated IP set., ownerId: str # The ID of the workspace that will own this dedicated IP set., region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\"}\n@optional {description: str # Free-form description for the dedicated IP set., environmentIds: [str] # Environments to scope the dedicated IP set to. If omitted or empty, it applies to all services in the workspace within its region.}\n@returns(201) {id: str, name: str, description: str, ownerId: str, region: str, environmentIds: [str], ips: [str], status: 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., 402: You must enter payment information to perform this request., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /dedicated-ips/{dedicatedIpId}\n@desc Retrieve dedicated IP set\n@returns(200) {id: str, name: str, description: str, ownerId: str, region: str, environmentIds: [str], ips: [str], status: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /dedicated-ips/{dedicatedIpId}\n@desc Update dedicated IP set\n@optional {name: str, description: str, environmentIds: [str]}\n@returns(200) {id: str, name: str, description: str, ownerId: str, region: str, environmentIds: [str], ips: [str], status: str, 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /dedicated-ips/{dedicatedIpId}\n@desc Delete dedicated IP set\n@returns(204) Dedicated IP deleted\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /disks/{diskId}\n@desc Retrieve disk\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) {id: str, 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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: any, 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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 # Deprecated: use `autoDeployTrigger` instead. You can't set both `autoDeploy` and `autoDeployTrigger` in the same request.  - `yes` is equivalent to `autoDeployTrigger: commit`. - `no` is equivalent to `autoDeployTrigger: off`., autoDeployTrigger: str(commit/off/checksPass) # Controls autodeploy behavior.  - `commit`: Deploy each time a commit is pushed to the service's linked branch. - `checksPass`: Deploy each time a commit is pushed to the linked branch, but only after the commit's CI checks pass. - `off`: Disable autodeploys., 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: any, secretFiles: [any], 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, buildSourceId: any, autoDeploy: str, autoDeployTrigger: 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., 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., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, buildSourceId: any, autoDeploy: str, autoDeployTrigger: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /services/{serviceId}\n@desc Update service\n@optional {buildSourceId: any, autoDeploy: str(yes/no)=yes # Deprecated: use `autoDeployTrigger` instead. You can't set both `autoDeploy` and `autoDeployTrigger` in the same request.  - `yes` is equivalent to `autoDeployTrigger: commit`. - `no` is equivalent to `autoDeployTrigger: off`., autoDeployTrigger: str(commit/off/checksPass) # Controls autodeploy behavior.  - `commit`: Deploy each time a commit is pushed to the service's linked branch. - `checksPass`: Deploy each time a commit is pushed to the linked branch, but only after the commit's CI checks pass. - `off`: Disable autodeploys., 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, buildSourceId: any, autoDeploy: str, autoDeployTrigger: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/deploys\n@desc Trigger deploy\n@optional {buildId: str # The ID of the build to deploy. Cannot be combined with `commitId`, `imageUrl`, or `deployMode`., 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. Cannot be combined with `buildId`, `imageUrl`, or `deployMode: deploy_only`.  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. Cannot be combined with `buildId`, `commitId`, or `deployMode: deploy_only`.  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:** `deployMode` cannot be combined with `buildId`. `deploy_only` cannot be combined with `commitId`, `imageUrl`, or `clearCache`, as those are build related fields.}\n@returns(201) {id: str, buildId: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, buildId: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, buildId: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, buildId: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /services/{serviceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /services/{serviceId}/routes/{routeId}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/custom-domains/{customDomainNameOrID}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /services/{serviceId}/custom-domains/{customDomainNameOrID}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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!: any}}\n@returns(200) 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/starter_legacy/standard_legacy/standard_plus_legacy/pro_legacy/pro_plus_legacy/0.5c-512mb/1c-2g/2c-4g/2c-8g/2c-16g/4c-8g/4c-16g/4c-32g/8c-16g/8c-32g/8c-64g/12c-24g/12c-48g/12c-96g) # The compute plan to use. Legacy variants (`*_legacy`) identify grandfathered plans no longer offered for new services. Note that base services on any paid compute plan can't create preview instances with the `free` plan.}\n@returns(200) {service: map{id: str, buildSourceId: any, autoDeploy: str, autoDeployTrigger: 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /services/{serviceId}/outbound-ips\n@desc Retrieve service outbound IPs\n@returns(200) {type: str, dedicatedIpId: str, ips: [str]} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 406: Unable to generate preferred media types as specified by Accept request header., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) Canceled\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, workflow, or sandbox group.}\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), sandbox: [str] # Filter logs by sandbox ID., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/LOGFIRE/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, such as a time range that predates traffic source data availability. The error body's optional `code` field identifies specific failures that clients can handle machine-readably.  Error codes: - `too_many_resources`: the query requests more resources than   the breakdown supports (maximum 30), 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/256mb/1g/5g/10g/20g/40g)}\n@optional {region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\", 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, persistenceMode: str(journal_snapshot/snapshot/off) # The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence., 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /key-value/{redisId}\n@desc Retrieve Key Value 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /key-value/{redisId}\n@desc Update Key Value instance\n@required {redisId: str}\n@optional {name: str # The name of the Key Value instance, plan: str(free/starter/standard/pro/pro_plus/custom/256mb/1g/5g/10g/20g/40g), 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, persistenceMode: str(journal_snapshot/snapshot/off) # The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence., 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /key-value/{redisId}\n@desc Delete Key Value instance\n@required {redisId: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /key-value/{redisId}/connection-info\n@desc Retrieve Key Value connection info\n@required {redisId: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /key-value/{redisId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /key-value/{redisId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/256mb/1g/5g/10g/20g/40g)}\n@optional {region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\", 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, persistenceMode: str(journal_snapshot/snapshot/off) # The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence., 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/256mb/1g/5g/10g/20g/40g), 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, persistenceMode: str(journal_snapshot/snapshot/off) # The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence., 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, persistenceMode: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /redis/{redisId}/suspend\n@desc Suspend Redis 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /redis/{redisId}/resume\n@desc Resume Redis 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/0.1c-256mb/0.5c-1g/1c-2g/1c-4g/2c-4g/2c-8g/2c-16g/4c-16g/4c-32g/8c-32g/8c-64g/16c-64g/16c-128g/32c-128g/32c-256g/48c-192g/48c-384g/64c-256g/64c-512g/96c-384g/96c-768g/128c-512g/128c-1024g), 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, connectionPool: str=none # What connection pool to use (if any) out of 'pgbouncer' and 'none', region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\", ipAllowList: [map{cidrBlock!: str, description!: str}], readReplicas: [map{name!: str}]}\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, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool, connectionPool: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool, connectionPool: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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/0.1c-256mb/0.5c-1g/1c-2g/1c-4g/2c-4g/2c-8g/2c-16g/4c-16g/4c-32g/8c-32g/8c-64g/16c-64g/16c-128g/32c-128g/32c-256g/48c-192g/48c-384g/64c-256g/64c-512g/96c-384g/96c-768g/128c-512g/128c-1024g), diskSizeGB: int # The number of gigabytes of disk space to allocate for the database, enableDiskAutoscaling: bool, connectionPool: str=none # What connection pool to use (if any) out of 'pgbouncer' and 'none', 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}], readReplicas: [map{name!: 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, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool, connectionPool: 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., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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), internalConnectionPoolString: str(password), externalConnectionPoolString: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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}\n@optional {restoreName: str # Name of the new database., restoreTime: str(date-time) # The point in time to restore the database to. See `/recovery-info` for restore availability, 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, primaryPostgresID: str, region: str, readReplicas: [map], role: str, status: str, version: str, suspended: str, suspenders: [str], diskAutoscalingEnabled: bool, connectionPool: str} # 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/query/processes\n@desc List live queries\n@returns(200) {processes: [map]} # 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/query/top-queries\n@desc List top queries\n@returns(200) {topQueries: [map]} # 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/query/sizes\n@desc List database, table, and index sizes\n@returns(200) {sizes: [map]} # 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /postgres/{postgresId}/query/table-scans\n@desc List table scans\n@returns(200) {tableScans: [map]} # 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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: any}\n@optional {secretFiles: [any], 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /env-groups/{envGroupId}/secret-files/{envVarKey}\n@desc Retrieve secret file\n@required {envGroupId: str # Filter for resources that belong to an environment group, envVarKey: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /env-groups/{envGroupId}/secret-files/{envVarKey}\n@desc Add or update secret file\n@required {envGroupId: str, envVarKey: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /env-groups/{envGroupId}/secret-files/{envVarKey}\n@desc Remove secret file\n@required {envGroupId: str # Filter for resources that belong to an environment group, envVarKey: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /maintenance/{maintenanceRunID}\n@desc Retrieve maintenance run\n@required {maintenanceRunID: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /maintenance/{maintenanceRunID}\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /maintenance/{maintenanceRunID}/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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group build-sources\n@endpoint POST /build-sources\n@desc Create a build source\n@required {ownerId: str, name: str}\n@optional {projectId: str, git: map{branch: str, buildCommand: str, buildFilter: any, dockerContext: str, dockerfilePath: str, runtime!: str, registryCredentialId: str, region: str, repoUrl: str, rootDir: str}, image: map{ownerId!: str, registryCredentialId: str, imageUrl!: str}, serviceIds: [str], envVars: any, secretFiles: [any] # Secret files for the build source's build. Only valid for `git` sources., envGroupIds: [str] # IDs of env groups to link to the build source. Only valid for `git` sources; env groups must belong to the same workspace and must not be scoped to an environment.}\n@returns(201) {id: any, name: str, ownerId: str, projectId: str, git: any, image: any, createdAt: str(date-time), updatedAt: str(date-time), serviceLinks: [map]} # 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred.}\n\n@endpoint GET /build-sources\n@desc List build sources\n@optional {name: [str] # Filter by name, ownerId: [str] # The ID of the workspaces to return resources for, projectId: str, includePreviews: bool=true # Include previews in the response, 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), 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) Success\n@errors {400: The request could not be understood by the server., 401: Authorization information is missing or invalid., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred.}\n\n@endpoint GET /build-sources/{buildSourceId}\n@desc Retrieve a build source\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred.}\n\n@endpoint PATCH /build-sources/{buildSourceId}\n@desc Update a build source\n@optional {name: str, git: map{branch: str, buildCommand: str, buildFilter: map, dockerContext: str, dockerfilePath: str, runtime: str, registryCredentialId: str, region: str, repoUrl: str, rootDir: str}, image: map{imageUrl: str, registryCredentialId: str} # Patch shape for a build source's image identity. Unset fields are left unchanged on the underlying image reference. ownerId is intentionally omitted — a build source's owner is fixed at creation, and changing the image's owner would amount to a different identity.}\n@returns(200) Success\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred.}\n\n@endpoint DELETE /build-sources/{buildSourceId}\n@desc Delete a build source\n@returns(204) Build source 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred.}\n\n@endpoint GET /build-sources/{buildSourceId}/builds\n@desc List builds in a build source\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /build-sources/{buildSourceId}/builds\n@desc Trigger a build\n@optional {clearCache: str(clear/do_not_clear)=do_not_clear # If `clear`, Render clears the build source's build cache before building. This can be useful if you're experiencing issues with your build.}\n@returns(201) {id: any, buildSourceId: any, buildRun: map{id: str, status: str, buildStartedAt: str(date-time), buildFinishedAt: str(date-time), runtime: str, commitId: str, commitUrl: str}, image: map{imageVersionId: str, SHA: str, ref: str, imageUrl: str, registryCredentialId: str}, createdAt: str(date-time), updatedAt: str(date-time), assetsDeletedAt: str(date-time)} # Build started\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /build-sources/{buildSourceId}/builds/{buildId}\n@desc Retrieve a build\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /build-sources/{buildSourceId}/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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /build-sources/{buildSourceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PUT /build-sources/{buildSourceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /build-sources/{buildSourceId}/secret-files/{envVarKey}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /build-sources/{buildSourceId}/env-groups/{envGroupId}\n@desc Link environment group\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /build-sources/{buildSourceId}/env-groups/{envGroupId}\n@desc Unlink environment group\n@returns(204) environment group unlinked from build source\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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: [any] # 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: 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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) Success\n@errors {401: Authorization information is missing or invalid., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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: any}\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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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!: any}, runCommand: str # The command to run the workflow. Cannot be blank., region: str(frankfurt/oregon/ohio/singapore/virginia)=oregon # Defaults to \"oregon\"}\n@optional {autoDeployTrigger: str(commit/off/checksPass)=commit # Controls autodeploy behavior. \"commit\" deploys when a commit is pushed to the branch. \"checksPass\" waits for CI checks to pass before deploying. \"off\" disables autodeploy., envVars: any}\n@returns(201) {id: str, name: str, ownerId: str, createdAt: str(date-time), updatedAt: str(date-time), buildConfig: any, runCommand: str, region: any, environmentId: str, slug: str, autoDeployTrigger: any, defaultVersionId: str} # Workflow created\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /workflows/{workflowId}\n@desc Retrieve workflow\n@returns(200) Workflow details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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} # A partial update to a workflow's build config. Every field is optional; omitted fields are left unchanged., runCommand: str # The command to run the workflow. Cannot be blank., autoDeployTrigger: any}\n@returns(200) Workflow updated\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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 {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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. Cannot be blank., input: any # Input data for a task. Can be either an array (for positional arguments) or an object (for named parameters).}\n@optional {idempotencyKey: str # A client-generated key that makes starting a task run safe to retry. Repeating a request with the same key within 24 hours returns the task run that the first request started instead of starting another one; the repeated request's input is ignored. Keys are scoped to a workflow. Omit the key to always start a new run.}\n@returns(202) {id: str, taskId: str, status: any, startedAt: str(date-time), completedAt: str(date-time), parentTaskRunId: str, parentTaskAttempt: int, 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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, parentTaskAttempt: int, rootTaskRunId: str, retries: int, attempts: [map]} # Task run details\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 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 {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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group flows\n@endpoint GET /flows\n@desc List flows\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 flows\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /flows/{flowId}\n@desc Retrieve flow\n@returns(200) {id: str, name: str, createdAt: str(date-time), workflowId: str, workflowVersionId: str} # Flow details\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group flow-runs\n@endpoint GET /flow-runs\n@desc List flow 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)., flowId: [str] # An array of flow IDs, status: [str] # An array of flow run statuses to filter on, ownerId: [str] # The ID of the workspaces to return resources for}\n@returns(200) List of flow runs\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /flow-runs\n@desc Start flow run\n@required {flow: str # A flow slug in the format workflow-slug/flow-name. An optional version can be appended (workflow-slug/flow-name:version). If no version is provided, the latest version is used. Cannot be blank., input: any # Input data for a flow. Can be either an array (for positional arguments) or an object (for named parameters).}\n@optional {idempotencyKey: any}\n@returns(202) {id: str, flowId: str, status: any, startedAt: str(date-time), completedAt: str(date-time)} # Flow run started\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /flow-runs/{flowRunId}\n@desc Retrieve flow run\n@returns(200) {id: str, flowId: str, status: any, startedAt: str(date-time), completedAt: str(date-time), input: any, results: [any], error: str, errorDetails: map{code: str, message: str, seq: int, subKey: str, flowAttempt: int, kind: str, expected: str, actual: str, limit: int(int64), value: int(int64)}, attempts: [map]} # Flow run details\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /flow-runs/{flowRunId}\n@desc Cancel flow run\n@returns(204) Flow run canceled\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /flow-runs/{flowRunId}/steps\n@desc List flow run steps\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) {steps: [map], cursor: str, hasMore: bool} # Page of flow run steps\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /flow-runs/{flowRunId}/steps/{stepSeq}\n@desc Retrieve flow run step\n@optional {stepKey: str # The SDK's key for the step, as `stepKey` reports it in the step listing. Steps that share a sequence number are told apart by it. Omit it for a step the SDK recorded without one.}\n@returns(200) {seq: int, stepKey: str, name: str, type: str, status: str, startedAt: str(date-time), completedAt: str(date-time), wakeAt: str(date-time), childTaskRunId: str, input: any, result: any?, error: str} # Flow run step details\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group sandboxes\n@endpoint POST /sandboxes\n@desc Create sandbox\n@required {ownerId: str # The ID of the workspace the sandbox belongs to.}\n@optional {sandboxGroupId: any # The ID of the sandbox group to create the sandbox in. Defaults to the workspace's default group., name: str # A label for the sandbox, such as `my-agent`, up to 64 characters. Names do not have to be unique; use the sandbox ID to identify a specific sandbox. Must not start with `sbx-`., networkPolicy: map{type: any, default: any, rules: [map]} # The outbound traffic policy to apply to the sandbox. Provide `type` or its deprecated alias `default`. If both are provided, they must match., plan: any # The compute plan for the sandbox. See `sandboxPlan` for known values., timeoutSeconds: int # The maximum time the sandbox can run continuously, in seconds. The sandbox terminates when this time elapses. If the sandbox is suspended and later resumed, this timeout restarts.  Use 0 to disable the runtime timeout. Positive values must be between 60 and 2592000 (30 days). Defaults to 86400, or to the source sandbox's runtime timeout when creating a sandbox from a snapshot., idleTimeoutSeconds: int # The number of seconds of inactivity before Render suspends the sandbox. Use 0 to disable automatic idle suspension. Positive values must be between 300 and 86400. Defaults to 900, or to the source sandbox's idle timeout when creating a sandbox from a snapshot., env: map # The environment variables to set when creating the sandbox., snapshotId: any # The ID of the snapshot to create the sandbox from instead of the base image. The snapshot must be `available` and belong to the same sandbox group. For a `runtime` snapshot, `plan` must match the snapshot's plan. The new sandbox inherits the source sandbox's network policy, timeout, and idle timeout. Provide `networkPolicy`, `timeoutSeconds`, or `idleTimeoutSeconds` to override these settings., snapshotName: any # The name of the snapshot to create the sandbox from. Uses the most recently created snapshot with this name in the sandbox group that is `available` and unexpired. Cannot be combined with `snapshotId`. The same restore requirements as `snapshotId` apply., buildId: any # The ID of the build to create the sandbox from instead of the base image. The build must have succeeded and belong to the same sandbox group. Cannot be combined with `buildName`, `snapshotId`, or `snapshotName`., buildName: str # The name of the build to create the sandbox from instead of the base image. Uses the newest successful build with this name in the sandbox group. Cannot be combined with `buildId`, `snapshotId`, or `snapshotName`.}\n@returns(201) {id: any, name: str?, sandboxGroupId: any, status: any, plan: any, networkPolicy: map{type: any, default: any, rules: [any]}, region: str, timeoutSeconds: int, idleTimeoutSeconds: int, createdAt: str(date-time), terminatedAt: str(date-time)?} # The sandbox was created. Returns its initial state.\n@errors {400: The request is invalid.  - `invalid_snapshot_name`: `snapshotName` is malformed. - Both `snapshotId` and `snapshotName` are provided. No error code is   returned. - `invalid_sandbox_name`: `name` exceeds 64 characters or starts with   `sbx-`. - `sandbox_group_limit_reached`: The workspace has no default sandbox group   and has reached its sandbox group limit. - `invalid_sandbox_plan`: The plan is not supported. The error message lists   accepted plans. - `invalid_timeout_seconds`: A nonzero `timeoutSeconds` is outside the   range of 60 to the workspace's maximum, which defaults to 2592000   (30 days)., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The requested resource was not found.  - `snapshot_not_found`: The snapshot ID does not exist or no available   snapshot in the group has the specified name. - `build_not_found`: The specified build does not belong to the sandbox   group, or no build in the group has the specified name., 409: The current state of the resource conflicts with this request.  - `snapshot_not_available`: The snapshot is not `available`. This also   applies to snapshots selected by name. - `snapshot_plan_mismatch`: A runtime snapshot requires a different compute   plan. This also applies to snapshots selected by name. - `sandbox_group_suspended`: The sandbox group is suspended. - `build_not_succeeded`: The specified build has not succeeded, or no build   with the specified name has succeeded., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n@example_request {\"ownerId\":\"tea-cph1rs3idesc73a2b2mg\",\"networkPolicy\":{\"type\":\"deny-all\"},\"plan\":\"standard\",\"timeoutSeconds\":7200,\"idleTimeoutSeconds\":900}\n\n@endpoint GET /sandboxes\n@desc List sandboxes\n@required {ownerId: str # The ID of the workspace whose sandboxes to return.}\n@optional {sandboxGroupId: str # Filter for sandboxes in this group. The group must belong to the workspace specified by `ownerId`., name: str # Filter for sandboxes with exactly this name. Names are not unique, so multiple sandboxes can match., 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 sandboxes with the specified statuses. By default, returns all statuses except `terminated`. Include `terminated` explicitly to return terminated sandboxes.}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group sandbox-groups\n@endpoint POST /sandbox-groups\n@desc Create sandbox group\n@required {ownerId: str # The ID of the workspace to create the sandbox group in., name: str # The sandbox group's name. Must be unique within the workspace.}\n@optional {region: str=oregon # The Render region where the group's sandboxes run. Defaults to `oregon`.}\n@returns(201) {id: any, ownerId: str, name: str, region: str, isDefault: bool, environmentId: str?, concurrencyLimit: int, createdAt: str(date-time), updatedAt: str(date-time)} # Sandbox group 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request.  - Another group in the workspace has the specified name., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n@example_request {\"ownerId\":\"tea-cph1rs3idesc73a2b2mg\",\"name\":\"CI agents\"}\n\n@endpoint GET /sandbox-groups\n@desc List sandbox groups\n@required {ownerId: str # The ID of the workspace whose sandbox groups to return.}\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 # The maximum number of sandbox groups to return, between 1 and 100. Defaults to 20.}\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group sandboxes\n@endpoint GET /sandboxes/{sandboxId}\n@desc Retrieve sandbox\n@optional {ownerId: str # The ID of the workspace the sandbox belongs to. If provided, it must match the sandbox's workspace. If omitted, Render determines the workspace from the sandbox ID.}\n@returns(200) OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandboxes/{sandboxId}/execs\n@desc List executions\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 {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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandboxes/{sandboxId}/execs/{execId}\n@desc Retrieve execution\n@returns(200) {id: any, sandboxId: any, type: str, operation: str, command: str, userId: str, startedAt: str(date-time), stoppedAt: str(date-time), exitCode: int} # OK\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandboxes/{sandboxId}/terminate\n@desc Terminate sandbox\n@returns(204) The sandbox was terminated or was already terminated.\n@errors {401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandboxes/{sandboxId}/snapshots\n@desc Create sandbox snapshot\n@optional {kind: any=runtime # The state to capture in the snapshot. Defaults to `runtime`., name: str # A case-sensitive name for snapshots in a sandbox group, up to 64 characters. Must not start with `snp-`. Multiple snapshots can share a name. When creating a sandbox by snapshot name, Render uses the most recently created snapshot with that name that is `available` and unexpired., ttlSeconds: int # The snapshot's lifetime after its last use, in seconds. Creating a sandbox from this snapshot resets its remaining lifetime to this duration. Use 0 to keep the snapshot until you delete it. Defaults to Render's snapshot lifetime. Cannot be combined with `expiresAt`., expiresAt: str(date-time) # The expiration timestamp, in ISO 8601 format. Deprecated; use `ttlSeconds` instead. Must be in the future. Render sets the snapshot lifetime to the duration between the request and this timestamp.}\n@returns(202) {id: any, sandboxGroupId: any, sourceSandboxId: any, name: any?, kind: str, status: any, plan: any, requestedAt: str(date-time), capturedAt: str(date-time)?, expiresAt: str(date-time), ttlSeconds: int, sizeBytes: int(int64)?, error: str?} # The snapshot capture was accepted. Returns the snapshot in `creating` status.\n@errors {400: The request is invalid.  - `invalid_snapshot_name`: `name` is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request.  - `sandbox_not_running`: The sandbox is not `running`. - `sandbox_group_suspended`: The sandbox group is suspended., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group sandbox-groups\n@endpoint GET /sandbox-groups/{sandboxGroupId}\n@desc Retrieve sandbox group\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /sandbox-groups/{sandboxGroupId}\n@desc Update sandbox group\n@required {concurrencyLimit: int # The maximum number of active sandboxes allowed in this group. Must be at least 1. Render caps this value at the workspace's limit and returns the effective limit. Lowering the limit does not stop existing sandboxes.}\n@returns(200) Sandbox group updated.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - `concurrencyLimit` is omitted or below 1., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n@example_request {\"concurrencyLimit\":10}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/credentials\n@desc List sandbox group credentials\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandbox-groups/{sandboxGroupId}/credentials\n@desc Create sandbox group credential\n@required {id: any, domain: str # The destination hostname to match for credential injection. Must be a public DNS hostname. Render normalizes it to lowercase and matches it exactly. IP addresses, ports, wildcards, and local or internal hostnames are not supported., value: str # The secret value to store, up to 5 KiB (5120 UTF-8 bytes)., injection: map{type!: str, name: str, template: str} # Settings for injecting the secret value into matching outbound HTTPS requests.}\n@optional {enabled: bool=true # Whether this credential is enabled for injection. Defaults to `true`., methods: [str] # The HTTP methods to match for credential injection. Supported methods are GET, HEAD, POST, PUT, PATCH, DELETE, and OPTIONS, normalized to uppercase. Omit or provide an empty list to match any method., paths: [str] # The request path patterns to match for credential injection. Each pattern must match the entire absolute path. Use `*` for one nonempty path segment or `**` for one or more segments. Wildcards must occupy whole segments. For example, `/a/*` matches `/a/b`, and `/a/**` also matches `/a/b/c`. Neither matches `/a`. Patterns do not support query strings, fragments, or escaping. Request query strings do not affect matching. Omit or provide an empty list to match any path.}\n@returns(201) {id: any, domain: str, version: any, enabled: bool, methods: [str], paths: [str], injection: any} # The credential configuration was saved.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota.  Temporary conflicts while applying credential changes can also cause this response., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n@desc Retrieve sandbox group credential\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint PATCH /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n@desc Update sandbox group credential\n@optional {value: str # The replacement secret value, up to 5 KiB (5120 UTF-8 bytes). Requires an admin. Omit to preserve the current value., domain: str # The destination hostname to match for credential injection. Must be a public DNS hostname. Render normalizes it to lowercase and matches it exactly. IP addresses, ports, wildcards, and local or internal hostnames are not supported. Omit to preserve the current hostname., enabled: bool # Whether this credential is enabled for injection. Omit to preserve the current setting., methods: [str] # The HTTP methods to match for credential injection. Supported methods are GET, HEAD, POST, PUT, PATCH, DELETE, and OPTIONS, normalized to uppercase. An empty list matches any method. Omit to preserve the current filter., paths: [str] # The request path patterns to match for credential injection. Each pattern must match the entire absolute path. Use `*` for one nonempty path segment or `**` for one or more segments. Wildcards must occupy whole segments. For example, `/a/*` matches `/a/b`, and `/a/**` also matches `/a/b/c`. Neither matches `/a`. Patterns do not support query strings, fragments, or escaping. Request query strings do not affect matching. An empty list matches any path. Omit to preserve the current filter., injection: any}\n@returns(200) The credential configuration was saved.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations.  Changing `domain` or `value` requires an admin., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota.  Temporary conflicts while applying credential changes can also cause this response., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}\n@desc Delete sandbox group credential\n@returns(202) The credential deletion was accepted.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota.  Temporary conflicts while applying credential changes can also cause this response., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/versions\n@desc List sandbox credential versions\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandbox-groups/{sandboxGroupId}/credentials/{credentialId}/restore\n@desc Restore sandbox credential configuration\n@required {versionId: int(int64) # The ID of a retained credential version to restore as a new current version.}\n@returns(200) The credential configuration was saved.\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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota.  Temporary conflicts while applying credential changes can also cause this response., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/builds\n@desc List sandbox builds\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 builds with exactly this image name., status: [str] # Filter for builds with the specified statuses.}\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - `invalid_status`: A requested build status is not supported. - `invalid_cursor`: The cursor is malformed. - `invalid_limit`: The limit is outside the range 1–100., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandbox-groups/{sandboxGroupId}/builds\n@desc Create sandbox build\n@required {name: str # The name used to select this image when creating a sandbox, between 1 and 255 characters. Multiple builds can share a name., sourceImage: str # The container image to convert, specified by tag or digest.}\n@optional {registryCredential: map{username!: str, password!: str(password)} # Credentials used to pull `sourceImage` from a private registry for this build.}\n@returns(201) {id: any, sandboxGroupId: any, name: str, source: map{repository: str, image: str, reference: str}, sourceDigest: str, status: any, failureReason: str?, failureCode: str?, createdAt: str(date-time), finishedAt: str(date-time)?} # The build was created, or a matching build was returned. Conversion may still be in progress.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - The image is invalid or the image registry cannot serve it. The error   message explains the problem., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request.  - `sandbox_group_suspended`: The group is suspended., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota.  The group has reached its limit for pending and running builds. The error message includes the limit., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/builds/{buildId}\n@desc Retrieve sandbox build\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - The build ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The requested resource was not found.  - `build_not_found`: The build does not exist or belongs to another sandbox   group., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /sandbox-groups/{sandboxGroupId}/builds/{buildId}\n@desc Delete sandbox build\n@returns(204) The build was deleted or was already deleted.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - The build ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The requested resource was not found.  - `build_not_found`: The build does not exist or belongs to another sandbox   group., 409: The current state of the resource conflicts with this request.  - `image_in_use`: Sandboxes that have not terminated or errored, or unexpired   snapshots that have not failed, still depend on this build. This includes   suspended sandboxes and snapshots of sandboxes restored from earlier   snapshots of the build. The error message lists up to 10 dependencies.   Terminate the sandboxes and delete the snapshots, or wait for them to   expire, before retrying., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/snapshots\n@desc List sandbox snapshots\n@required {ownerId: str # The ID of the workspace whose snapshots to return.}\n@optional {name: str # Filter for snapshots with exactly this name. Multiple snapshots can share a name; results include each version, newest first. When creating a sandbox with `snapshotName`, Render uses the most recently created snapshot with that name that is `available` and unexpired., 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 snapshots with the specified statuses.}\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - `invalid_owner_id`: The workspace ID is missing or repeated. - `invalid_status`: A requested snapshot status is not supported. - `invalid_cursor`: The cursor is malformed or unknown. - `invalid_limit`: The limit is outside the range 1–100., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint GET /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId}\n@desc Retrieve sandbox snapshot\n@optional {ownerId: str # The ID of the workspace the sandbox group belongs to.}\n@returns(200) OK\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - `invalid_snapshot_id`: The snapshot ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The requested resource was not found.  - The snapshot is deleted, expired, or belongs to another sandbox group., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint DELETE /sandbox-groups/{sandboxGroupId}/snapshots/{snapshotId}\n@desc Delete sandbox snapshot\n@returns(204) The snapshot was deleted, was already deleted, or has expired.\n@errors {400: The request is invalid.  - `invalid_sandbox_group_id`: The group ID is malformed. - `invalid_snapshot_id`: The snapshot ID is malformed., 401: Authorization information is missing or invalid., 403: You do not have permissions for the requested resource. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: The requested resource was not found.  - The snapshot belongs to another sandbox group., 409: The current state of the resource conflicts with this request.  - `snapshot_creating`: Capture is still in progress., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@group sandboxes\n@endpoint POST /sandboxes/{sandboxId}/runs/{operation}/token\n@desc Create a connect token for a sandbox run\n@returns(201) {executionId: str, token: str, uri: str(uri), method: str, expiresAt: str(date-time)} # The connect token was 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request.  - `sandbox_not_running`: The sandbox is terminated or errored. - `sandbox_group_suspended`: The sandbox group is suspended., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endpoint POST /sandboxes/{sandboxId}/files/{operation}/token\n@desc Mint a connect token for a sandbox file transfer\n@required {path: str # The file or directory path the token authorizes. For archive uploads, this is the directory to extract into. For downloads, it is the file or directory to retrieve.  Relative paths are resolved from the image's `WORKDIR`, or the home directory if no `WORKDIR` is set. Use `.` for that working directory. Absolute paths are resolved from the sandbox filesystem root.}\n@returns(201) The connect token was 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. If a scoped API token does not satisfy the endpoint's minimum scope requirements, the response has code insufficient_token_scope and its message lists all minimum required scopes. Broader scopes that include their permissions also satisfy the requirements. Passing this check does not guarantee access to the requested resource or to conditional operations., 404: Unable to find the requested resource., 409: The current state of the resource conflicts with this request.  - `sandbox_not_running`: The sandbox is terminated or errored. - `sandbox_group_suspended`: The sandbox group is suspended., 429: Rate limit has been surpassed.  Rate-limited endpoints also return `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` on successful responses so clients can track their remaining quota., 500: An unexpected server error has occurred., 503: Server currently unavailable.}\n\n@endgroup\n\n@end\n"}}