You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| signature | string | v | signed message (or use an `Authorization` auth-token header) |
2038
+
| status | number || filter to ONE specific `ServiceStatusNumber` (any status, incl. `75` Expired); takes precedence over `includeAllStatuses`|
2039
+
| includeAllStatuses | boolean ||`true` returns services in every status instead of only the resource-holding set |
2040
+
| fromTimestamp | string || only services created at/after this moment — ISO date (`2026-01-15T00:00:00Z`) or Unix timestamp (seconds or milliseconds) |
2041
+
2042
+
#### Response (200)
2043
+
2044
+
Array of `ServiceJob`, **listing-sanitized**: `userData`, `dockerCmd`, `dockerEntrypoint`,
2045
+
`dockerfile` and `additionalDockerFiles` are stripped (identity, status, resources,
2046
+
endpoints and payment metadata are kept). Use the owner-scoped `serviceStatus` to see a
Copy file name to clipboardExpand all lines: docs/services.md
+52-8Lines changed: 52 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,10 @@ and `signature` as query parameters (or an auth-token `Authorization` header).
28
28
| --- | --- | --- | --- |
29
29
|`SERVICE_START`|`/api/services/serviceStart`| POST | Validate, persist a `Starting` record, and return the `serviceId` immediately (escrow + image + container happen in the background) |
30
30
|`SERVICE_GET_STATUS`|`/api/services/serviceStatus`| GET | Read job status / endpoints — authenticated, owner-scoped (see notice below); poll this to follow a starting service |
31
+
|`SERVICE_LIST`|`/api/services/serviceList`| GET | Node-wide service listing — authenticated, **not** owner-scoped. Default: only services currently holding a resource reservation; `status=<n>` filters to one specific status, `includeAllStatuses=true` returns everything, `fromTimestamp` keeps services created at/after that moment. Output is listing-sanitized (no `userData`, no `dockerCmd`/`dockerEntrypoint`, no Dockerfile) |
31
32
|`SERVICE_EXTEND`|`/api/services/serviceExtend`| POST | Pay to push the expiry further out |
32
-
|`SERVICE_RESTART`|`/api/services/serviceRestart`| POST | Recreate the container (no extra charge) |
33
-
|`SERVICE_STOP`|`/api/services/serviceStop`| POST | Tear down the container and release resources|
33
+
|`SERVICE_RESTART`|`/api/services/serviceRestart`| POST | Recreate the container (no extra charge); asynchronous like start — returns once the job is `Restarting`, poll `serviceStatus`|
34
+
|`SERVICE_STOP`|`/api/services/serviceStop`| POST | Tear down the container; the paid resource reservation (cpu/ram/gpu + host ports) is kept until `expiresAt`, so the service can be restarted anytime on the same endpoints|
34
35
|`SERVICE_GET_TEMPLATES`|`/api/services/serviceTemplates`| GET | List operator-published service templates |
35
36
|`SERVICE_GET_STREAMABLE_LOGS`|`/api/services/serviceStreamableLogs`| GET | Stream the container's live stdout/stderr logs — authenticated, owner-scoped; available while `Running` or `Error`; optional `since` to skip history |
0 commit comments