Sign in

v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB
Apps

get/apps/

Query parameters

optionIdinteger

ID of the option to filter by

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

admin_idinteger required

ID of the admin that created the application

admin_namestring required

Name admin that created the application

categoriesstring[] required

Names of the categories this app belongs to (resolved from category_ids)

category_idsinteger[]

IDs of the app categories (see /apps/categories) this app belongs to

changedstring date-time required

Date and time the application was last changed

changed_tsinteger required
cloud_init_templatestring

Cloud init template for the application, this is used to provide the cloud init configuration for the application. The templating syntax is Jinja2

createdstring date-time required

Date and time the application was created

created_tsinteger required
descriptionstring

Description of the application, this is used to provide context to the user

help_text_templatestring

Markdown help doc for the application, this is used to provide documentation to the application and its form requirements

idinteger required

ID of the application

image_urlstring

URL of the image for the app option to display in store

included_featuresstring[]

Marketed bullet points / features for this app

namestring required

Name of the application, this is used as a verbatim key in configuration data

set_no_app_formboolean

Set this to true to disable the form for this application, this is used to disable the form for applications that do not require user input. App form most NOT be supplied when this is true for updating apps. This was is a workaround for swagger typescript generation not supporting nullable fields.

sps_app_option_idinteger

ID of the SPS app-option to link to this app

sps_app_option_namestring

Name of the SPS App option linked to

sps_base_os_option_idinteger required

ID of the base SPS OS option to link to this app

sps_base_os_option_namestring required

Name of the base SPS OS option linked to this app

tag_idsinteger[]

IDs of the app tags (see /apps/tags) applied to this app

tagsstring[] required

Names of the tags applied to this app (resolved from tag_ids)

titlestring required

Title of the application, this is used to provide context to the user

vps_app_option_idinteger

ID of the VPS app-option to link to this app

vps_app_option_namestring

Name of the VPS App option linked to

vps_base_os_option_idinteger required

ID of the base VPS OS option to link to this app

vps_base_os_option_namestring required

Name of the base VPS OS option linked to this app