timeout_sec, Wrenn automatically pauses it after that many seconds with no exec calls. Calling ping updates the last_active_at timestamp, restarting the countdown. Use it as a keepalive when your application is holding a capsule open but not actively executing commands.
If
timeout_sec is 0 (auto-pause disabled), this endpoint still accepts the request and returns 204 — it simply has no effect on the TTL.Endpoint
Authentication
Pass your API key in theX-API-Key header.
Path parameters
The ID of the capsule to ping (e.g.,
cl-abc123). The capsule must be in running status.Response
Returns204 No Content on success. The response body is empty. The capsule’s last_active_at timestamp is updated server-side.
curl
Python SDK
Error responses
| Status | Description |
|---|---|
401 Unauthorized | Missing or invalid X-API-Key. |
404 Not Found | No capsule with the given ID exists in your team. |
409 Conflict | The capsule is not in running status. You can only ping a running capsule. |