curl --request POST \
--url https://api.storiza.store/apps/{id}/command/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"command": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({command: ['<string>']})
};
fetch('https://api.storiza.store/apps/{id}/command/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.storiza.store/apps/{id}/command/preview"
payload = { "command": ["<string>"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"message": "Start command resolved",
"data": {
"command": [
"<string>"
],
"resolved": [
"<string>"
],
"managed": true,
"referenced": [
{
"name": "<string>",
"value": "<string>",
"source": "environment",
"defined": true,
"secret": true
}
],
"available": [
{
"name": "<string>",
"value": "<string>",
"source": "environment",
"defined": true,
"secret": true
}
]
}
}Preview a start command
Resolve a draft start command against the app’s real environment, without saving or restarting anything.
$NAME and ${NAME} are substituted from the same environment the container is created with — the template’s variables, yours, and the app’s own address. $$ is a literal dollar sign. An argument is never re-split, so a value containing a space stays one argument, unlike a shell.
available is everything you may reference, which is what a dashboard builds its autocomplete from. referenced is what this draft actually used, with defined: false on anything nothing supplies — those expand to an empty string rather than failing, so this is where a typo becomes visible.
Values of variables the template marks secret are withheld: value is null and secret is true. They still substitute correctly in the container.
Send no command to preview what the app would start with as it stands.
Required API key permission: apps:write
curl --request POST \
--url https://api.storiza.store/apps/{id}/command/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"command": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({command: ['<string>']})
};
fetch('https://api.storiza.store/apps/{id}/command/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.storiza.store/apps/{id}/command/preview"
payload = { "command": ["<string>"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"message": "Start command resolved",
"data": {
"command": [
"<string>"
],
"resolved": [
"<string>"
],
"managed": true,
"referenced": [
{
"name": "<string>",
"value": "<string>",
"source": "environment",
"defined": true,
"secret": true
}
],
"available": [
{
"name": "<string>",
"value": "<string>",
"source": "environment",
"defined": true,
"secret": true
}
]
}
}Authorizations
An API key from the Storiza dashboard (API & Integrations), sent as Authorization: Bearer stz_….
Path Parameters
Body
1001000Was this page helpful?