diff --git a/doc/api.html b/doc/api.html
index fa3d32d87..b13d9b52e 100644
--- a/doc/api.html
+++ b/doc/api.html
@@ -7,7 +7,6 @@
     <link rel="stylesheet" type="text/css" href="swagger/swagger-ui.css" />
     <link rel="stylesheet" type="text/css" href="swagger/index.css" />
     <link rel="icon" type="image/png" href="swagger/favicon-32x32.png" sizes="32x32" />
-    <link rel="icon" type="image/png" href="swagger/favicon-16x16.png" sizes="16x16" />
   </head>
 
   <body>
@@ -18,7 +17,6 @@
     <script>
     window.onload = function() {
   //<editor-fold desc="Changeable Configuration Block">
-
   // the following lines will be replaced by docker/configurator, when it runs in a docker-container
   window.ui = SwaggerUIBundle({
     spec: openapiJSON,
diff --git a/doc/generate_api_doc.py b/doc/generate_api_doc.py
index 2f1adfa2d..57e68ab37 100644
--- a/doc/generate_api_doc.py
+++ b/doc/generate_api_doc.py
@@ -48,11 +48,58 @@ def main():
 
         },
         'servers': [
-            {'url': 'https://demo.yunohost.org'},
-            {'url': 'https://'+ domain}
+            {'url': 'https://demo.yunohost.org/yunohost/api'},
+            {'url': f"https://{domain}/yunohost/api"}
         ],
-        'tags': [],
-        'paths': {}
+        'tags': [
+            {
+                'name': 'public',
+                'description': 'Public route'
+            }
+        ],
+        'paths': {
+            '/login': {
+                'post': {
+                    'tags': ['public'],
+                    'summary': 'Logs in and returns the authentication cookie',
+                    'requestBody': {
+                        'required': True,
+                        'content': {
+                            'multipart/form-data': {
+                                'schema': {
+                                    'type': 'object',
+                                    'properties': {
+                                        'password': {
+                                            'type': 'string',
+                                            'format': 'password'
+                                        }
+                                    },
+                                    'required': [
+                                        'password'
+                                    ]
+                                }
+                            }
+                        }
+                    },
+                    'security': [],
+                    'responses': {
+                        '200': {
+                            'description': 'Successfully login'
+                        }
+                    }
+                }
+            }
+        },
+        'components': {
+            'securitySchemes': {
+                'cookieAuth': {
+                    'type': 'apiKey',
+                    'in': 'cookie',
+                    'name': 'session.yunohost.admin'
+                }
+            }
+        },
+        'security': {'cookieAuth': [] }
     }
 
 
@@ -82,6 +129,7 @@ def main():
                 for i, api in enumerate(action_params['api']):
                     print(api)
                     method, path = api.split(' ')
+                    method = method.lower()
                     key_param = ''
                     if '{' in path:
                         key_param = path[path.find("{")+1:path.find("}")]
@@ -105,7 +153,22 @@ def main():
                     }
 
                     if 'arguments' in action_params:
-                        operation['parameters'] = []
+                        if method in ['put', 'post', 'patch']:
+                            operation['requestBody'] = {
+                                'required': True,
+                                'content': {
+                                    'multipart/form-data': {
+                                        'schema': {
+                                            'type': 'object',
+                                            'properties': {
+                                            },
+                                            'required': []
+                                        }
+                                    }
+                                }
+                            }
+                        else:
+                            operation['parameters'] = []
                         for arg_name, arg_params in action_params['arguments'].items():
                             if 'help' not in arg_params:
                                 arg_params['help'] = ''
@@ -132,10 +195,7 @@ def main():
                             else:
                                 allow_multiple = False
                             if 'choices' in arg_params:
-                                allowable_values = {
-                                    'valueType': 'LIST',
-                                    'values': arg_params['choices']
-                                }
+                                allowable_values = arg_params['choices']
                             if 'action' in arg_params and arg_params['action'] == 'store_true':
                                 allowable_values = {
                                     'valueType': 'LIST',
@@ -147,20 +207,31 @@ def main():
                                 required = True
                                 allow_multiple = False
 
-                            parameters = {
-                                'name': name,
-                                'in': param_type,
-                                'description': arg_params['help'],
-                                'required': required,
-                                'schema': {
+                            if method in ['put', 'post', 'patch']:
+                                schema = operation['requestBody']['content']['multipart/form-data']['schema']
+                                schema['properties'][name] = {
                                     'type': 'string',
-                                },
-                                'explode': allow_multiple
-                            }
-                            #if allowable_values is not None:
-                            #    parameters['allowableValues'] = allowable_values
+                                    'description': arg_params['help']
+                                }
+                                if required:
+                                    schema['required'].append(name)
+                                if allowable_values is not None:
+                                    schema['properties'][name]['enum'] = allowable_values
+                            else:
+                                parameters = {
+                                    'name': name,
+                                    'in': param_type,
+                                    'description': arg_params['help'],
+                                    'required': required,
+                                    'schema': {
+                                        'type': 'string',
+                                    },
+                                    'explode': allow_multiple
+                                }
+                                if allowable_values is not None:
+                                    parameters['schema']['enum'] = allowable_values
 
-                            operation['parameters'].append(parameters)
+                                operation['parameters'].append(parameters)
 
                     resource_list['paths'][path][method.lower()] = operation
 
diff --git a/doc/openapi.js b/doc/openapi.js
index a9b369b6d..1221c31de 100644
--- a/doc/openapi.js
+++ b/doc/openapi.js
@@ -1 +1 @@
-var openapiJSON = {"openapi": "3.0.3", "info": {"title": "YunoHost API", "description": "This is the YunoHost API used on all YunoHost instances. This API is essentially used by YunoHost Webadmin.", "version": "11.0.7"}, "servers": [{"url": "https://demo.yunohost.org"}, {"url": "https://ynh.local"}], "tags": [{"name": "user", "description": "Manage users and groups"}, {"name": "user group", "description": "Manage user groups"}, {"name": "user permission", "description": "Manage permissions"}, {"name": "user ssh", "description": "Manage ssh access"}, {"name": "domain", "description": "Manage domains"}, {"name": "domain config", "description": "Domain settings"}, {"name": "domain dns", "description": "Manage domains DNS"}, {"name": "domain cert", "description": "Manage domain certificates"}, {"name": "app", "description": "Manage apps"}, {"name": "app action", "description": "Handle apps actions"}, {"name": "app config", "description": "Applications configuration panel"}, {"name": "backup", "description": "Manage backups"}, {"name": "settings", "description": "Manage YunoHost global settings"}, {"name": "service", "description": "Manage services"}, {"name": "firewall", "description": "Manage firewall rules"}, {"name": "dyndns", "description": "Subscribe and Update DynDNS Hosts"}, {"name": "tools", "description": "Specific tools"}, {"name": "tools migrations", "description": "Manage migrations"}, {"name": "hook", "description": "Manage hooks"}, {"name": "log", "description": "Manage debug logs"}, {"name": "diagnosis", "description": "Look for possible issues on the server"}], "paths": {"/users": {"get": {"tags": ["user"], "operationId": "user_list", "summary": "List users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "fields", "in": "query", "description": "fields to fetch (username, fullname, mail, mail-alias, mail-forward, mailbox-quota, groups, shell, home-path)", "required": true, "schema": {"type": "string"}, "explode": true}]}, "post": {"tags": ["user"], "operationId": "user_create", "summary": "Create user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "The unique username to create", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "firstname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "lastname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "password", "in": "query", "description": "User password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "Domain for the email address and xmpp account", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "mailbox_quota", "in": "query", "description": "Mailbox size quota", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/<username>": {"delete": {"tags": ["user"], "operationId": "user_delete", "summary": "Delete user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Purge user's home and mail directories", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user"], "operationId": "user_update", "summary": "Update user informations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to update", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "firstname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "lastname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "mail", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "change_password", "in": "query", "description": "New password to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "add_mailforward", "in": "query", "description": "Mailforward addresses to add", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "remove_mailforward", "in": "query", "description": "Mailforward addresses to remove", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "add_mailalias", "in": "query", "description": "Mail aliases to add", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "remove_mailalias", "in": "query", "description": "Mail aliases to remove", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "mailbox_quota", "in": "query", "description": "Mailbox size quota", "required": false, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user"], "operationId": "user_info", "summary": "Get user information", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username or email to get information", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/export": {"get": {"tags": ["user"], "operationId": "user_export", "summary": "Export users into CSV", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/users/import": {"post": {"tags": ["user"], "operationId": "user_import", "summary": "Import several users from CSV", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "csvfile", "in": "query", "description": "CSV file with columns username, firstname, lastname, password, mail, mailbox-quota, mail-alias, mail-forward, groups (separated by coma)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "update", "in": "query", "description": "Update all existing users contained in the CSV file (by default existing users are ignored)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete all existing users that are not contained in the CSV file (by default existing users are kept)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups": {"get": {"tags": ["user group"], "operationId": "user group_list", "summary": "List existing groups", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "short", "in": "query", "description": "List only the names of groups", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all informations known about each groups", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "include_primary_groups", "in": "query", "description": "Also display primary groups (each user has an eponym group that only contains itself)", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["user group"], "operationId": "user group_create", "summary": "Create group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be created", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>": {"delete": {"tags": ["user group"], "operationId": "user group_delete", "summary": "Delete group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be deleted", "required": true, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user group"], "operationId": "user group_info", "summary": "Get information about a specific group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to fetch info about", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>/add/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_add", "summary": "Add users to group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to add user(s) to", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "usernames", "in": "query", "description": "User(s) to add in the group", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/groups/<groupname>/remove/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_remove", "summary": "Remove users from group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to remove user(s) from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "usernames", "in": "query", "description": "User(s) to remove from the group", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/permissions": {"get": {"tags": ["user permission"], "operationId": "user permission_list", "summary": "List permissions and corresponding accesses", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "apps", "in": "query", "description": "Apps to list permission for (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "short", "in": "query", "description": "Only list permission names", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all info known about each permission, including the full user list of each group it is granted to.", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>": {"get": {"tags": ["user permission"], "operationId": "user permission_info", "summary": "Get information about a specific permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Name of the permission to fetch info about (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user permission"], "operationId": "user permission_update", "summary": "Manage group or user permissions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "label", "in": "query", "description": "Label for this permission. This label will be shown on the SSO and in the admin", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "show_tile", "in": "query", "description": "Define if a tile will be shown in the SSO", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["user permission"], "operationId": "user permission_reset", "summary": "Reset allowed groups to the default (all_users) for a given permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>/add/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_add", "summary": "Grant permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "names", "in": "query", "description": "Group or usernames to grant this permission to", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/permissions/<permission>/remove/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_remove", "summary": "Revoke permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "names", "in": "query", "description": "Group or usernames to revoke this permission to", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/ssh/keys": {"get": {"tags": ["user ssh"], "operationId": "user ssh_list-keys", "summary": "Show user's authorized ssh keys", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/ssh/key": {"post": {"tags": ["user ssh"], "operationId": "user ssh_add-key", "summary": "Add a new authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be added", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "comment", "in": "query", "description": "Optional comment about the key", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["user ssh"], "operationId": "user ssh_remove-key", "summary": "Remove an authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be removed", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains": {"get": {"tags": ["domain"], "operationId": "domain_list", "summary": "List domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "exclude_subdomains", "in": "query", "description": "Filter out domains that are obviously subdomains of other declared domains", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["domain"], "operationId": "domain_add", "summary": "Create a custom domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name to add", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "dyndns", "in": "query", "description": "Subscribe to the DynDNS service", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>": {"delete": {"tags": ["domain"], "operationId": "domain_remove", "summary": "Delete domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "remove_apps", "in": "query", "description": "Remove apps installed on the domain", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation to remove apps", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/main": {"get": {"tags": ["domain"], "operationId": "domain_main-domain", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<new_main_domain>/main": {"put": {"tags": ["domain"], "operationId": "domain_main-domain_1", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domain/<domain>/urlavailable": {"get": {"tags": ["domain"], "operationId": "domain_url-available", "summary": "Check availability of a web path", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "The domain for the web path (e.g. your.domain.tld)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "The path to check (e.g. /coffee)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/config": {"get": {"tags": ["domain config"], "operationId": "domain config_get", "summary": "Display a domain configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["domain config"], "operationId": "domain config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The question or form key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for new configuration (i.e. \"mail_in=0&mail_out=0\")", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/suggest": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest_1", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/push": {"post": {"tags": ["domain dns"], "operationId": "domain dns_push", "summary": "Push DNS records to registrar", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name to push DNS conf for", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Only display what's to be pushed", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Also update/remove records which were not originally set by Yunohost, or which have been manually modified", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Delete all records", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain_list>/cert": {"get": {"tags": ["domain cert"], "operationId": "domain cert_status", "summary": "List status of current certificates (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains to check", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["domain cert"], "operationId": "domain cert_install", "summary": "Install Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains for which to install the certificates", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Install even if current certificate is not self-signed", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_checks", "in": "query", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to install. (Not recommended)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "self_signed", "in": "query", "description": "Install self-signed certificate instead of Let's Encrypt", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain_list>/cert/renew": {"put": {"tags": ["domain cert"], "operationId": "domain cert_renew", "summary": "Renew the Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains for which to renew the certificates", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Ignore the validity threshold (30 days)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "email", "in": "query", "description": "Send an email to root with logs if some renewing fails", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_checks", "in": "query", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to renew. (Not recommended)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/catalog": {"get": {"tags": ["app"], "operationId": "app_catalog", "summary": "Show the catalog of installable application", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_categories", "in": "query", "description": "Also return a list of app categories", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/manifest": {"get": {"tags": ["app"], "operationId": "app_manifest", "summary": "Return the manifest of a given app from the catalog, or from a remote git repo", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to fetch the manifest of", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps": {"get": {"tags": ["app"], "operationId": "app_list", "summary": "List installed apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "upgradable", "in": "query", "description": "List only apps that can upgrade to a newer version", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["app"], "operationId": "app_install", "summary": "Install apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to install", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "label", "in": "query", "description": "Custom name for the app", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_remove_on_failure", "in": "query", "description": "Debug option to avoid removing the app on a failed installation", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation if the app is not safe to use (low quality, experimental or 3rd party)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>": {"get": {"tags": ["app"], "operationId": "app_info", "summary": "Show infos about a specific installed app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["app"], "operationId": "app_remove", "summary": "Remove app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App to remove", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Also remove all application data", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/map": {"get": {"tags": ["app"], "operationId": "app_map", "summary": "Show the mapping between urls and apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app to map", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "raw", "in": "query", "description": "Return complete dict", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "user", "in": "query", "description": "Allowed app map for a user", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/upgrade": {"put": {"tags": ["app"], "operationId": "app_upgrade", "summary": "Upgrade app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App(s) to upgrade (default all)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "url", "in": "query", "description": "Git url to fetch for upgrade", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "file", "in": "query", "description": "Folder or tarball for upgrade", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Force the update, even though the app is up to date", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_safety_backup", "in": "query", "description": "Disable the safety backup during upgrade", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/changeurl": {"put": {"tags": ["app"], "operationId": "app_change-url", "summary": "Change app's URL", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Target app instance name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "New app domain on which the application will be moved", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "New path at which the application will be moved", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/settings": {"get": {"tags": ["app"], "operationId": "app_setting", "summary": "Set or get an app setting value", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "Key to get/set", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "Value to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete the key", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/default": {"put": {"tags": ["app"], "operationId": "app_makedefault", "summary": "Redirect domain root to an app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name to put on domain root", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "Specific domain to put app on (the app domain by default)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "undo", "in": "query", "description": "Undo redirection", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/label": {"put": {"tags": ["app"], "operationId": "app_change-label", "summary": "Change app label", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "new_label", "in": "query", "description": "New app label", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions": {"get": {"tags": ["app action"], "operationId": "app action_list", "summary": "List app actions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions/<action>": {"put": {"tags": ["app action"], "operationId": "app action_run", "summary": "Run app action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "action", "in": "query", "description": "action id", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/config-panel": {"get": {"tags": ["app config"], "operationId": "app config_get", "summary": "Display an app configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/config": {"put": {"tags": ["app config"], "operationId": "app config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The question or panel key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for new configuration (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args_file", "in": "query", "description": "YAML or JSON file with key/value couples", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups": {"post": {"tags": ["backup"], "operationId": "backup_create", "summary": "Create a backup local archive. If neither --apps or --system are given, this will backup all apps and all system parts. If only --apps if given, this will only backup apps and no system parts. Similarly, if only --system is given, this will only backup system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the backup archive", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "description", "in": "query", "description": "Short description of the backup", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "output_directory", "in": "query", "description": "Output directory for the backup", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "methods", "in": "query", "description": "List of backup methods to apply (copy or tar by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "system", "in": "query", "description": "List of system parts to backup (or all if none given).", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "apps", "in": "query", "description": "List of application names to backup (or all if none given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "dry_run", "in": "query", "description": "'Simulate' the backup and return the size details per item to backup", "required": false, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["backup"], "operationId": "backup_list", "summary": "List available local backup archives", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "with_info", "in": "query", "description": "Show backup information for each archive", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/restore": {"put": {"tags": ["backup"], "operationId": "backup_restore", "summary": "Restore from a local backup archive. If neither --apps or --system are given, this will restore all apps and all system parts in the archive. If only --apps if given, this will only restore apps and no system parts. Similarly, if only --system is given, this will only restore system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "system", "in": "query", "description": "List of system parts to restore (or all if none is given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "apps", "in": "query", "description": "List of application names to restore (or all if none is given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Force restauration on an already installed system", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>": {"get": {"tags": ["backup"], "operationId": "backup_info", "summary": "Show info about a local backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional backup information", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["backup"], "operationId": "backup_delete", "summary": "Delete a backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the archive to delete", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/download": {"get": {"tags": ["backup"], "operationId": "backup_download", "summary": "(API only) Request to download the file", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/settings": {"get": {"tags": ["settings"], "operationId": "settings_list", "summary": "list all entries of the settings", "description": "", "responses": {"200": {"description": "successful operation"}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset-all", "summary": "reset all settings to their default value", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/settings/<key>": {"get": {"tags": ["settings"], "operationId": "settings_get", "summary": "get an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["settings"], "operationId": "settings_set", "summary": "set an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["settings"], "operationId": "settings_reset", "summary": "set an entry value to its default one", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/services/<names>/start": {"put": {"tags": ["service"], "operationId": "service_start", "summary": "Start one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to start", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/stop": {"put": {"tags": ["service"], "operationId": "service_stop", "summary": "Stop one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to stop", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/restart": {"put": {"tags": ["service"], "operationId": "service_restart", "summary": "Restart one or more services. If the services are not running yet, they will be started.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to restart", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/enable": {"put": {"tags": ["service"], "operationId": "service_enable", "summary": "Enable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to enable", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/disable": {"put": {"tags": ["service"], "operationId": "service_disable", "summary": "Disable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to disable", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services": {"get": {"tags": ["service"], "operationId": "service_status", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>": {"get": {"tags": ["service"], "operationId": "service_status_1", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<name>/log": {"get": {"tags": ["service"], "operationId": "service_log", "summary": "Log every log files of a service", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Service name to log", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall": {"get": {"tags": ["firewall"], "operationId": "firewall_list", "summary": "List all firewall rules", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "raw", "in": "query", "description": "Return the complete YAML dict", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "by_ip_version", "in": "query", "description": "List rules by IP version", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_forwarded", "in": "query", "description": "List forwarded ports with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/<protocol>/allow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_allow", "summary": "Allow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "protocol", "in": "query", "description": "Protocol type to allow (TCP/UDP/Both)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "port", "in": "query", "description": "Port or range of ports to open", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "ipv4_only", "in": "query", "description": "Only add a rule for IPv4 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ipv6_only", "in": "query", "description": "Only add a rule for IPv6 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_upnp", "in": "query", "description": "Do not add forwarding of this port with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_reload", "in": "query", "description": "Do not reload firewall rules", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/<protocol>/disallow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_disallow", "summary": "Disallow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "protocol", "in": "query", "description": "Protocol type to allow (TCP/UDP/Both)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "port", "in": "query", "description": "Port or range of ports to close", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "ipv4_only", "in": "query", "description": "Only remove the rule for IPv4 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ipv6_only", "in": "query", "description": "Only remove the rule for IPv6 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "upnp_only", "in": "query", "description": "Only remove forwarding of this port with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_reload", "in": "query", "description": "Do not reload firewall rules", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/upnp/<action>": {"put": {"tags": ["firewall"], "operationId": "firewall_upnp", "summary": "Manage port forwarding using UPnP", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "no_refresh", "in": "query", "description": "Do not refresh port forwarding", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/adminpw": {"put": {"tags": ["tools"], "operationId": "tools_adminpw", "summary": "Change password of admin and root users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_password", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/postinstall": {"post": {"tags": ["tools"], "operationId": "tools_postinstall", "summary": "YunoHost post-install", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "YunoHost main domain", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "password", "in": "query", "description": "YunoHost admin password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ignore_dyndns", "in": "query", "description": "Do not subscribe domain to a DynDNS service", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_password", "in": "query", "description": "Use this if you really want to set a weak password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_diskspace", "in": "query", "description": "Use this if you really want to install YunoHost on a setup with less than 10 GB on the root filesystem", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/update/<target>": {"put": {"tags": ["tools"], "operationId": "tools_update", "summary": "YunoHost update", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "target", "in": "query", "description": "What to update, \"apps\" (application catalog) or \"system\" (fetch available package upgrades, equivalent to apt update), \"all\" for both", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/upgrade/<target>": {"put": {"tags": ["tools"], "operationId": "tools_upgrade", "summary": "YunoHost upgrade", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "target", "in": "query", "description": "What to upgrade, either \"apps\" (all apps) or \"system\" (all system packages)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/shutdown": {"put": {"tags": ["tools"], "operationId": "tools_shutdown", "summary": "Shutdown the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "force", "in": "query", "description": "skip the shutdown confirmation", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/reboot": {"put": {"tags": ["tools"], "operationId": "tools_reboot", "summary": "Reboot the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "force", "in": "query", "description": "skip the reboot confirmation", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/regenconf": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Categories to regenerate configuration of (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "with_diff", "in": "query", "description": "Show differences in case of configuration changes", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Override all manual modifications in configuration files", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Show what would have been regenerated", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_pending", "in": "query", "description": "List pending configuration files and exit", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/regenconf/<names>": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf_1", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Categories to regenerate configuration of (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "with_diff", "in": "query", "description": "Show differences in case of configuration changes", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Override all manual modifications in configuration files", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Show what would have been regenerated", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_pending", "in": "query", "description": "List pending configuration files and exit", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/versions": {"get": {"tags": ["tools"], "operationId": "tools_versions", "summary": "Display YunoHost's packages versions", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/migrations": {"get": {"tags": ["tools migrations"], "operationId": "tools migrations_list", "summary": "List migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "pending", "in": "query", "description": "list only pending migrations", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "done", "in": "query", "description": "list only migrations already performed", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["tools migrations"], "operationId": "tools migrations_run", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "targets", "in": "query", "description": "Migrations to run (all pendings by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "skip", "in": "query", "description": "Skip specified migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_rerun", "in": "query", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "auto", "in": "query", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "accept_disclaimer", "in": "query", "description": "Accept disclaimers of migrations (please read them before using this option)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/migrations/<targets>": {"put": {"tags": ["tools migrations"], "operationId": "tools migrations_run_1", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "targets", "in": "query", "description": "Migrations to run (all pendings by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "skip", "in": "query", "description": "Skip specified migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_rerun", "in": "query", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "auto", "in": "query", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "accept_disclaimer", "in": "query", "description": "Accept disclaimers of migrations (please read them before using this option)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/hooks/<action>": {"get": {"tags": ["hook"], "operationId": "hook_list", "summary": "List available hooks for an action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "Action name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "list_by", "in": "query", "description": "Property to list hook by", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "show_info", "in": "query", "description": "Show hook information", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs": {"get": {"tags": ["log"], "operationId": "log_list", "summary": "List logs", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "limit", "in": "query", "description": "Maximum number of operations to list (default to 50)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional infos (e.g. operation success) but may significantly increase command time. Consider using --limit in combination with this.", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about operations that are not the main operation but are sub-operations triggered by another ongoing operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs/<path>": {"get": {"tags": ["log"], "operationId": "log_show", "summary": "Display a log content", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file which to display the content", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "(Deprecated, see yunohost log share) Share the full log using yunopaste", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "filter_irrelevant", "in": "query", "description": "Do not show some lines deemed not relevant (like set +x or helper argument parsing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about sub-operations of this operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs/<path>/share": {"get": {"tags": ["log"], "operationId": "log_share", "summary": "Share the full log on yunopaste (alias to show --share)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file to share", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/categories": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_list", "summary": "List diagnosis categories", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/diagnosis": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_show", "summary": "Show most recents diagnosis results", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to display (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Display additional information", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "issues", "in": "query", "description": "Only display issues", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "Share the logs using yunopaste", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Show a human-readable output", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/<category>": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_get", "summary": "Low-level command to fetch raw data and status about a specific diagnosis test", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "category", "in": "query", "description": "Diagnosis category to fetch results from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "item", "in": "query", "description": "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/diagnosis/run": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_run", "summary": "Run diagnosis", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to run (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Ignore the cached report even if it is still 'fresh'", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "except_if_never_ran_yet", "in": "query", "description": "Don't run anything if diagnosis never ran yet ... (this is meant to be used by the webadmin)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "email", "in": "query", "description": "Send an email to root with issues found (this is meant to be used by cron job)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/ignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_ignore", "summary": "Configure some diagnosis results to be ignored and therefore not considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "filter", "in": "query", "description": "Add a filter. The first element should be a diagnosis category, and other criterias can be provided using the infos from the 'meta' sections in 'yunohost diagnosis show'. For example: 'dnsrecords domain=yolo.test category=xmpp'", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "list", "in": "query", "description": "List active ignore filters", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/unignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_unignore", "summary": "Configure some diagnosis results to be unignored and therefore considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "filter", "in": "query", "description": "Remove a filter (it should be an existing filter as listed with --list)", "required": false, "schema": {"type": "string"}, "explode": true}]}}}}
\ No newline at end of file
+var openapiJSON = {"openapi": "3.0.3", "info": {"title": "YunoHost API", "description": "This is the YunoHost API used on all YunoHost instances. This API is essentially used by YunoHost Webadmin.", "version": "11.0.7"}, "servers": [{"url": "https://demo.yunohost.org/yunohost/api"}, {"url": "https://ynh.local/yunohost/api"}], "tags": [{"name": "public", "description": "Public route"}, {"name": "user", "description": "Manage users and groups"}, {"name": "user group", "description": "Manage user groups"}, {"name": "user permission", "description": "Manage permissions"}, {"name": "user ssh", "description": "Manage ssh access"}, {"name": "domain", "description": "Manage domains"}, {"name": "domain config", "description": "Domain settings"}, {"name": "domain dns", "description": "Manage domains DNS"}, {"name": "domain cert", "description": "Manage domain certificates"}, {"name": "app", "description": "Manage apps"}, {"name": "app action", "description": "Handle apps actions"}, {"name": "app config", "description": "Applications configuration panel"}, {"name": "backup", "description": "Manage backups"}, {"name": "settings", "description": "Manage YunoHost global settings"}, {"name": "service", "description": "Manage services"}, {"name": "firewall", "description": "Manage firewall rules"}, {"name": "dyndns", "description": "Subscribe and Update DynDNS Hosts"}, {"name": "tools", "description": "Specific tools"}, {"name": "tools migrations", "description": "Manage migrations"}, {"name": "hook", "description": "Manage hooks"}, {"name": "log", "description": "Manage debug logs"}, {"name": "diagnosis", "description": "Look for possible issues on the server"}], "paths": {"/login": {"post": {"tags": ["public"], "summary": "Logs in and returns the authentication cookie", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"password": {"type": "string", "format": "password"}}, "required": ["password"]}}}}, "security": [], "responses": {"200": {"description": "Successfully login"}}}}, "/users": {"get": {"tags": ["user"], "operationId": "user_list", "summary": "List users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "fields", "in": "query", "description": "fields to fetch (username, fullname, mail, mail-alias, mail-forward, mailbox-quota, groups, shell, home-path)", "required": true, "schema": {"type": "string"}, "explode": true}]}, "post": {"tags": ["user"], "operationId": "user_create", "summary": "Create user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "The unique username to create"}, "firstname": {"type": "string", "description": ""}, "lastname": {"type": "string", "description": ""}, "password": {"type": "string", "description": "User password"}, "domain": {"type": "string", "description": "Domain for the email address and xmpp account"}, "mailbox_quota": {"type": "string", "description": "Mailbox size quota"}}, "required": ["username"]}}}}}}, "/users/<username>": {"delete": {"tags": ["user"], "operationId": "user_delete", "summary": "Delete user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Purge user's home and mail directories", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["user"], "operationId": "user_update", "summary": "Update user informations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "Username to update"}, "firstname": {"type": "string", "description": ""}, "lastname": {"type": "string", "description": ""}, "mail": {"type": "string", "description": ""}, "change_password": {"type": "string", "description": "New password to set"}, "add_mailforward": {"type": "string", "description": "Mailforward addresses to add"}, "remove_mailforward": {"type": "string", "description": "Mailforward addresses to remove"}, "add_mailalias": {"type": "string", "description": "Mail aliases to add"}, "remove_mailalias": {"type": "string", "description": "Mail aliases to remove"}, "mailbox_quota": {"type": "string", "description": "Mailbox size quota"}}, "required": ["username"]}}}}}, "get": {"tags": ["user"], "operationId": "user_info", "summary": "Get user information", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username or email to get information", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/export": {"get": {"tags": ["user"], "operationId": "user_export", "summary": "Export users into CSV", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/users/import": {"post": {"tags": ["user"], "operationId": "user_import", "summary": "Import several users from CSV", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"csvfile": {"type": "string", "description": "CSV file with columns username, firstname, lastname, password, mail, mailbox-quota, mail-alias, mail-forward, groups (separated by coma)"}, "update": {"type": "string", "description": "Update all existing users contained in the CSV file (by default existing users are ignored)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "delete": {"type": "string", "description": "Delete all existing users that are not contained in the CSV file (by default existing users are kept)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["csvfile"]}}}}}}, "/users/groups": {"get": {"tags": ["user group"], "operationId": "user group_list", "summary": "List existing groups", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "short", "in": "query", "description": "List only the names of groups", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "full", "in": "query", "description": "Display all informations known about each groups", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "include_primary_groups", "in": "query", "description": "Also display primary groups (each user has an eponym group that only contains itself)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["user group"], "operationId": "user group_create", "summary": "Create group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to be created"}}, "required": ["groupname"]}}}}}}, "/users/groups/<groupname>": {"delete": {"tags": ["user group"], "operationId": "user group_delete", "summary": "Delete group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be deleted", "required": true, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user group"], "operationId": "user group_info", "summary": "Get information about a specific group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to fetch info about", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>/add/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_add", "summary": "Add users to group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to add user(s) to"}, "usernames": {"type": "string", "description": "User(s) to add in the group"}}, "required": ["groupname"]}}}}}}, "/users/groups/<groupname>/remove/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_remove", "summary": "Remove users from group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to remove user(s) from"}, "usernames": {"type": "string", "description": "User(s) to remove from the group"}}, "required": ["groupname"]}}}}}}, "/users/permissions": {"get": {"tags": ["user permission"], "operationId": "user permission_list", "summary": "List permissions and corresponding accesses", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "apps", "in": "query", "description": "Apps to list permission for (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "short", "in": "query", "description": "Only list permission names", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "full", "in": "query", "description": "Display all info known about each permission, including the full user list of each group it is granted to.", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/users/permissions/<permission>": {"get": {"tags": ["user permission"], "operationId": "user permission_info", "summary": "Get information about a specific permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Name of the permission to fetch info about (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user permission"], "operationId": "user permission_update", "summary": "Manage group or user permissions", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "label": {"type": "string", "description": "Label for this permission. This label will be shown on the SSO and in the admin"}, "show_tile": {"type": "string", "description": "Define if a tile will be shown in the SSO", "enum": ["True", "False"]}}, "required": ["permission"]}}}}}, "delete": {"tags": ["user permission"], "operationId": "user permission_reset", "summary": "Reset allowed groups to the default (all_users) for a given permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>/add/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_add", "summary": "Grant permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "names": {"type": "string", "description": "Group or usernames to grant this permission to"}}, "required": ["permission"]}}}}}}, "/users/permissions/<permission>/remove/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_remove", "summary": "Revoke permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "names": {"type": "string", "description": "Group or usernames to revoke this permission to"}}, "required": ["permission"]}}}}}}, "/users/ssh/keys": {"get": {"tags": ["user ssh"], "operationId": "user ssh_list-keys", "summary": "Show user's authorized ssh keys", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/ssh/key": {"post": {"tags": ["user ssh"], "operationId": "user ssh_add-key", "summary": "Add a new authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "Username of the user"}, "key": {"type": "string", "description": "The key to be added"}, "comment": {"type": "string", "description": "Optional comment about the key"}}, "required": ["username", "key"]}}}}}, "delete": {"tags": ["user ssh"], "operationId": "user ssh_remove-key", "summary": "Remove an authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be removed", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains": {"get": {"tags": ["domain"], "operationId": "domain_list", "summary": "List domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "exclude_subdomains", "in": "query", "description": "Filter out domains that are obviously subdomains of other declared domains", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["domain"], "operationId": "domain_add", "summary": "Create a custom domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name to add"}, "dyndns": {"type": "string", "description": "Subscribe to the DynDNS service", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["domain"]}}}}}}, "/domains/<domain>": {"delete": {"tags": ["domain"], "operationId": "domain_remove", "summary": "Delete domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "remove_apps", "in": "query", "description": "Remove apps installed on the domain", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation to remove apps", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/domains/main": {"get": {"tags": ["domain"], "operationId": "domain_main-domain", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<new_main_domain>/main": {"put": {"tags": ["domain"], "operationId": "domain_main-domain_1", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"new_main_domain": {"type": "string", "description": "Change the current main domain"}}, "required": []}}}}}}, "/domain/<domain>/urlavailable": {"get": {"tags": ["domain"], "operationId": "domain_url-available", "summary": "Check availability of a web path", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "The domain for the web path (e.g. your.domain.tld)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "The path to check (e.g. /coffee)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/config": {"get": {"tags": ["domain config"], "operationId": "domain config_get", "summary": "Display a domain configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["domain config"], "operationId": "domain config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name"}, "key": {"type": "string", "description": "The question or form key"}, "value": {"type": "string", "description": "new value"}, "args": {"type": "string", "description": "Serialized arguments for new configuration (i.e. \"mail_in=0&mail_out=0\")"}}, "required": ["domain", "key"]}}}}}}, "/domains/<domain>/dns": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/suggest": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest_1", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/push": {"post": {"tags": ["domain dns"], "operationId": "domain dns_push", "summary": "Push DNS records to registrar", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name to push DNS conf for"}, "dry_run": {"type": "string", "description": "Only display what's to be pushed", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Also update/remove records which were not originally set by Yunohost, or which have been manually modified", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "purge": {"type": "string", "description": "Delete all records", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["domain"]}}}}}}, "/domains/<domain_list>/cert": {"get": {"tags": ["domain cert"], "operationId": "domain cert_status", "summary": "List status of current certificates (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains to check", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["domain cert"], "operationId": "domain cert_install", "summary": "Install Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain_list": {"type": "string", "description": "Domains for which to install the certificates"}, "force": {"type": "string", "description": "Install even if current certificate is not self-signed", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_checks": {"type": "string", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to install. (Not recommended)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "self_signed": {"type": "string", "description": "Install self-signed certificate instead of Let's Encrypt", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/domains/<domain_list>/cert/renew": {"put": {"tags": ["domain cert"], "operationId": "domain cert_renew", "summary": "Renew the Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain_list": {"type": "string", "description": "Domains for which to renew the certificates"}, "force": {"type": "string", "description": "Ignore the validity threshold (30 days)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "email": {"type": "string", "description": "Send an email to root with logs if some renewing fails", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_checks": {"type": "string", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to renew. (Not recommended)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/apps/catalog": {"get": {"tags": ["app"], "operationId": "app_catalog", "summary": "Show the catalog of installable application", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_categories", "in": "query", "description": "Also return a list of app categories", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/manifest": {"get": {"tags": ["app"], "operationId": "app_manifest", "summary": "Return the manifest of a given app from the catalog, or from a remote git repo", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to fetch the manifest of", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps": {"get": {"tags": ["app"], "operationId": "app_list", "summary": "List installed apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "upgradable", "in": "query", "description": "List only apps that can upgrade to a newer version", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["app"], "operationId": "app_install", "summary": "Install apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "Name, local path or git URL of the app to install"}, "label": {"type": "string", "description": "Custom name for the app"}, "args": {"type": "string", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")"}, "no_remove_on_failure": {"type": "string", "description": "Debug option to avoid removing the app on a failed installation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Do not ask confirmation if the app is not safe to use (low quality, experimental or 3rd party)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["app"]}}}}}}, "/apps/<app>": {"get": {"tags": ["app"], "operationId": "app_info", "summary": "Show infos about a specific installed app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "delete": {"tags": ["app"], "operationId": "app_remove", "summary": "Remove app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App to remove", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Also remove all application data", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/map": {"get": {"tags": ["app"], "operationId": "app_map", "summary": "Show the mapping between urls and apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app to map", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "raw", "in": "query", "description": "Return complete dict", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "user", "in": "query", "description": "Allowed app map for a user", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/upgrade": {"put": {"tags": ["app"], "operationId": "app_upgrade", "summary": "Upgrade app", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App(s) to upgrade (default all)"}, "url": {"type": "string", "description": "Git url to fetch for upgrade"}, "file": {"type": "string", "description": "Folder or tarball for upgrade"}, "force": {"type": "string", "description": "Force the update, even though the app is up to date", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_safety_backup": {"type": "string", "description": "Disable the safety backup during upgrade", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/apps/<app>/changeurl": {"put": {"tags": ["app"], "operationId": "app_change-url", "summary": "Change app's URL", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "Target app instance name"}, "domain": {"type": "string", "description": "New app domain on which the application will be moved"}, "path": {"type": "string", "description": "New path at which the application will be moved"}}, "required": ["app"]}}}}}}, "/apps/<app>/settings": {"get": {"tags": ["app"], "operationId": "app_setting", "summary": "Set or get an app setting value", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "Key to get/set", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "Value to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete the key", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/<app>/default": {"put": {"tags": ["app"], "operationId": "app_makedefault", "summary": "Redirect domain root to an app", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name to put on domain root"}, "domain": {"type": "string", "description": "Specific domain to put app on (the app domain by default)"}, "undo": {"type": "string", "description": "Undo redirection", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["app"]}}}}}}, "/apps/<app>/label": {"put": {"tags": ["app"], "operationId": "app_change-label", "summary": "Change app label", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App ID"}, "new_label": {"type": "string", "description": "New app label"}}, "required": ["app", "new_label"]}}}}}}, "/apps/<app>/actions": {"get": {"tags": ["app action"], "operationId": "app action_list", "summary": "List app actions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions/<action>": {"put": {"tags": ["app action"], "operationId": "app action_run", "summary": "Run app action", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name"}, "action": {"type": "string", "description": "action id"}, "args": {"type": "string", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")"}}, "required": ["app", "action"]}}}}}}, "/apps/<app>/config-panel": {"get": {"tags": ["app config"], "operationId": "app config_get", "summary": "Display an app configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/<app>/config": {"put": {"tags": ["app config"], "operationId": "app config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name"}, "key": {"type": "string", "description": "The question or panel key"}, "value": {"type": "string", "description": "new value"}, "args": {"type": "string", "description": "Serialized arguments for new configuration (i.e. \"domain=domain.tld&path=/path\")"}, "args_file": {"type": "string", "description": "YAML or JSON file with key/value couples"}}, "required": ["app", "key"]}}}}}}, "/backups": {"post": {"tags": ["backup"], "operationId": "backup_create", "summary": "Create a backup local archive. If neither --apps or --system are given, this will backup all apps and all system parts. If only --apps if given, this will only backup apps and no system parts. Similarly, if only --system is given, this will only backup system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the backup archive"}, "description": {"type": "string", "description": "Short description of the backup"}, "output_directory": {"type": "string", "description": "Output directory for the backup"}, "methods": {"type": "string", "description": "List of backup methods to apply (copy or tar by default)"}, "system": {"type": "string", "description": "List of system parts to backup (or all if none given)."}, "apps": {"type": "string", "description": "List of application names to backup (or all if none given)"}, "dry_run": {"type": "string", "description": "'Simulate' the backup and return the size details per item to backup", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}, "get": {"tags": ["backup"], "operationId": "backup_list", "summary": "List available local backup archives", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "with_info", "in": "query", "description": "Show backup information for each archive", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/backups/<name>/restore": {"put": {"tags": ["backup"], "operationId": "backup_restore", "summary": "Restore from a local backup archive. If neither --apps or --system are given, this will restore all apps and all system parts in the archive. If only --apps if given, this will only restore apps and no system parts. Similarly, if only --system is given, this will only restore system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the local backup archive"}, "system": {"type": "string", "description": "List of system parts to restore (or all if none is given)"}, "apps": {"type": "string", "description": "List of application names to restore (or all if none is given)"}, "force": {"type": "string", "description": "Force restauration on an already installed system", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["name"]}}}}}}, "/backups/<name>": {"get": {"tags": ["backup"], "operationId": "backup_info", "summary": "Show info about a local backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional backup information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "delete": {"tags": ["backup"], "operationId": "backup_delete", "summary": "Delete a backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the archive to delete", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/download": {"get": {"tags": ["backup"], "operationId": "backup_download", "summary": "(API only) Request to download the file", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/settings": {"get": {"tags": ["settings"], "operationId": "settings_list", "summary": "list all entries of the settings", "description": "", "responses": {"200": {"description": "successful operation"}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset-all", "summary": "reset all settings to their default value", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/settings/<key>": {"get": {"tags": ["settings"], "operationId": "settings_get", "summary": "get an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["settings"], "operationId": "settings_set", "summary": "set an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"key": {"type": "string", "description": "Settings key"}, "value": {"type": "string", "description": "new value"}}, "required": ["key"]}}}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset", "summary": "set an entry value to its default one", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/services/<names>/start": {"put": {"tags": ["service"], "operationId": "service_start", "summary": "Start one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to start"}}, "required": ["names"]}}}}}}, "/services/<names>/stop": {"put": {"tags": ["service"], "operationId": "service_stop", "summary": "Stop one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to stop"}}, "required": ["names"]}}}}}}, "/services/<names>/restart": {"put": {"tags": ["service"], "operationId": "service_restart", "summary": "Restart one or more services. If the services are not running yet, they will be started.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to restart"}}, "required": ["names"]}}}}}}, "/services/<names>/enable": {"put": {"tags": ["service"], "operationId": "service_enable", "summary": "Enable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to enable"}}, "required": ["names"]}}}}}}, "/services/<names>/disable": {"put": {"tags": ["service"], "operationId": "service_disable", "summary": "Disable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to disable"}}, "required": ["names"]}}}}}}, "/services": {"get": {"tags": ["service"], "operationId": "service_status", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>": {"get": {"tags": ["service"], "operationId": "service_status_1", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<name>/log": {"get": {"tags": ["service"], "operationId": "service_log", "summary": "Log every log files of a service", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Service name to log", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall": {"get": {"tags": ["firewall"], "operationId": "firewall_list", "summary": "List all firewall rules", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "raw", "in": "query", "description": "Return the complete YAML dict", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "by_ip_version", "in": "query", "description": "List rules by IP version", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "list_forwarded", "in": "query", "description": "List forwarded ports with UPnP", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/firewall/<protocol>/allow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_allow", "summary": "Allow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"protocol": {"type": "string", "description": "Protocol type to allow (TCP/UDP/Both)", "enum": ["TCP", "UDP", "Both"]}, "port": {"type": "string", "description": "Port or range of ports to open"}, "ipv4_only": {"type": "string", "description": "Only add a rule for IPv4 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "ipv6_only": {"type": "string", "description": "Only add a rule for IPv6 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_upnp": {"type": "string", "description": "Do not add forwarding of this port with UPnP", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_reload": {"type": "string", "description": "Do not reload firewall rules", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["protocol", "port"]}}}}}}, "/firewall/<protocol>/disallow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_disallow", "summary": "Disallow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"protocol": {"type": "string", "description": "Protocol type to allow (TCP/UDP/Both)", "enum": ["TCP", "UDP", "Both"]}, "port": {"type": "string", "description": "Port or range of ports to close"}, "ipv4_only": {"type": "string", "description": "Only remove the rule for IPv4 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "ipv6_only": {"type": "string", "description": "Only remove the rule for IPv6 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "upnp_only": {"type": "string", "description": "Only remove forwarding of this port with UPnP", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_reload": {"type": "string", "description": "Do not reload firewall rules", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["protocol", "port"]}}}}}}, "/firewall/upnp/<action>": {"put": {"tags": ["firewall"], "operationId": "firewall_upnp", "summary": "Manage port forwarding using UPnP", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"action": {"type": "string", "description": "", "enum": ["enable", "disable", "status", "reload"]}, "no_refresh": {"type": "string", "description": "Do not refresh port forwarding", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["action"]}}}}}}, "/adminpw": {"put": {"tags": ["tools"], "operationId": "tools_adminpw", "summary": "Change password of admin and root users", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"new_password": {"type": "string", "description": ""}}, "required": []}}}}}}, "/postinstall": {"post": {"tags": ["tools"], "operationId": "tools_postinstall", "summary": "YunoHost post-install", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "YunoHost main domain"}, "password": {"type": "string", "description": "YunoHost admin password"}, "ignore_dyndns": {"type": "string", "description": "Do not subscribe domain to a DynDNS service", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_password": {"type": "string", "description": "Use this if you really want to set a weak password", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_diskspace": {"type": "string", "description": "Use this if you really want to install YunoHost on a setup with less than 10 GB on the root filesystem", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/update/<target>": {"put": {"tags": ["tools"], "operationId": "tools_update", "summary": "YunoHost update", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"target": {"type": "string", "description": "What to update, \"apps\" (application catalog) or \"system\" (fetch available package upgrades, equivalent to apt update), \"all\" for both", "enum": ["apps", "system", "all"]}}, "required": ["target"]}}}}}}, "/upgrade/<target>": {"put": {"tags": ["tools"], "operationId": "tools_upgrade", "summary": "YunoHost upgrade", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"target": {"type": "string", "description": "What to upgrade, either \"apps\" (all apps) or \"system\" (all system packages)", "enum": ["apps", "system"]}}, "required": ["target"]}}}}}}, "/shutdown": {"put": {"tags": ["tools"], "operationId": "tools_shutdown", "summary": "Shutdown the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"force": {"type": "string", "description": "skip the shutdown confirmation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/reboot": {"put": {"tags": ["tools"], "operationId": "tools_reboot", "summary": "Reboot the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"force": {"type": "string", "description": "skip the reboot confirmation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/regenconf": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Categories to regenerate configuration of (all by default)"}, "with_diff": {"type": "string", "description": "Show differences in case of configuration changes", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Override all manual modifications in configuration files", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "dry_run": {"type": "string", "description": "Show what would have been regenerated", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "list_pending": {"type": "string", "description": "List pending configuration files and exit", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/regenconf/<names>": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf_1", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Categories to regenerate configuration of (all by default)"}, "with_diff": {"type": "string", "description": "Show differences in case of configuration changes", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Override all manual modifications in configuration files", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "dry_run": {"type": "string", "description": "Show what would have been regenerated", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "list_pending": {"type": "string", "description": "List pending configuration files and exit", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/versions": {"get": {"tags": ["tools"], "operationId": "tools_versions", "summary": "Display YunoHost's packages versions", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/migrations": {"get": {"tags": ["tools migrations"], "operationId": "tools migrations_list", "summary": "List migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "pending", "in": "query", "description": "list only pending migrations", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "done", "in": "query", "description": "list only migrations already performed", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["tools migrations"], "operationId": "tools migrations_run", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"targets": {"type": "string", "description": "Migrations to run (all pendings by default)"}, "skip": {"type": "string", "description": "Skip specified migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_rerun": {"type": "string", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "auto": {"type": "string", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "accept_disclaimer": {"type": "string", "description": "Accept disclaimers of migrations (please read them before using this option)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/migrations/<targets>": {"put": {"tags": ["tools migrations"], "operationId": "tools migrations_run_1", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"targets": {"type": "string", "description": "Migrations to run (all pendings by default)"}, "skip": {"type": "string", "description": "Skip specified migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_rerun": {"type": "string", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "auto": {"type": "string", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "accept_disclaimer": {"type": "string", "description": "Accept disclaimers of migrations (please read them before using this option)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/hooks/<action>": {"get": {"tags": ["hook"], "operationId": "hook_list", "summary": "List available hooks for an action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "Action name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "list_by", "in": "query", "description": "Property to list hook by", "required": false, "schema": {"type": "string", "enum": ["name", "priority", "folder"]}, "explode": false}, {"name": "show_info", "in": "query", "description": "Show hook information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs": {"get": {"tags": ["log"], "operationId": "log_list", "summary": "List logs", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "limit", "in": "query", "description": "Maximum number of operations to list (default to 50)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional infos (e.g. operation success) but may significantly increase command time. Consider using --limit in combination with this.", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about operations that are not the main operation but are sub-operations triggered by another ongoing operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs/<path>": {"get": {"tags": ["log"], "operationId": "log_show", "summary": "Display a log content", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file which to display the content", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "(Deprecated, see yunohost log share) Share the full log using yunopaste", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "filter_irrelevant", "in": "query", "description": "Do not show some lines deemed not relevant (like set +x or helper argument parsing)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about sub-operations of this operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs/<path>/share": {"get": {"tags": ["log"], "operationId": "log_share", "summary": "Share the full log on yunopaste (alias to show --share)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file to share", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/categories": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_list", "summary": "List diagnosis categories", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/diagnosis": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_show", "summary": "Show most recents diagnosis results", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to display (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Display additional information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "issues", "in": "query", "description": "Only display issues", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "share", "in": "query", "description": "Share the logs using yunopaste", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Show a human-readable output", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/diagnosis/<category>": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_get", "summary": "Low-level command to fetch raw data and status about a specific diagnosis test", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "category", "in": "query", "description": "Diagnosis category to fetch results from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "item", "in": "query", "description": "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/diagnosis/run": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_run", "summary": "Run diagnosis", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"categories": {"type": "string", "description": "Diagnosis categories to run (all by default)"}, "force": {"type": "string", "description": "Ignore the cached report even if it is still 'fresh'", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "except_if_never_ran_yet": {"type": "string", "description": "Don't run anything if diagnosis never ran yet ... (this is meant to be used by the webadmin)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "email": {"type": "string", "description": "Send an email to root with issues found (this is meant to be used by cron job)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/diagnosis/ignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_ignore", "summary": "Configure some diagnosis results to be ignored and therefore not considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"filter": {"type": "string", "description": "Add a filter. The first element should be a diagnosis category, and other criterias can be provided using the infos from the 'meta' sections in 'yunohost diagnosis show'. For example: 'dnsrecords domain=yolo.test category=xmpp'"}, "list": {"type": "string", "description": "List active ignore filters", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/diagnosis/unignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_unignore", "summary": "Configure some diagnosis results to be unignored and therefore considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"filter": {"type": "string", "description": "Remove a filter (it should be an existing filter as listed with --list)"}}, "required": []}}}}}}}, "components": {"securitySchemes": {"cookieAuth": {"type": "apiKey", "in": "cookie", "name": "session.yunohost.admin"}}}, "security": {"cookieAuth": []}}
\ No newline at end of file
diff --git a/doc/openapi.json b/doc/openapi.json
index 97b408d19..aeb1a83ee 100644
--- a/doc/openapi.json
+++ b/doc/openapi.json
@@ -1 +1 @@
-{"openapi": "3.0.3", "info": {"title": "YunoHost API", "description": "This is the YunoHost API used on all YunoHost instances. This API is essentially used by YunoHost Webadmin.", "version": "11.0.7"}, "servers": [{"url": "https://demo.yunohost.org"}, {"url": "https://ynh.local"}], "tags": [{"name": "user", "description": "Manage users and groups"}, {"name": "user group", "description": "Manage user groups"}, {"name": "user permission", "description": "Manage permissions"}, {"name": "user ssh", "description": "Manage ssh access"}, {"name": "domain", "description": "Manage domains"}, {"name": "domain config", "description": "Domain settings"}, {"name": "domain dns", "description": "Manage domains DNS"}, {"name": "domain cert", "description": "Manage domain certificates"}, {"name": "app", "description": "Manage apps"}, {"name": "app action", "description": "Handle apps actions"}, {"name": "app config", "description": "Applications configuration panel"}, {"name": "backup", "description": "Manage backups"}, {"name": "settings", "description": "Manage YunoHost global settings"}, {"name": "service", "description": "Manage services"}, {"name": "firewall", "description": "Manage firewall rules"}, {"name": "dyndns", "description": "Subscribe and Update DynDNS Hosts"}, {"name": "tools", "description": "Specific tools"}, {"name": "tools migrations", "description": "Manage migrations"}, {"name": "hook", "description": "Manage hooks"}, {"name": "log", "description": "Manage debug logs"}, {"name": "diagnosis", "description": "Look for possible issues on the server"}], "paths": {"/users": {"get": {"tags": ["user"], "operationId": "user_list", "summary": "List users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "fields", "in": "query", "description": "fields to fetch (username, fullname, mail, mail-alias, mail-forward, mailbox-quota, groups, shell, home-path)", "required": true, "schema": {"type": "string"}, "explode": true}]}, "post": {"tags": ["user"], "operationId": "user_create", "summary": "Create user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "The unique username to create", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "firstname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "lastname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "password", "in": "query", "description": "User password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "Domain for the email address and xmpp account", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "mailbox_quota", "in": "query", "description": "Mailbox size quota", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/<username>": {"delete": {"tags": ["user"], "operationId": "user_delete", "summary": "Delete user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Purge user's home and mail directories", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user"], "operationId": "user_update", "summary": "Update user informations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to update", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "firstname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "lastname", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "mail", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "change_password", "in": "query", "description": "New password to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "add_mailforward", "in": "query", "description": "Mailforward addresses to add", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "remove_mailforward", "in": "query", "description": "Mailforward addresses to remove", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "add_mailalias", "in": "query", "description": "Mail aliases to add", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "remove_mailalias", "in": "query", "description": "Mail aliases to remove", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "mailbox_quota", "in": "query", "description": "Mailbox size quota", "required": false, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user"], "operationId": "user_info", "summary": "Get user information", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username or email to get information", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/export": {"get": {"tags": ["user"], "operationId": "user_export", "summary": "Export users into CSV", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/users/import": {"post": {"tags": ["user"], "operationId": "user_import", "summary": "Import several users from CSV", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "csvfile", "in": "query", "description": "CSV file with columns username, firstname, lastname, password, mail, mailbox-quota, mail-alias, mail-forward, groups (separated by coma)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "update", "in": "query", "description": "Update all existing users contained in the CSV file (by default existing users are ignored)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete all existing users that are not contained in the CSV file (by default existing users are kept)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups": {"get": {"tags": ["user group"], "operationId": "user group_list", "summary": "List existing groups", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "short", "in": "query", "description": "List only the names of groups", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all informations known about each groups", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "include_primary_groups", "in": "query", "description": "Also display primary groups (each user has an eponym group that only contains itself)", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["user group"], "operationId": "user group_create", "summary": "Create group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be created", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>": {"delete": {"tags": ["user group"], "operationId": "user group_delete", "summary": "Delete group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be deleted", "required": true, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user group"], "operationId": "user group_info", "summary": "Get information about a specific group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to fetch info about", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>/add/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_add", "summary": "Add users to group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to add user(s) to", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "usernames", "in": "query", "description": "User(s) to add in the group", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/groups/<groupname>/remove/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_remove", "summary": "Remove users from group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to remove user(s) from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "usernames", "in": "query", "description": "User(s) to remove from the group", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/permissions": {"get": {"tags": ["user permission"], "operationId": "user permission_list", "summary": "List permissions and corresponding accesses", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "apps", "in": "query", "description": "Apps to list permission for (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "short", "in": "query", "description": "Only list permission names", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all info known about each permission, including the full user list of each group it is granted to.", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>": {"get": {"tags": ["user permission"], "operationId": "user permission_info", "summary": "Get information about a specific permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Name of the permission to fetch info about (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user permission"], "operationId": "user permission_update", "summary": "Manage group or user permissions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "label", "in": "query", "description": "Label for this permission. This label will be shown on the SSO and in the admin", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "show_tile", "in": "query", "description": "Define if a tile will be shown in the SSO", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["user permission"], "operationId": "user permission_reset", "summary": "Reset allowed groups to the default (all_users) for a given permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>/add/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_add", "summary": "Grant permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "names", "in": "query", "description": "Group or usernames to grant this permission to", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/permissions/<permission>/remove/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_remove", "summary": "Revoke permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "names", "in": "query", "description": "Group or usernames to revoke this permission to", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/users/ssh/keys": {"get": {"tags": ["user ssh"], "operationId": "user ssh_list-keys", "summary": "Show user's authorized ssh keys", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/ssh/key": {"post": {"tags": ["user ssh"], "operationId": "user ssh_add-key", "summary": "Add a new authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be added", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "comment", "in": "query", "description": "Optional comment about the key", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["user ssh"], "operationId": "user ssh_remove-key", "summary": "Remove an authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be removed", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains": {"get": {"tags": ["domain"], "operationId": "domain_list", "summary": "List domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "exclude_subdomains", "in": "query", "description": "Filter out domains that are obviously subdomains of other declared domains", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["domain"], "operationId": "domain_add", "summary": "Create a custom domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name to add", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "dyndns", "in": "query", "description": "Subscribe to the DynDNS service", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>": {"delete": {"tags": ["domain"], "operationId": "domain_remove", "summary": "Delete domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "remove_apps", "in": "query", "description": "Remove apps installed on the domain", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation to remove apps", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/main": {"get": {"tags": ["domain"], "operationId": "domain_main-domain", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<new_main_domain>/main": {"put": {"tags": ["domain"], "operationId": "domain_main-domain_1", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domain/<domain>/urlavailable": {"get": {"tags": ["domain"], "operationId": "domain_url-available", "summary": "Check availability of a web path", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "The domain for the web path (e.g. your.domain.tld)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "The path to check (e.g. /coffee)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/config": {"get": {"tags": ["domain config"], "operationId": "domain config_get", "summary": "Display a domain configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["domain config"], "operationId": "domain config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The question or form key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for new configuration (i.e. \"mail_in=0&mail_out=0\")", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/suggest": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest_1", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/push": {"post": {"tags": ["domain dns"], "operationId": "domain dns_push", "summary": "Push DNS records to registrar", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name to push DNS conf for", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Only display what's to be pushed", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Also update/remove records which were not originally set by Yunohost, or which have been manually modified", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Delete all records", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain_list>/cert": {"get": {"tags": ["domain cert"], "operationId": "domain cert_status", "summary": "List status of current certificates (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains to check", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["domain cert"], "operationId": "domain cert_install", "summary": "Install Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains for which to install the certificates", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Install even if current certificate is not self-signed", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_checks", "in": "query", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to install. (Not recommended)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "self_signed", "in": "query", "description": "Install self-signed certificate instead of Let's Encrypt", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain_list>/cert/renew": {"put": {"tags": ["domain cert"], "operationId": "domain cert_renew", "summary": "Renew the Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains for which to renew the certificates", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Ignore the validity threshold (30 days)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "email", "in": "query", "description": "Send an email to root with logs if some renewing fails", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_checks", "in": "query", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to renew. (Not recommended)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/catalog": {"get": {"tags": ["app"], "operationId": "app_catalog", "summary": "Show the catalog of installable application", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_categories", "in": "query", "description": "Also return a list of app categories", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/manifest": {"get": {"tags": ["app"], "operationId": "app_manifest", "summary": "Return the manifest of a given app from the catalog, or from a remote git repo", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to fetch the manifest of", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps": {"get": {"tags": ["app"], "operationId": "app_list", "summary": "List installed apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "upgradable", "in": "query", "description": "List only apps that can upgrade to a newer version", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["app"], "operationId": "app_install", "summary": "Install apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to install", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "label", "in": "query", "description": "Custom name for the app", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_remove_on_failure", "in": "query", "description": "Debug option to avoid removing the app on a failed installation", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation if the app is not safe to use (low quality, experimental or 3rd party)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>": {"get": {"tags": ["app"], "operationId": "app_info", "summary": "Show infos about a specific installed app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["app"], "operationId": "app_remove", "summary": "Remove app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App to remove", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Also remove all application data", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/map": {"get": {"tags": ["app"], "operationId": "app_map", "summary": "Show the mapping between urls and apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app to map", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "raw", "in": "query", "description": "Return complete dict", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "user", "in": "query", "description": "Allowed app map for a user", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/upgrade": {"put": {"tags": ["app"], "operationId": "app_upgrade", "summary": "Upgrade app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App(s) to upgrade (default all)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "url", "in": "query", "description": "Git url to fetch for upgrade", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "file", "in": "query", "description": "Folder or tarball for upgrade", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Force the update, even though the app is up to date", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_safety_backup", "in": "query", "description": "Disable the safety backup during upgrade", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/changeurl": {"put": {"tags": ["app"], "operationId": "app_change-url", "summary": "Change app's URL", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Target app instance name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "New app domain on which the application will be moved", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "New path at which the application will be moved", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/settings": {"get": {"tags": ["app"], "operationId": "app_setting", "summary": "Set or get an app setting value", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "Key to get/set", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "Value to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete the key", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/default": {"put": {"tags": ["app"], "operationId": "app_makedefault", "summary": "Redirect domain root to an app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name to put on domain root", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "domain", "in": "query", "description": "Specific domain to put app on (the app domain by default)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "undo", "in": "query", "description": "Undo redirection", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/label": {"put": {"tags": ["app"], "operationId": "app_change-label", "summary": "Change app label", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "new_label", "in": "query", "description": "New app label", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions": {"get": {"tags": ["app action"], "operationId": "app action_list", "summary": "List app actions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions/<action>": {"put": {"tags": ["app action"], "operationId": "app action_run", "summary": "Run app action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "action", "in": "query", "description": "action id", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/config-panel": {"get": {"tags": ["app config"], "operationId": "app config_get", "summary": "Display an app configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/config": {"put": {"tags": ["app config"], "operationId": "app config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The question or panel key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args", "in": "query", "description": "Serialized arguments for new configuration (i.e. \"domain=domain.tld&path=/path\")", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "args_file", "in": "query", "description": "YAML or JSON file with key/value couples", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups": {"post": {"tags": ["backup"], "operationId": "backup_create", "summary": "Create a backup local archive. If neither --apps or --system are given, this will backup all apps and all system parts. If only --apps if given, this will only backup apps and no system parts. Similarly, if only --system is given, this will only backup system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the backup archive", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "description", "in": "query", "description": "Short description of the backup", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "output_directory", "in": "query", "description": "Output directory for the backup", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "methods", "in": "query", "description": "List of backup methods to apply (copy or tar by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "system", "in": "query", "description": "List of system parts to backup (or all if none given).", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "apps", "in": "query", "description": "List of application names to backup (or all if none given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "dry_run", "in": "query", "description": "'Simulate' the backup and return the size details per item to backup", "required": false, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["backup"], "operationId": "backup_list", "summary": "List available local backup archives", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "with_info", "in": "query", "description": "Show backup information for each archive", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/restore": {"put": {"tags": ["backup"], "operationId": "backup_restore", "summary": "Restore from a local backup archive. If neither --apps or --system are given, this will restore all apps and all system parts in the archive. If only --apps if given, this will only restore apps and no system parts. Similarly, if only --system is given, this will only restore system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "system", "in": "query", "description": "List of system parts to restore (or all if none is given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "apps", "in": "query", "description": "List of application names to restore (or all if none is given)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Force restauration on an already installed system", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>": {"get": {"tags": ["backup"], "operationId": "backup_info", "summary": "Show info about a local backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional backup information", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["backup"], "operationId": "backup_delete", "summary": "Delete a backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the archive to delete", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/download": {"get": {"tags": ["backup"], "operationId": "backup_download", "summary": "(API only) Request to download the file", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/settings": {"get": {"tags": ["settings"], "operationId": "settings_list", "summary": "list all entries of the settings", "description": "", "responses": {"200": {"description": "successful operation"}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset-all", "summary": "reset all settings to their default value", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/settings/<key>": {"get": {"tags": ["settings"], "operationId": "settings_get", "summary": "get an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string"}, "explode": false}]}, "post": {"tags": ["settings"], "operationId": "settings_set", "summary": "set an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "new value", "required": false, "schema": {"type": "string"}, "explode": false}]}, "delete": {"tags": ["settings"], "operationId": "settings_reset", "summary": "set an entry value to its default one", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/services/<names>/start": {"put": {"tags": ["service"], "operationId": "service_start", "summary": "Start one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to start", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/stop": {"put": {"tags": ["service"], "operationId": "service_stop", "summary": "Stop one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to stop", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/restart": {"put": {"tags": ["service"], "operationId": "service_restart", "summary": "Restart one or more services. If the services are not running yet, they will be started.", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to restart", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/enable": {"put": {"tags": ["service"], "operationId": "service_enable", "summary": "Enable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to enable", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>/disable": {"put": {"tags": ["service"], "operationId": "service_disable", "summary": "Disable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to disable", "required": true, "schema": {"type": "string"}, "explode": true}]}}, "/services": {"get": {"tags": ["service"], "operationId": "service_status", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>": {"get": {"tags": ["service"], "operationId": "service_status_1", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<name>/log": {"get": {"tags": ["service"], "operationId": "service_log", "summary": "Log every log files of a service", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Service name to log", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall": {"get": {"tags": ["firewall"], "operationId": "firewall_list", "summary": "List all firewall rules", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "raw", "in": "query", "description": "Return the complete YAML dict", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "by_ip_version", "in": "query", "description": "List rules by IP version", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_forwarded", "in": "query", "description": "List forwarded ports with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/<protocol>/allow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_allow", "summary": "Allow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "protocol", "in": "query", "description": "Protocol type to allow (TCP/UDP/Both)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "port", "in": "query", "description": "Port or range of ports to open", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "ipv4_only", "in": "query", "description": "Only add a rule for IPv4 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ipv6_only", "in": "query", "description": "Only add a rule for IPv6 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_upnp", "in": "query", "description": "Do not add forwarding of this port with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_reload", "in": "query", "description": "Do not reload firewall rules", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/<protocol>/disallow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_disallow", "summary": "Disallow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "protocol", "in": "query", "description": "Protocol type to allow (TCP/UDP/Both)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "port", "in": "query", "description": "Port or range of ports to close", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "ipv4_only", "in": "query", "description": "Only remove the rule for IPv4 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ipv6_only", "in": "query", "description": "Only remove the rule for IPv6 connections", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "upnp_only", "in": "query", "description": "Only remove forwarding of this port with UPnP", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "no_reload", "in": "query", "description": "Do not reload firewall rules", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall/upnp/<action>": {"put": {"tags": ["firewall"], "operationId": "firewall_upnp", "summary": "Manage port forwarding using UPnP", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "no_refresh", "in": "query", "description": "Do not refresh port forwarding", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/adminpw": {"put": {"tags": ["tools"], "operationId": "tools_adminpw", "summary": "Change password of admin and root users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_password", "in": "query", "description": "", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/postinstall": {"post": {"tags": ["tools"], "operationId": "tools_postinstall", "summary": "YunoHost post-install", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "YunoHost main domain", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "password", "in": "query", "description": "YunoHost admin password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "ignore_dyndns", "in": "query", "description": "Do not subscribe domain to a DynDNS service", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_password", "in": "query", "description": "Use this if you really want to set a weak password", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_diskspace", "in": "query", "description": "Use this if you really want to install YunoHost on a setup with less than 10 GB on the root filesystem", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/update/<target>": {"put": {"tags": ["tools"], "operationId": "tools_update", "summary": "YunoHost update", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "target", "in": "query", "description": "What to update, \"apps\" (application catalog) or \"system\" (fetch available package upgrades, equivalent to apt update), \"all\" for both", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/upgrade/<target>": {"put": {"tags": ["tools"], "operationId": "tools_upgrade", "summary": "YunoHost upgrade", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "target", "in": "query", "description": "What to upgrade, either \"apps\" (all apps) or \"system\" (all system packages)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/shutdown": {"put": {"tags": ["tools"], "operationId": "tools_shutdown", "summary": "Shutdown the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "force", "in": "query", "description": "skip the shutdown confirmation", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/reboot": {"put": {"tags": ["tools"], "operationId": "tools_reboot", "summary": "Reboot the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "force", "in": "query", "description": "skip the reboot confirmation", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/regenconf": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Categories to regenerate configuration of (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "with_diff", "in": "query", "description": "Show differences in case of configuration changes", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Override all manual modifications in configuration files", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Show what would have been regenerated", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_pending", "in": "query", "description": "List pending configuration files and exit", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/regenconf/<names>": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf_1", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Categories to regenerate configuration of (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "with_diff", "in": "query", "description": "Show differences in case of configuration changes", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force", "in": "query", "description": "Override all manual modifications in configuration files", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "dry_run", "in": "query", "description": "Show what would have been regenerated", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "list_pending", "in": "query", "description": "List pending configuration files and exit", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/versions": {"get": {"tags": ["tools"], "operationId": "tools_versions", "summary": "Display YunoHost's packages versions", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/migrations": {"get": {"tags": ["tools migrations"], "operationId": "tools migrations_list", "summary": "List migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "pending", "in": "query", "description": "list only pending migrations", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "done", "in": "query", "description": "list only migrations already performed", "required": false, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["tools migrations"], "operationId": "tools migrations_run", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "targets", "in": "query", "description": "Migrations to run (all pendings by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "skip", "in": "query", "description": "Skip specified migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_rerun", "in": "query", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "auto", "in": "query", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "accept_disclaimer", "in": "query", "description": "Accept disclaimers of migrations (please read them before using this option)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/migrations/<targets>": {"put": {"tags": ["tools migrations"], "operationId": "tools migrations_run_1", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "targets", "in": "query", "description": "Migrations to run (all pendings by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "skip", "in": "query", "description": "Skip specified migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "force_rerun", "in": "query", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "auto", "in": "query", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "accept_disclaimer", "in": "query", "description": "Accept disclaimers of migrations (please read them before using this option)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/hooks/<action>": {"get": {"tags": ["hook"], "operationId": "hook_list", "summary": "List available hooks for an action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "Action name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "list_by", "in": "query", "description": "Property to list hook by", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "show_info", "in": "query", "description": "Show hook information", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs": {"get": {"tags": ["log"], "operationId": "log_list", "summary": "List logs", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "limit", "in": "query", "description": "Maximum number of operations to list (default to 50)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional infos (e.g. operation success) but may significantly increase command time. Consider using --limit in combination with this.", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about operations that are not the main operation but are sub-operations triggered by another ongoing operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs/<path>": {"get": {"tags": ["log"], "operationId": "log_show", "summary": "Display a log content", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file which to display the content", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "(Deprecated, see yunohost log share) Share the full log using yunopaste", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "filter_irrelevant", "in": "query", "description": "Do not show some lines deemed not relevant (like set +x or helper argument parsing)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about sub-operations of this operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/logs/<path>/share": {"get": {"tags": ["log"], "operationId": "log_share", "summary": "Share the full log on yunopaste (alias to show --share)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file to share", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/categories": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_list", "summary": "List diagnosis categories", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/diagnosis": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_show", "summary": "Show most recents diagnosis results", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to display (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Display additional information", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "issues", "in": "query", "description": "Only display issues", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "Share the logs using yunopaste", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Show a human-readable output", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/<category>": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_get", "summary": "Low-level command to fetch raw data and status about a specific diagnosis test", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "category", "in": "query", "description": "Diagnosis category to fetch results from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "item", "in": "query", "description": "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/diagnosis/run": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_run", "summary": "Run diagnosis", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to run (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "force", "in": "query", "description": "Ignore the cached report even if it is still 'fresh'", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "except_if_never_ran_yet", "in": "query", "description": "Don't run anything if diagnosis never ran yet ... (this is meant to be used by the webadmin)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "email", "in": "query", "description": "Send an email to root with issues found (this is meant to be used by cron job)", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/ignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_ignore", "summary": "Configure some diagnosis results to be ignored and therefore not considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "filter", "in": "query", "description": "Add a filter. The first element should be a diagnosis category, and other criterias can be provided using the infos from the 'meta' sections in 'yunohost diagnosis show'. For example: 'dnsrecords domain=yolo.test category=xmpp'", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "list", "in": "query", "description": "List active ignore filters", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/unignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_unignore", "summary": "Configure some diagnosis results to be unignored and therefore considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "filter", "in": "query", "description": "Remove a filter (it should be an existing filter as listed with --list)", "required": false, "schema": {"type": "string"}, "explode": true}]}}}}
\ No newline at end of file
+{"openapi": "3.0.3", "info": {"title": "YunoHost API", "description": "This is the YunoHost API used on all YunoHost instances. This API is essentially used by YunoHost Webadmin.", "version": "11.0.7"}, "servers": [{"url": "https://demo.yunohost.org/yunohost/api"}, {"url": "https://ynh.local/yunohost/api"}], "tags": [{"name": "public", "description": "Public route"}, {"name": "user", "description": "Manage users and groups"}, {"name": "user group", "description": "Manage user groups"}, {"name": "user permission", "description": "Manage permissions"}, {"name": "user ssh", "description": "Manage ssh access"}, {"name": "domain", "description": "Manage domains"}, {"name": "domain config", "description": "Domain settings"}, {"name": "domain dns", "description": "Manage domains DNS"}, {"name": "domain cert", "description": "Manage domain certificates"}, {"name": "app", "description": "Manage apps"}, {"name": "app action", "description": "Handle apps actions"}, {"name": "app config", "description": "Applications configuration panel"}, {"name": "backup", "description": "Manage backups"}, {"name": "settings", "description": "Manage YunoHost global settings"}, {"name": "service", "description": "Manage services"}, {"name": "firewall", "description": "Manage firewall rules"}, {"name": "dyndns", "description": "Subscribe and Update DynDNS Hosts"}, {"name": "tools", "description": "Specific tools"}, {"name": "tools migrations", "description": "Manage migrations"}, {"name": "hook", "description": "Manage hooks"}, {"name": "log", "description": "Manage debug logs"}, {"name": "diagnosis", "description": "Look for possible issues on the server"}], "paths": {"/login": {"post": {"tags": ["public"], "summary": "Logs in and returns the authentication cookie", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"password": {"type": "string", "format": "password"}}, "required": ["password"]}}}}, "security": [], "responses": {"200": {"description": "Successfully login"}}}}, "/users": {"get": {"tags": ["user"], "operationId": "user_list", "summary": "List users", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "fields", "in": "query", "description": "fields to fetch (username, fullname, mail, mail-alias, mail-forward, mailbox-quota, groups, shell, home-path)", "required": true, "schema": {"type": "string"}, "explode": true}]}, "post": {"tags": ["user"], "operationId": "user_create", "summary": "Create user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "The unique username to create"}, "firstname": {"type": "string", "description": ""}, "lastname": {"type": "string", "description": ""}, "password": {"type": "string", "description": "User password"}, "domain": {"type": "string", "description": "Domain for the email address and xmpp account"}, "mailbox_quota": {"type": "string", "description": "Mailbox size quota"}}, "required": ["username"]}}}}}}, "/users/<username>": {"delete": {"tags": ["user"], "operationId": "user_delete", "summary": "Delete user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Purge user's home and mail directories", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["user"], "operationId": "user_update", "summary": "Update user informations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "Username to update"}, "firstname": {"type": "string", "description": ""}, "lastname": {"type": "string", "description": ""}, "mail": {"type": "string", "description": ""}, "change_password": {"type": "string", "description": "New password to set"}, "add_mailforward": {"type": "string", "description": "Mailforward addresses to add"}, "remove_mailforward": {"type": "string", "description": "Mailforward addresses to remove"}, "add_mailalias": {"type": "string", "description": "Mail aliases to add"}, "remove_mailalias": {"type": "string", "description": "Mail aliases to remove"}, "mailbox_quota": {"type": "string", "description": "Mailbox size quota"}}, "required": ["username"]}}}}}, "get": {"tags": ["user"], "operationId": "user_info", "summary": "Get user information", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username or email to get information", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/export": {"get": {"tags": ["user"], "operationId": "user_export", "summary": "Export users into CSV", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/users/import": {"post": {"tags": ["user"], "operationId": "user_import", "summary": "Import several users from CSV", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"csvfile": {"type": "string", "description": "CSV file with columns username, firstname, lastname, password, mail, mailbox-quota, mail-alias, mail-forward, groups (separated by coma)"}, "update": {"type": "string", "description": "Update all existing users contained in the CSV file (by default existing users are ignored)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "delete": {"type": "string", "description": "Delete all existing users that are not contained in the CSV file (by default existing users are kept)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["csvfile"]}}}}}}, "/users/groups": {"get": {"tags": ["user group"], "operationId": "user group_list", "summary": "List existing groups", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "short", "in": "query", "description": "List only the names of groups", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "full", "in": "query", "description": "Display all informations known about each groups", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "include_primary_groups", "in": "query", "description": "Also display primary groups (each user has an eponym group that only contains itself)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["user group"], "operationId": "user group_create", "summary": "Create group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to be created"}}, "required": ["groupname"]}}}}}}, "/users/groups/<groupname>": {"delete": {"tags": ["user group"], "operationId": "user group_delete", "summary": "Delete group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to be deleted", "required": true, "schema": {"type": "string"}, "explode": false}]}, "get": {"tags": ["user group"], "operationId": "user group_info", "summary": "Get information about a specific group", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "groupname", "in": "query", "description": "Name of the group to fetch info about", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/groups/<groupname>/add/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_add", "summary": "Add users to group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to add user(s) to"}, "usernames": {"type": "string", "description": "User(s) to add in the group"}}, "required": ["groupname"]}}}}}}, "/users/groups/<groupname>/remove/<usernames>": {"put": {"tags": ["user group"], "operationId": "user group_remove", "summary": "Remove users from group", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"groupname": {"type": "string", "description": "Name of the group to remove user(s) from"}, "usernames": {"type": "string", "description": "User(s) to remove from the group"}}, "required": ["groupname"]}}}}}}, "/users/permissions": {"get": {"tags": ["user permission"], "operationId": "user permission_list", "summary": "List permissions and corresponding accesses", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "apps", "in": "query", "description": "Apps to list permission for (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "short", "in": "query", "description": "Only list permission names", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "full", "in": "query", "description": "Display all info known about each permission, including the full user list of each group it is granted to.", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/users/permissions/<permission>": {"get": {"tags": ["user permission"], "operationId": "user permission_info", "summary": "Get information about a specific permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Name of the permission to fetch info about (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}, "put": {"tags": ["user permission"], "operationId": "user permission_update", "summary": "Manage group or user permissions", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "label": {"type": "string", "description": "Label for this permission. This label will be shown on the SSO and in the admin"}, "show_tile": {"type": "string", "description": "Define if a tile will be shown in the SSO", "enum": ["True", "False"]}}, "required": ["permission"]}}}}}, "delete": {"tags": ["user permission"], "operationId": "user permission_reset", "summary": "Reset allowed groups to the default (all_users) for a given permission", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "permission", "in": "query", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/permissions/<permission>/add/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_add", "summary": "Grant permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "names": {"type": "string", "description": "Group or usernames to grant this permission to"}}, "required": ["permission"]}}}}}}, "/users/permissions/<permission>/remove/<names>": {"put": {"tags": ["user permission"], "operationId": "user permission_remove", "summary": "Revoke permission to group or user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"permission": {"type": "string", "description": "Permission to manage (e.g. mail or nextcloud or wordpress.editors) (use \"yunohost user permission list\" and \"yunohost user permission -f\" to see all the current permissions)"}, "names": {"type": "string", "description": "Group or usernames to revoke this permission to"}}, "required": ["permission"]}}}}}}, "/users/ssh/keys": {"get": {"tags": ["user ssh"], "operationId": "user ssh_list-keys", "summary": "Show user's authorized ssh keys", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/users/ssh/key": {"post": {"tags": ["user ssh"], "operationId": "user ssh_add-key", "summary": "Add a new authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"username": {"type": "string", "description": "Username of the user"}, "key": {"type": "string", "description": "The key to be added"}, "comment": {"type": "string", "description": "Optional comment about the key"}}, "required": ["username", "key"]}}}}}, "delete": {"tags": ["user ssh"], "operationId": "user ssh_remove-key", "summary": "Remove an authorized ssh key for this user", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "username", "in": "query", "description": "Username of the user", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "The key to be removed", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains": {"get": {"tags": ["domain"], "operationId": "domain_list", "summary": "List domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "exclude_subdomains", "in": "query", "description": "Filter out domains that are obviously subdomains of other declared domains", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["domain"], "operationId": "domain_add", "summary": "Create a custom domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name to add"}, "dyndns": {"type": "string", "description": "Subscribe to the DynDNS service", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["domain"]}}}}}}, "/domains/<domain>": {"delete": {"tags": ["domain"], "operationId": "domain_remove", "summary": "Delete domains", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain to delete", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "remove_apps", "in": "query", "description": "Remove apps installed on the domain", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "force", "in": "query", "description": "Do not ask confirmation to remove apps", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/domains/main": {"get": {"tags": ["domain"], "operationId": "domain_main-domain", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "new_main_domain", "in": "query", "description": "Change the current main domain", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<new_main_domain>/main": {"put": {"tags": ["domain"], "operationId": "domain_main-domain_1", "summary": "Check the current main domain, or change it", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"new_main_domain": {"type": "string", "description": "Change the current main domain"}}, "required": []}}}}}}, "/domain/<domain>/urlavailable": {"get": {"tags": ["domain"], "operationId": "domain_url-available", "summary": "Check availability of a web path", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "The domain for the web path (e.g. your.domain.tld)", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "path", "in": "query", "description": "The path to check (e.g. /coffee)", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/config": {"get": {"tags": ["domain config"], "operationId": "domain config_get", "summary": "Display a domain configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Domain name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["domain config"], "operationId": "domain config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name"}, "key": {"type": "string", "description": "The question or form key"}, "value": {"type": "string", "description": "new value"}, "args": {"type": "string", "description": "Serialized arguments for new configuration (i.e. \"mail_in=0&mail_out=0\")"}}, "required": ["domain", "key"]}}}}}}, "/domains/<domain>/dns": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/suggest": {"get": {"tags": ["domain dns"], "operationId": "domain dns_suggest_1", "summary": "Generate sample DNS configuration for a domain", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain", "in": "query", "description": "Target domain", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/domains/<domain>/dns/push": {"post": {"tags": ["domain dns"], "operationId": "domain dns_push", "summary": "Push DNS records to registrar", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "Domain name to push DNS conf for"}, "dry_run": {"type": "string", "description": "Only display what's to be pushed", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Also update/remove records which were not originally set by Yunohost, or which have been manually modified", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "purge": {"type": "string", "description": "Delete all records", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["domain"]}}}}}}, "/domains/<domain_list>/cert": {"get": {"tags": ["domain cert"], "operationId": "domain cert_status", "summary": "List status of current certificates (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "domain_list", "in": "query", "description": "Domains to check", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["domain cert"], "operationId": "domain cert_install", "summary": "Install Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain_list": {"type": "string", "description": "Domains for which to install the certificates"}, "force": {"type": "string", "description": "Install even if current certificate is not self-signed", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_checks": {"type": "string", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to install. (Not recommended)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "self_signed": {"type": "string", "description": "Install self-signed certificate instead of Let's Encrypt", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/domains/<domain_list>/cert/renew": {"put": {"tags": ["domain cert"], "operationId": "domain cert_renew", "summary": "Renew the Let's Encrypt certificates for given domains (all by default).", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain_list": {"type": "string", "description": "Domains for which to renew the certificates"}, "force": {"type": "string", "description": "Ignore the validity threshold (30 days)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "email": {"type": "string", "description": "Send an email to root with logs if some renewing fails", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_checks": {"type": "string", "description": "Does not perform any check that your domain seems correctly configured (DNS, reachability) before attempting to renew. (Not recommended)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/apps/catalog": {"get": {"tags": ["app"], "operationId": "app_catalog", "summary": "Show the catalog of installable application", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_categories", "in": "query", "description": "Also return a list of app categories", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/manifest": {"get": {"tags": ["app"], "operationId": "app_manifest", "summary": "Return the manifest of a given app from the catalog, or from a remote git repo", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Name, local path or git URL of the app to fetch the manifest of", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps": {"get": {"tags": ["app"], "operationId": "app_list", "summary": "List installed apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "upgradable", "in": "query", "description": "List only apps that can upgrade to a newer version", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["app"], "operationId": "app_install", "summary": "Install apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "Name, local path or git URL of the app to install"}, "label": {"type": "string", "description": "Custom name for the app"}, "args": {"type": "string", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")"}, "no_remove_on_failure": {"type": "string", "description": "Debug option to avoid removing the app on a failed installation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Do not ask confirmation if the app is not safe to use (low quality, experimental or 3rd party)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["app"]}}}}}}, "/apps/<app>": {"get": {"tags": ["app"], "operationId": "app_info", "summary": "Show infos about a specific installed app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details, including the app manifest and various other infos", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "delete": {"tags": ["app"], "operationId": "app_remove", "summary": "Remove app", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App to remove", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "purge", "in": "query", "description": "Also remove all application data", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/map": {"get": {"tags": ["app"], "operationId": "app_map", "summary": "Show the mapping between urls and apps", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "Specific app to map", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "raw", "in": "query", "description": "Return complete dict", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "user", "in": "query", "description": "Allowed app map for a user", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/upgrade": {"put": {"tags": ["app"], "operationId": "app_upgrade", "summary": "Upgrade app", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App(s) to upgrade (default all)"}, "url": {"type": "string", "description": "Git url to fetch for upgrade"}, "file": {"type": "string", "description": "Folder or tarball for upgrade"}, "force": {"type": "string", "description": "Force the update, even though the app is up to date", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_safety_backup": {"type": "string", "description": "Disable the safety backup during upgrade", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/apps/<app>/changeurl": {"put": {"tags": ["app"], "operationId": "app_change-url", "summary": "Change app's URL", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "Target app instance name"}, "domain": {"type": "string", "description": "New app domain on which the application will be moved"}, "path": {"type": "string", "description": "New path at which the application will be moved"}}, "required": ["app"]}}}}}}, "/apps/<app>/settings": {"get": {"tags": ["app"], "operationId": "app_setting", "summary": "Set or get an app setting value", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App ID", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "Key to get/set", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "value", "in": "query", "description": "Value to set", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "delete", "in": "query", "description": "Delete the key", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/<app>/default": {"put": {"tags": ["app"], "operationId": "app_makedefault", "summary": "Redirect domain root to an app", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name to put on domain root"}, "domain": {"type": "string", "description": "Specific domain to put app on (the app domain by default)"}, "undo": {"type": "string", "description": "Undo redirection", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["app"]}}}}}}, "/apps/<app>/label": {"put": {"tags": ["app"], "operationId": "app_change-label", "summary": "Change app label", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App ID"}, "new_label": {"type": "string", "description": "New app label"}}, "required": ["app", "new_label"]}}}}}}, "/apps/<app>/actions": {"get": {"tags": ["app action"], "operationId": "app action_list", "summary": "List app actions", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/apps/<app>/actions/<action>": {"put": {"tags": ["app action"], "operationId": "app action_run", "summary": "Run app action", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name"}, "action": {"type": "string", "description": "action id"}, "args": {"type": "string", "description": "Serialized arguments for app script (i.e. \"domain=domain.tld&path=/path\")"}}, "required": ["app", "action"]}}}}}}, "/apps/<app>/config-panel": {"get": {"tags": ["app config"], "operationId": "app config_get", "summary": "Display an app configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "app", "in": "query", "description": "App name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "key", "in": "query", "description": "A specific panel, section or a question identifier", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Display all details (meant to be used by the API)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "export", "in": "query", "description": "Only export key/values, meant to be reimported using \"config set --args-file\"", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/apps/<app>/config": {"put": {"tags": ["app config"], "operationId": "app config_set", "summary": "Apply a new configuration", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"app": {"type": "string", "description": "App name"}, "key": {"type": "string", "description": "The question or panel key"}, "value": {"type": "string", "description": "new value"}, "args": {"type": "string", "description": "Serialized arguments for new configuration (i.e. \"domain=domain.tld&path=/path\")"}, "args_file": {"type": "string", "description": "YAML or JSON file with key/value couples"}}, "required": ["app", "key"]}}}}}}, "/backups": {"post": {"tags": ["backup"], "operationId": "backup_create", "summary": "Create a backup local archive. If neither --apps or --system are given, this will backup all apps and all system parts. If only --apps if given, this will only backup apps and no system parts. Similarly, if only --system is given, this will only backup system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the backup archive"}, "description": {"type": "string", "description": "Short description of the backup"}, "output_directory": {"type": "string", "description": "Output directory for the backup"}, "methods": {"type": "string", "description": "List of backup methods to apply (copy or tar by default)"}, "system": {"type": "string", "description": "List of system parts to backup (or all if none given)."}, "apps": {"type": "string", "description": "List of application names to backup (or all if none given)"}, "dry_run": {"type": "string", "description": "'Simulate' the backup and return the size details per item to backup", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}, "get": {"tags": ["backup"], "operationId": "backup_list", "summary": "List available local backup archives", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "with_info", "in": "query", "description": "Show backup information for each archive", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/backups/<name>/restore": {"put": {"tags": ["backup"], "operationId": "backup_restore", "summary": "Restore from a local backup archive. If neither --apps or --system are given, this will restore all apps and all system parts in the archive. If only --apps if given, this will only restore apps and no system parts. Similarly, if only --system is given, this will only restore system parts and no apps.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the local backup archive"}, "system": {"type": "string", "description": "List of system parts to restore (or all if none is given)"}, "apps": {"type": "string", "description": "List of application names to restore (or all if none is given)"}, "force": {"type": "string", "description": "Force restauration on an already installed system", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["name"]}}}}}}, "/backups/<name>": {"get": {"tags": ["backup"], "operationId": "backup_info", "summary": "Show info about a local backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional backup information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Print sizes in human readable format", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "delete": {"tags": ["backup"], "operationId": "backup_delete", "summary": "Delete a backup archive", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the archive to delete", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/backups/<name>/download": {"get": {"tags": ["backup"], "operationId": "backup_download", "summary": "(API only) Request to download the file", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Name of the local backup archive", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/settings": {"get": {"tags": ["settings"], "operationId": "settings_list", "summary": "list all entries of the settings", "description": "", "responses": {"200": {"description": "successful operation"}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset-all", "summary": "reset all settings to their default value", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/settings/<key>": {"get": {"tags": ["settings"], "operationId": "settings_get", "summary": "get an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "full", "in": "query", "description": "Show more details", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "post": {"tags": ["settings"], "operationId": "settings_set", "summary": "set an entry value in the settings", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"key": {"type": "string", "description": "Settings key"}, "value": {"type": "string", "description": "new value"}}, "required": ["key"]}}}}}, "delete": {"tags": ["settings"], "operationId": "settings_reset", "summary": "set an entry value to its default one", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "key", "in": "query", "description": "Settings key", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/services/<names>/start": {"put": {"tags": ["service"], "operationId": "service_start", "summary": "Start one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to start"}}, "required": ["names"]}}}}}}, "/services/<names>/stop": {"put": {"tags": ["service"], "operationId": "service_stop", "summary": "Stop one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to stop"}}, "required": ["names"]}}}}}}, "/services/<names>/restart": {"put": {"tags": ["service"], "operationId": "service_restart", "summary": "Restart one or more services. If the services are not running yet, they will be started.", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to restart"}}, "required": ["names"]}}}}}}, "/services/<names>/enable": {"put": {"tags": ["service"], "operationId": "service_enable", "summary": "Enable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to enable"}}, "required": ["names"]}}}}}}, "/services/<names>/disable": {"put": {"tags": ["service"], "operationId": "service_disable", "summary": "Disable one or more services", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Service name to disable"}}, "required": ["names"]}}}}}}, "/services": {"get": {"tags": ["service"], "operationId": "service_status", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<names>": {"get": {"tags": ["service"], "operationId": "service_status_1", "summary": "Show status information about one or more services (all by default)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "names", "in": "query", "description": "Service name to show", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/services/<name>/log": {"get": {"tags": ["service"], "operationId": "service_log", "summary": "Log every log files of a service", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "name", "in": "query", "description": "Service name to log", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}]}}, "/firewall": {"get": {"tags": ["firewall"], "operationId": "firewall_list", "summary": "List all firewall rules", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "raw", "in": "query", "description": "Return the complete YAML dict", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "by_ip_version", "in": "query", "description": "List rules by IP version", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "list_forwarded", "in": "query", "description": "List forwarded ports with UPnP", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/firewall/<protocol>/allow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_allow", "summary": "Allow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"protocol": {"type": "string", "description": "Protocol type to allow (TCP/UDP/Both)", "enum": ["TCP", "UDP", "Both"]}, "port": {"type": "string", "description": "Port or range of ports to open"}, "ipv4_only": {"type": "string", "description": "Only add a rule for IPv4 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "ipv6_only": {"type": "string", "description": "Only add a rule for IPv6 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_upnp": {"type": "string", "description": "Do not add forwarding of this port with UPnP", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_reload": {"type": "string", "description": "Do not reload firewall rules", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["protocol", "port"]}}}}}}, "/firewall/<protocol>/disallow/<port>": {"put": {"tags": ["firewall"], "operationId": "firewall_disallow", "summary": "Disallow connections on a port", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"protocol": {"type": "string", "description": "Protocol type to allow (TCP/UDP/Both)", "enum": ["TCP", "UDP", "Both"]}, "port": {"type": "string", "description": "Port or range of ports to close"}, "ipv4_only": {"type": "string", "description": "Only remove the rule for IPv4 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "ipv6_only": {"type": "string", "description": "Only remove the rule for IPv6 connections", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "upnp_only": {"type": "string", "description": "Only remove forwarding of this port with UPnP", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "no_reload": {"type": "string", "description": "Do not reload firewall rules", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["protocol", "port"]}}}}}}, "/firewall/upnp/<action>": {"put": {"tags": ["firewall"], "operationId": "firewall_upnp", "summary": "Manage port forwarding using UPnP", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"action": {"type": "string", "description": "", "enum": ["enable", "disable", "status", "reload"]}, "no_refresh": {"type": "string", "description": "Do not refresh port forwarding", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": ["action"]}}}}}}, "/adminpw": {"put": {"tags": ["tools"], "operationId": "tools_adminpw", "summary": "Change password of admin and root users", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"new_password": {"type": "string", "description": ""}}, "required": []}}}}}}, "/postinstall": {"post": {"tags": ["tools"], "operationId": "tools_postinstall", "summary": "YunoHost post-install", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {"type": "string", "description": "YunoHost main domain"}, "password": {"type": "string", "description": "YunoHost admin password"}, "ignore_dyndns": {"type": "string", "description": "Do not subscribe domain to a DynDNS service", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_password": {"type": "string", "description": "Use this if you really want to set a weak password", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_diskspace": {"type": "string", "description": "Use this if you really want to install YunoHost on a setup with less than 10 GB on the root filesystem", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/update/<target>": {"put": {"tags": ["tools"], "operationId": "tools_update", "summary": "YunoHost update", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"target": {"type": "string", "description": "What to update, \"apps\" (application catalog) or \"system\" (fetch available package upgrades, equivalent to apt update), \"all\" for both", "enum": ["apps", "system", "all"]}}, "required": ["target"]}}}}}}, "/upgrade/<target>": {"put": {"tags": ["tools"], "operationId": "tools_upgrade", "summary": "YunoHost upgrade", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"target": {"type": "string", "description": "What to upgrade, either \"apps\" (all apps) or \"system\" (all system packages)", "enum": ["apps", "system"]}}, "required": ["target"]}}}}}}, "/shutdown": {"put": {"tags": ["tools"], "operationId": "tools_shutdown", "summary": "Shutdown the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"force": {"type": "string", "description": "skip the shutdown confirmation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/reboot": {"put": {"tags": ["tools"], "operationId": "tools_reboot", "summary": "Reboot the server", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"force": {"type": "string", "description": "skip the reboot confirmation", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/regenconf": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Categories to regenerate configuration of (all by default)"}, "with_diff": {"type": "string", "description": "Show differences in case of configuration changes", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Override all manual modifications in configuration files", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "dry_run": {"type": "string", "description": "Show what would have been regenerated", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "list_pending": {"type": "string", "description": "List pending configuration files and exit", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/regenconf/<names>": {"put": {"tags": ["tools"], "operationId": "tools_regen-conf_1", "summary": "Regenerate the configuration file(s)", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"names": {"type": "string", "description": "Categories to regenerate configuration of (all by default)"}, "with_diff": {"type": "string", "description": "Show differences in case of configuration changes", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force": {"type": "string", "description": "Override all manual modifications in configuration files", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "dry_run": {"type": "string", "description": "Show what would have been regenerated", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "list_pending": {"type": "string", "description": "List pending configuration files and exit", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/versions": {"get": {"tags": ["tools"], "operationId": "tools_versions", "summary": "Display YunoHost's packages versions", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/migrations": {"get": {"tags": ["tools migrations"], "operationId": "tools migrations_list", "summary": "List migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "pending", "in": "query", "description": "list only pending migrations", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "done", "in": "query", "description": "list only migrations already performed", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}, "put": {"tags": ["tools migrations"], "operationId": "tools migrations_run", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"targets": {"type": "string", "description": "Migrations to run (all pendings by default)"}, "skip": {"type": "string", "description": "Skip specified migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_rerun": {"type": "string", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "auto": {"type": "string", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "accept_disclaimer": {"type": "string", "description": "Accept disclaimers of migrations (please read them before using this option)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/migrations/<targets>": {"put": {"tags": ["tools migrations"], "operationId": "tools migrations_run_1", "summary": "Run migrations", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"targets": {"type": "string", "description": "Migrations to run (all pendings by default)"}, "skip": {"type": "string", "description": "Skip specified migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "force_rerun": {"type": "string", "description": "Re-run already-ran specified migration (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "auto": {"type": "string", "description": "Automatic mode, won't run manual migrations (to be used only if you know what you are doing)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "accept_disclaimer": {"type": "string", "description": "Accept disclaimers of migrations (please read them before using this option)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/hooks/<action>": {"get": {"tags": ["hook"], "operationId": "hook_list", "summary": "List available hooks for an action", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "action", "in": "query", "description": "Action name", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "list_by", "in": "query", "description": "Property to list hook by", "required": false, "schema": {"type": "string", "enum": ["name", "priority", "folder"]}, "explode": false}, {"name": "show_info", "in": "query", "description": "Show hook information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs": {"get": {"tags": ["log"], "operationId": "log_list", "summary": "List logs", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "limit", "in": "query", "description": "Maximum number of operations to list (default to 50)", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "with_details", "in": "query", "description": "Show additional infos (e.g. operation success) but may significantly increase command time. Consider using --limit in combination with this.", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about operations that are not the main operation but are sub-operations triggered by another ongoing operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs/<path>": {"get": {"tags": ["log"], "operationId": "log_show", "summary": "Display a log content", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file which to display the content", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "number", "in": "query", "description": "Number of lines to display", "required": false, "schema": {"type": "string"}, "explode": false}, {"name": "share", "in": "query", "description": "(Deprecated, see yunohost log share) Share the full log using yunopaste", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "filter_irrelevant", "in": "query", "description": "Do not show some lines deemed not relevant (like set +x or helper argument parsing)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "with_suboperations", "in": "query", "description": "Include metadata about sub-operations of this operation... (e.g. initializing groups/permissions when installing an app)", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/logs/<path>/share": {"get": {"tags": ["log"], "operationId": "log_share", "summary": "Share the full log on yunopaste (alias to show --share)", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "path", "in": "query", "description": "Log file to share", "required": true, "schema": {"type": "string"}, "explode": false}]}}, "/diagnosis/categories": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_list", "summary": "List diagnosis categories", "description": "", "responses": {"200": {"description": "successful operation"}}}}, "/diagnosis": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_show", "summary": "Show most recents diagnosis results", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "categories", "in": "query", "description": "Diagnosis categories to display (all by default)", "required": false, "schema": {"type": "string"}, "explode": true}, {"name": "full", "in": "query", "description": "Display additional information", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "issues", "in": "query", "description": "Only display issues", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "share", "in": "query", "description": "Share the logs using yunopaste", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}, {"name": "human_readable", "in": "query", "description": "Show a human-readable output", "required": false, "schema": {"type": "string", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "explode": false}]}}, "/diagnosis/<category>": {"get": {"tags": ["diagnosis"], "operationId": "diagnosis_get", "summary": "Low-level command to fetch raw data and status about a specific diagnosis test", "description": "", "responses": {"200": {"description": "successful operation"}}, "parameters": [{"name": "category", "in": "query", "description": "Diagnosis category to fetch results from", "required": true, "schema": {"type": "string"}, "explode": false}, {"name": "item", "in": "query", "description": "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'", "required": false, "schema": {"type": "string"}, "explode": true}]}}, "/diagnosis/run": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_run", "summary": "Run diagnosis", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"categories": {"type": "string", "description": "Diagnosis categories to run (all by default)"}, "force": {"type": "string", "description": "Ignore the cached report even if it is still 'fresh'", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "except_if_never_ran_yet": {"type": "string", "description": "Don't run anything if diagnosis never ran yet ... (this is meant to be used by the webadmin)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}, "email": {"type": "string", "description": "Send an email to root with issues found (this is meant to be used by cron job)", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/diagnosis/ignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_ignore", "summary": "Configure some diagnosis results to be ignored and therefore not considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"filter": {"type": "string", "description": "Add a filter. The first element should be a diagnosis category, and other criterias can be provided using the infos from the 'meta' sections in 'yunohost diagnosis show'. For example: 'dnsrecords domain=yolo.test category=xmpp'"}, "list": {"type": "string", "description": "List active ignore filters", "enum": {"valueType": "LIST", "values": ["true", "false"]}}}, "required": []}}}}}}, "/diagnosis/unignore": {"put": {"tags": ["diagnosis"], "operationId": "diagnosis_unignore", "summary": "Configure some diagnosis results to be unignored and therefore considered as actual issues", "description": "", "responses": {"200": {"description": "successful operation"}}, "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"filter": {"type": "string", "description": "Remove a filter (it should be an existing filter as listed with --list)"}}, "required": []}}}}}}}, "components": {"securitySchemes": {"cookieAuth": {"type": "apiKey", "in": "cookie", "name": "session.yunohost.admin"}}}, "security": {"cookieAuth": []}}
\ No newline at end of file
