Skip to content
NebulaCtrlInstall

Reference

View as Markdown

Stacks API

1 operation. Every call needs a session cookie or an Authorization: Bearer nct_… token unless marked Public. Conventions, errors and scopes

POST/environments/{environmentId}/stacks/check

Check a compose file for running as a stack

Parses the compose file, lists its components and applies the Compose allow-list for the given server. Nothing is stored. Violations of kind unsupported always block a stack; restricted ones only on a server without Unrestricted. A file that is not valid YAML or not a compose file is a 422 invalid_compose.

ParameterInTypeDescription
environmentIdrequiredpathstring
Request body · application/json · required
CheckStackInputBody
  • composestringrequired
    The compose file (YAML) to check
  • serverIdstring
    The server the stack will run on; decides whether Unrestricted applies
Response 200 · OK · application/json
StackCheck
  • StackComponent[] | nullrequired
  • composeAvailableboolean | nullrequired
  • notesstring[] | nullrequired
  • unrestrictedbooleanrequired
  • Violation[] | nullrequired
Errors
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Unprocessable Entityinvalid_compose
  • 500Internal Server Error

Errors are RFC 9457 application/problem+json with a stable code field.