Skip to content
SupaCloud Docs
Select themeSelect language

Get image config (from DB or auto-detected)

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

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 configuration

Media typeapplication/json

Root configuration from .supacloud.yaml

object
mcps

MCP configurations with secret references

object
key
additional properties

MCP configuration

object
config

Additional MCP-specific configuration

object
key
additional properties
env

Environment variables with secret references Format: {“VAR_NAME”: “${{ secrets.SECRET_NAME }}”}

object
key
additional properties
string
package

NPM package name (if not a built-in MCP)

string | null
stack

Stack/language configuration

object
languages

Additional languages beyond Node.js Format: [{“python”: “3.12”}, {“rust”: “stable”}]

Array<object>
object
key
additional properties
string
node

Node.js specific configuration

object
global

Global npm packages to install

Array<string>
package_manager

Package manager: npm, pnpm, yarn (default: npm)

string
version

Node.js version (default: “22”)

string
packages

System packages to install (apt)

Array<string>
version

Config version (currently 1)

integer format: int32
Examplegenerated
{
  "mcps": {
    "additionalProperty": {
      "config": {
        "additionalProperty": "example"
      },
      "env": {
        "additionalProperty": "example"
      },
      "package": "example"
    }
  },
  "stack": {
    "languages": [
      {
        "additionalProperty": "example"
      }
    ],
    "node": {
      "global": [
        "example"
      ],
      "package_manager": "example",
      "version": "example"
    },
    "packages": [
      "example"
    ]
  },
  "version": 1
}

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 bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited 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 bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited 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 bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited 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 bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited 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"
}