GET /api/v1/projects/{name}
Path parameters
The unique name of the project.
Response
Returns aProject object with the full spec and status.
Always
"caravanserai/v1".Always
"Project".Show properties
Show properties
Desired state declared by the user.
Show properties
Show properties
Ordered list of container definitions. Each service maps to one Docker container.
Show services[]
Show services[]
Service name. Used as the DNS hostname inside the shared bridge network.
Docker image reference, e.g.
"nginx:alpine" or "postgres:15".HTTP ingress routing rules.
Show ingress[]
Show ingress[]
Unique name for this ingress rule.
Hostname for the ingress rule. If the value contains a dot it is used verbatim; otherwise the final hostname is assembled as
{host}.{environment}.{baseDomain}.RFC 3339 timestamp. When set, the GC controller deletes the project after this time. Useful for ephemeral preview environments.
Runtime state written by the controller manager and the agent.
Show properties
Show properties
Current lifecycle phase:
Pending, Scheduled, Running, Failed, Terminating, or Terminated.Name of the node assigned by the scheduler. Empty while
Pending.Granular observable states.
Show conditions[]
Show conditions[]
Machine-readable identifier. Common values:
Phase, TerminatingAt, NotReadyAt.One of
True, False, or Unknown.CamelCase word summarising why the condition has this status (e.g.
"AgentReady", "NodeNotReady").Human-readable explanation.
RFC 3339 timestamp of when this condition was last sampled.
RFC 3339 timestamp of when the status last changed.
Examples
curl http://localhost:8080/api/v1/projects/wordpress