Skip to main content
Returns all projects, with optional filtering by phase and node. 
GET /api/v1/projects

​
Query parameters

​
phase
string
Filter by lifecycle phase. Accepted values: Pending, Scheduled, Running, Failed, Terminating, Terminated.You can repeat this parameter to match multiple phases (OR logic):?phase=Scheduled&phase=RunningWhen combined with nodeRef, both filters are applied (AND logic).
​
nodeRef
string
Filter by the name of the node the scheduler assigned to the project. Projects in Pending phase have no nodeRef and are excluded when this filter is set.

​
Response

Returns a ProjectList object.
​
apiVersion
string
required
Always "caravanserai/v1".
​
kind
string
required
Always "ProjectList".
​
items
object[]
required
Array of Project objects. Empty when no projects match.

​
Examples

curl http://localhost:8080/api/v1/projects