# List project instances ## `GET /v1/projects/{projectId}/instances` Lists the runtime instances of a deployed project, newest first. A managed or BYOC project lists its Spicepod instances. A standalone project lists its Cloud Connect runtime. Read the logs of an instance with `GET /v1/projects/{projectId}/instances/{instanceName}/logs`. ### Path parameters - `projectId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but `GET /v1/orgs` (400 `org_assertion_required` otherwise). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/projects//instances" \ -H "Authorization: Bearer " ``` ```http GET /v1/projects//instances HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** The project's instances Content type: `application/json` - `instances` (array of object, required) - `name` (string, required): The instance name: a Spicepod instance (pod) name, or a Cloud Connect runtime id. Pass it as `instanceName` to read its logs. - `status` (string, required): A Spicepod instance is `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, or `failed_to_start`. A Cloud Connect runtime is `online` or `offline`. Allowed values: `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, `failed_to_start`, `online`, `offline`. - `started_at` (string (date-time) | null, required): When the Spicepod instance started, or when the Cloud Connect runtime enrolled. **400 Bad Request** Invalid project ID **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope **404 Not Found** Project not found **409 Conflict** The project has no running instances. `code` is `project_not_deployed` when a managed or BYOC project was never deployed, or `project_paused` when the project is paused. Content type: `application/json` - `error` (string, required) - `code` (string, required): Allowed values: `project_not_deployed`, `project_paused`. **422 Unprocessable Content** The project is not fully configured **500 Internal Server Error** Internal server error **503 Service Unavailable** The project runtime did not answer ## `GET /v1/orgs/{orgId}/projects/{projectId}/instances` The org is `orgId` in the path. Lists the runtime instances of a deployed project, newest first. A managed or BYOC project lists its Spicepod instances. A standalone project lists its Cloud Connect runtime. Read the logs of an instance with `GET /v1/projects/{projectId}/instances/{instanceName}/logs`. ### Path parameters - `orgId` (integer, required): The org id from GET /v1/orgs. Minimum: `1`. - `projectId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org\_path\_mismatch (400). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/orgs//projects//instances" \ -H "Authorization: Bearer " ``` ```http GET /v1/orgs//projects//instances HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** The project's instances Content type: `application/json` - `instances` (array of object, required) - `name` (string, required): The instance name: a Spicepod instance (pod) name, or a Cloud Connect runtime id. Pass it as `instanceName` to read its logs. - `status` (string, required): A Spicepod instance is `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, or `failed_to_start`. A Cloud Connect runtime is `online` or `offline`. Allowed values: `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, `failed_to_start`, `online`, `offline`. - `started_at` (string (date-time) | null, required): When the Spicepod instance started, or when the Cloud Connect runtime enrolled. **400 Bad Request** Invalid project ID. orgId is not a valid org id (`invalid_org_id`), or X-Org-Name does not name that org (`org_path_mismatch`). **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope. The caller is not a member of the org (`org_forbidden`). A machine credential named a different org (`org_assertion_mismatch`). The org is deleted (`org_deleted`). **404 Not Found** Project not found **409 Conflict** The project has no running instances. `code` is `project_not_deployed` when a managed or BYOC project was never deployed, or `project_paused` when the project is paused. Content type: `application/json` - `error` (string, required) - `code` (string, required): Allowed values: `project_not_deployed`, `project_paused`. **422 Unprocessable Content** The project is not fully configured **500 Internal Server Error** Internal server error **503 Service Unavailable** The project runtime did not answer ## `GET /v1/apps/{appId}/instances` (deprecated) Legacy alias of `/v1/projects/{projectId}/instances` — projects were previously called apps. Lists the runtime instances of a deployed project, newest first. A managed or BYOC project lists its Spicepod instances. A standalone project lists its Cloud Connect runtime. Read the logs of an instance with `GET /v1/projects/{projectId}/instances/{instanceName}/logs`. ### Path parameters - `appId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but `GET /v1/orgs` (400 `org_assertion_required` otherwise). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/apps//instances" \ -H "Authorization: Bearer " ``` ```http GET /v1/apps//instances HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** The project's instances Content type: `application/json` - `instances` (array of object, required) - `name` (string, required): The instance name: a Spicepod instance (pod) name, or a Cloud Connect runtime id. Pass it as `instanceName` to read its logs. - `status` (string, required): A Spicepod instance is `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, or `failed_to_start`. A Cloud Connect runtime is `online` or `offline`. Allowed values: `deploying`, `loading`, `ready`, `unhealthy`, `terminating`, `failed`, `failed_to_start`, `online`, `offline`. - `started_at` (string (date-time) | null, required): When the Spicepod instance started, or when the Cloud Connect runtime enrolled. **400 Bad Request** Invalid project ID **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope **404 Not Found** Project not found **409 Conflict** The project has no running instances. `code` is `project_not_deployed` when a managed or BYOC project was never deployed, or `project_paused` when the project is paused. Content type: `application/json` - `error` (string, required) - `code` (string, required): Allowed values: `project_not_deployed`, `project_paused`. **422 Unprocessable Content** The project is not fully configured **500 Internal Server Error** Internal server error **503 Service Unavailable** The project runtime did not answer OpenAPI: [api.spice.ai/openapi.json](https://api.spice.ai/openapi.json)