Management APIs / Projects

Get project instance logs

GEThttps://api.spice.ai/v1/projects/{projectId}/instances/{instanceName}/logs

Returns the most recent log lines of one instance of a deployed project, oldest first, without color codes. The org's plan sets the largest tail. List the instance names with GET /v1/projects/{projectId}/instances.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • projectIdintegerRequired

    The ID of the project

  • instanceNamestringRequired

    The instance name from GET /v1/projects/{projectId}/instances

Query parameters

  • tailinteger

    How many of the most recent lines to return

    • Default: 100
    • Minimum: 1

Header parameters

  • X-Org-Namestring

    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}$

Responses

200The instance's most recent log linesapplication/json

  • instancestringRequired

    The instance name

  • tailintegerRequired

    The number of lines asked for

  • linesarray of stringRequired

    Log lines, oldest first

400Invalid project ID or tail

401Unauthorized

403Forbiddenapplication/json

Insufficient scope (code is insufficient_scope), or tail is larger than the org's plan allows (code is plan_limit, and max_tail is the largest allowed tail).

  • errorstringRequired

  • codestringRequired

  • max_tailinteger

404Not Found

The project was not found, or the instance is not one of the project's instances (code is instance_not_found).

409Conflictapplication/json

The logs cannot be read in the project's current state. code is project_not_deployed when the project was never deployed, project_paused when it is paused, or instance_offline when the Cloud Connect runtime is offline and does not answer.

  • errorstringRequired

  • codestringRequired

    • Allowed values: project_not_deployed, project_paused, instance_offline

422The project is not fully configured

500Internal server error

503The project runtime did not answer

curl "https://api.spice.ai/v1/projects/<projectId>/instances/<instanceName>/logs" \
  -H "Authorization: Bearer <token>"
{
  "instance": "string",
  "tail": 0,
  "lines": [
    "string"
  ]
}

application/json

GEThttps://api.spice.ai/v1/orgs/{orgId}/projects/{projectId}/instances/{instanceName}/logs

The org is orgId in the path. Returns the most recent log lines of one instance of a deployed project, oldest first, without color codes. The org's plan sets the largest tail. List the instance names with GET /v1/projects/{projectId}/instances.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • projectIdintegerRequired

    The ID of the project

  • instanceNamestringRequired

    The instance name from GET /v1/projects/{projectId}/instances

Query parameters

  • tailinteger

    How many of the most recent lines to return

    • Default: 100
    • Minimum: 1

Header parameters

  • X-Org-Namestring

    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}$

Responses

200The instance's most recent log linesapplication/json

  • instancestringRequired

    The instance name

  • tailintegerRequired

    The number of lines asked for

  • linesarray of stringRequired

    Log lines, oldest first

400Bad Request

Invalid project ID or tail. orgId is not a valid org id (invalid_org_id), or X-Org-Name does not name that org (org_path_mismatch).

401Unauthorized

403Forbiddenapplication/json

Insufficient scope (code is insufficient_scope), or tail is larger than the org's plan allows (code is plan_limit, and max_tail is the largest allowed tail). 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).

  • errorstringRequired

  • codestringRequired

  • max_tailinteger

404Not Found

The project was not found, or the instance is not one of the project's instances (code is instance_not_found).

409Conflictapplication/json

The logs cannot be read in the project's current state. code is project_not_deployed when the project was never deployed, project_paused when it is paused, or instance_offline when the Cloud Connect runtime is offline and does not answer.

  • errorstringRequired

  • codestringRequired

    • Allowed values: project_not_deployed, project_paused, instance_offline

422The project is not fully configured

500Internal server error

503The project runtime did not answer

curl "https://api.spice.ai/v1/orgs/<orgId>/projects/<projectId>/instances/<instanceName>/logs" \
  -H "Authorization: Bearer <token>"
{
  "instance": "string",
  "tail": 0,
  "lines": [
    "string"
  ]
}

application/json

GEThttps://api.spice.ai/v1/apps/{appId}/instances/{instanceName}/logsDeprecated

Legacy alias of /v1/projects/{projectId}/instances/{instanceName}/logs — projects were previously called apps. Returns the most recent log lines of one instance of a deployed project, oldest first, without color codes. The org's plan sets the largest tail. List the instance names with GET /v1/projects/{projectId}/instances.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • appIdintegerRequired

    The ID of the project

  • instanceNamestringRequired

    The instance name from GET /v1/projects/{projectId}/instances

Query parameters

  • tailinteger

    How many of the most recent lines to return

    • Default: 100
    • Minimum: 1

Header parameters

  • X-Org-Namestring

    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}$

Responses

200The instance's most recent log linesapplication/json

  • instancestringRequired

    The instance name

  • tailintegerRequired

    The number of lines asked for

  • linesarray of stringRequired

    Log lines, oldest first

400Invalid project ID or tail

401Unauthorized

403Forbiddenapplication/json

Insufficient scope (code is insufficient_scope), or tail is larger than the org's plan allows (code is plan_limit, and max_tail is the largest allowed tail).

  • errorstringRequired

  • codestringRequired

  • max_tailinteger

404Not Found

The project was not found, or the instance is not one of the project's instances (code is instance_not_found).

409Conflictapplication/json

The logs cannot be read in the project's current state. code is project_not_deployed when the project was never deployed, project_paused when it is paused, or instance_offline when the Cloud Connect runtime is offline and does not answer.

  • errorstringRequired

  • codestringRequired

    • Allowed values: project_not_deployed, project_paused, instance_offline

422The project is not fully configured

500Internal server error

503The project runtime did not answer

OpenAPIapi.spice.ai/openapi.json

curl "https://api.spice.ai/v1/apps/<appId>/instances/<instanceName>/logs" \
  -H "Authorization: Bearer <token>"
{
  "instance": "string",
  "tail": 0,
  "lines": [
    "string"
  ]
}

application/json