Skip to content
SupaCloud Docs
Select themeSelect language

Get image build status for a project

GET
/api/projects/{id}/image/status
curl --request GET \
  --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/image/status

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Project id

Responses

Section titled “Responses”

200

Section titled “200”

Image build status

Media typeapplication/json

Response for image status.

object
detected_stack
image_age_days

Whole days since the image was built. Derived from image_built_at alone, so it is reported even when Docker cannot be reached at all — the age of a pinned image is never invisible.

integer | null format: int64
image_built_at
string | null format: date-time
image_check
required

How far the check got: compared (the base image was inspected), base_unavailable (it was not — only the age ceiling applies) or not_built. A client must not render image_stale: false as “current” while this says base_unavailable.

string
image_error
string | null
image_size
integer | null format: int64
image_stale

True when any leg of [image_freshness] fired. Read it together with image_check: false means “current” only when image_check is compared.

boolean
image_stale_reason

The strongest leg that fired: agent_code_changed | base_image_newer | max_age_exceeded. null when the image is not stale.

string | null
image_status
string | null
image_tag
string | null
Examplegenerated
{
  "detected_stack": "example",
  "image_age_days": 1,
  "image_built_at": "2026-04-15T12:00:00Z",
  "image_check": "example",
  "image_error": "example",
  "image_size": 1,
  "image_stale": true,
  "image_stale_reason": "example",
  "image_status": "example",
  "image_tag": "example"
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}