Skip to content

Render a catalog app

POST
/container/catalog/{source}/{id}/render
curl --request POST \
--url https://sylve.lan:8181/api/container/catalog/example/example/render \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "choices": { "additionalProperty": "example" }, "stack": "example", "values": { "additionalProperty": "example" }, "variant": "example" }'

Turn a catalog app and its settings into the containers to create: one, or a stack

source
required
string

Catalog

id
required
string

App ID

Settings

Media typeapplication/json
object
choices
object
key
additional properties
string
stack

Stack names a stack app’s install in place of the app’s ID, so it can be installed more than once.

string
values
object
key
additional properties
string
variant
string
Examplegenerated
{
"choices": {
"additionalProperty": "example"
},
"stack": "example",
"values": {
"additionalProperty": "example"
},
"variant": "example"
}

Success

Media typeapplication/json
object
data
object
containers
Array<object>
object
annotations
object
key
additional properties
string
catalogApp
string
command
Array<string>
cores
integer
description
string
entrypoint
Array<string>
env
Array<object>
object
name
string
value
string
extraHosts
Array<string>
hostname
string
image
string
ip
string
memory
integer
mounts
Array<object>
object
guid
string
mode
string
owner
string
readOnly
boolean
source
string
target
string
type
string
Allowed values: volume dataset path
name
required

Name renames the container on update: its hostname and the name its network knows it by. CreateRequest’s own Name shadows it on create.

string
network
string
ocId
required
integer
os
string
pool
required
string
ports
Array<object>
object
containerPort
integer
hostIp
string
hostPort
integer
protocol
string
pullImage
boolean
restart
string
restartRetries
integer
secrets

Secrets are the catalog secrets the request was rendered with, by setting.

object
key
additional properties
string
service
string
shmSize
string
stack
string
stackTitle
string
startAfterCreate
boolean
startAtBoot
boolean
startOrder
integer
stopTimeout
integer
title
string
user
string
webHttps
boolean
webPort
integer
workDir
string
stack
string
error
string
message
string
status
string
Example
{
"data": {
"containers": [
{
"mounts": [
{
"type": "volume"
}
]
}
]
}
}