Skip to main content

Read an installed stack's template inputs

GET 
/stacks/:name/config

Required role: admin. Only an account or token with the admin role can call this operation.

Example request
curl --request GET \
  --header "Authorization: Bearer $HOSERVA_TOKEN" \
  "https://$HOSERVA_HOST:8008/api/v1/stacks/{name}/config"

The inputs of the template a stack was installed from, with the value each has now. The inputs are read from the x-hoserva block of the stack's stored docker-compose.yml text, so the catalog is not needed and a stack whose Compose file was edited by hand is read as it runs (manuallyEdited says so), and the values from the stack's .env. A secret is never returned: set says whether the .env gives it a value. A device input is readOnly: its device mapping is part of the Compose file, which the form never writes. A path input that is not appdata lists the existing shares' paths as suggestions, as previewTemplateInstall does. A stack whose Compose file has no x-hoserva block (one made with createStack without a template) is refused with 409 stack_has_no_template; one whose block is not valid with 422 template_invalid; an unknown stack with 404 stack_not_found and a name that is not a valid stack name with 400 invalid_stack_name. A stack whose .env cannot be opened (a restore without the backup passphrase) is a plain failure.

Request​

Responses​

The stack's inputs.