Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/apps/{id}/files/{*path}` -- one file with content. The current etag is returned both in the body and the `ETag` response header.

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

Parameters

Section titled “Parameters”

Path Parameters

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

File path within the App

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

A single file on the wire – full content + hex etag.

object
content
string | null
etag
required
string
is_binary
required
boolean
language
required
string
path
required
string
size_bytes
required
integer format: int64
storage_ref
string | null
tracks_catalog
required

#1212 — this file still tracks its marketplace listing, so a catalog update will replace it and an edit here will take it off that track.

A boolean rather than the version id: the id is internal bookkeeping, and what a reader needs to decide is binary. False covers all three ways a file can be the workspace’s own — hand-written, repo-synced, or a path the listing declared as its whitelabel overlay.

boolean
updated_at
required
string format: date-time
Examplegenerated
{
  "content": "example",
  "etag": "example",
  "is_binary": true,
  "language": "example",
  "path": "example",
  "size_bytes": 1,
  "storage_ref": "example",
  "tracks_catalog": true,
  "updated_at": "2026-04-15T12:00:00Z"
}

Headers

Section titled “Headers”
ETag
string

Current file etag (hex)

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

404

Section titled “404”

File not found

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