Install a catalogue app
curl --request POST \
--url https://my.server.express/api/v1/cloud/{id}/app-installs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"inputs": {}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({slug: '<string>', inputs: {}})
};
fetch('https://my.server.express/api/v1/cloud/{id}/app-installs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/cloud/{id}/app-installs"
payload = {
"slug": "<string>",
"inputs": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"installId": "<string>",
"status": "PENDING"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Cloud
Install a catalogue app
Queues a one-click app install and returns at once; poll GET /v1/cloud//app-installs for its state. Inputs are
validated against the app’s field schema and generated secrets are minted server-side. Session auth only; needs the
operate role. 403 while PENDING/SUSPENDED. 409 when busy, not yet provisioned, running Windows, too small for the app,
or the app is already installed/installing. Writes an INSTALL_CLOUD_APP audit entry.
POST
/
v1
/
cloud
/
{id}
/
app-installs
Install a catalogue app
curl --request POST \
--url https://my.server.express/api/v1/cloud/{id}/app-installs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"inputs": {}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({slug: '<string>', inputs: {}})
};
fetch('https://my.server.express/api/v1/cloud/{id}/app-installs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/cloud/{id}/app-installs"
payload = {
"slug": "<string>",
"inputs": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"installId": "<string>",
"status": "PENDING"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.
Path Parameters
Service id of the cloud server.
Body
application/json