{ "openapi": "3.0.3", "info": { "title": "app_api-administration", "version": "0.0.1", "description": "Nextcloud AppAPI", "license": { "name": "AGPL-3.0-or-later" } }, "components": { "securitySchemes": { "basic_auth": { "type": "http", "scheme": "basic" }, "bearer_auth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Capabilities": { "type": "object", "required": [ "app_api" ], "properties": { "app_api": { "type": "object", "required": [ "loglevel", "version" ], "properties": { "loglevel": { "type": "integer", "format": "int64" }, "version": { "type": "string" } } } } }, "Category": { "type": "object", "required": [ "id", "ident", "displayName" ], "properties": { "id": { "type": "string" }, "ident": { "type": "string" }, "displayName": { "type": "string" } } }, "DaemonConfig": { "type": "object", "required": [ "id", "accepts_deploy_id", "name", "display_name", "protocol", "host", "deploy_config" ], "properties": { "id": { "type": "integer", "format": "int64" }, "accepts_deploy_id": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "protocol": { "type": "string" }, "host": { "type": "string" }, "deploy_config": { "type": "object", "additionalProperties": { "type": "object" } } } }, "DaemonConfigWithAppsCount": { "type": "object", "required": [ "id", "accepts_deploy_id", "name", "display_name", "protocol", "host", "deploy_config", "exAppsCount" ], "properties": { "id": { "type": "integer", "format": "int64" }, "accepts_deploy_id": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "protocol": { "type": "string" }, "host": { "type": "string" }, "deploy_config": { "type": "object", "additionalProperties": { "type": "object" } }, "exAppsCount": { "type": "integer", "format": "int64" } } }, "DeployOptions": { "type": "object", "required": [ "environment_variables", "mounts" ], "properties": { "environment_variables": { "type": "object", "additionalProperties": { "type": "string" } }, "mounts": { "type": "array", "items": { "type": "object", "required": [ "hostPath", "containerPath", "readonly" ], "properties": { "hostPath": { "type": "string" }, "containerPath": { "type": "string" }, "readonly": { "type": "boolean" } } } } } }, "ExApp": { "type": "object", "required": [ "id", "name", "version", "enabled", "status" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "enabled": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ExAppStatus" } } }, "ExAppRequestResult": { "type": "object", "required": [ "status_code", "headers", "body" ], "properties": { "status_code": { "type": "integer", "format": "int64" }, "headers": { "type": "object", "additionalProperties": { "type": "object" } }, "body": { "type": "string" } } }, "ExAppStatus": { "type": "object", "required": [ "deploy", "init", "action", "type", "error" ], "properties": { "deploy": { "type": "integer", "format": "int64" }, "init": { "type": "integer", "format": "int64" }, "action": { "type": "string" }, "type": { "type": "string" }, "error": { "type": "string" }, "deploy_start_time": { "type": "integer", "format": "int64" }, "init_start_time": { "type": "integer", "format": "int64" }, "heartbeat_count": { "type": "integer", "format": "int64" } } }, "OCSMeta": { "type": "object", "required": [ "status", "statuscode" ], "properties": { "status": { "type": "string" }, "statuscode": { "type": "integer" }, "message": { "type": "string" }, "totalitems": { "type": "string" }, "itemsperpage": { "type": "string" } } }, "PublicCapabilities": { "type": "object", "required": [ "app_api" ], "properties": { "app_api": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "string" } } } } } } }, "paths": { "/index.php/apps/app_api/admin-config": { "put": { "operationId": "config-set-admin-config", "summary": "Update the AppAPI admin configuration", "description": "This endpoint requires admin access", "tags": [ "config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "values" ], "properties": { "values": { "type": "object", "description": "Configuration key-value pairs to store", "additionalProperties": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Configuration updated", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/categories": { "get": { "operationId": "ex_apps_page-list-categories", "summary": "Get all available App Store categories", "description": "This endpoint requires admin access", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Categories returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/list": { "get": { "operationId": "ex_apps_page-list-apps", "summary": "Get the list of ExApps available in the App Store together with locally installed ones", "description": "This endpoint requires admin access", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "responses": { "200": { "description": "ExApps list returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "apps", "status" ], "properties": { "apps": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "status": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/enable/{appId}/{daemonId}": { "get": { "operationId": "ex_apps_page-enable-app-get", "summary": "Deploy and enable, or just enable, an ExApp", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "daemonId", "in": "path", "description": "Name of the deploy daemon to use", "required": true, "schema": { "type": "string" } }, { "name": "deployOptions", "in": "query", "description": "Deploy options (environment variables, mounts)", "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "update_required": { "type": "boolean" } } } } } } } }, "500": { "description": "ExApp could not be enabled", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "ex_apps_page-enable-app", "summary": "Deploy and enable, or just enable, an ExApp", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "deployOptions": { "type": "object", "default": {}, "description": "Deploy options (environment variables, mounts)", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "daemonId", "in": "path", "description": "Name of the deploy daemon to use", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "update_required": { "type": "boolean" } } } } } } } }, "500": { "description": "ExApp could not be enabled", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/status/{appId}": { "get": { "operationId": "ex_apps_page-get-app-status", "summary": "Get the status of an ExApp, including its initialization information", "description": "This endpoint requires admin access", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExApp status returned", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/logs/{appId}": { "get": { "operationId": "ex_apps_page-get-app-logs", "summary": "Download the container logs of an ExApp", "description": "This endpoint requires admin access", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "tail", "in": "query", "description": "Number of lines to return from the end of the logs, or 'all'", "schema": { "type": "string", "default": "all" } } ], "responses": { "200": { "description": "ExApp logs returned", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/deploy-options/{appId}": { "get": { "operationId": "ex_apps_page-get-app-deploy-options", "summary": "Get the deploy options of an ExApp", "description": "This endpoint requires admin access", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Deploy options returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeployOptions" } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/disable/{appId}": { "get": { "operationId": "ex_apps_page-disable-app", "summary": "Disable an ExApp", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp disabled", "content": { "application/json": { "schema": {} } } }, "500": { "description": "ExApp could not be disabled", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/update/{appId}": { "get": { "operationId": "ex_apps_page-update-app", "summary": "Update an ExApp", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExApp updated", "content": { "application/json": { "schema": {} } } }, "500": { "description": "ExApp could not be updated", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/uninstall/{appId}": { "get": { "operationId": "ex_apps_page-uninstall-app", "summary": "Unregister an ExApp and optionally remove its container and data", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "removeContainer", "in": "query", "description": "Whether to remove the ExApp container", "schema": { "type": "boolean", "default": true } }, { "name": "removeData", "in": "query", "description": "Whether to remove the ExApp data volume", "schema": { "type": "boolean", "default": false } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp uninstalled", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/force": { "post": { "operationId": "ex_apps_page-force", "summary": "Mark an ExApp as compatible with the current Nextcloud version", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "ex_apps_page" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string", "description": "ID of the ExApp" } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Compatibility requirement overwritten", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons": { "get": { "operationId": "daemon_config-get-all-daemon-configs", "summary": "Get all registered deploy daemons together with the number of ExApps each one runs", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Daemons returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "daemons", "default_daemon_config" ], "properties": { "daemons": { "type": "array", "items": { "$ref": "#/components/schemas/DaemonConfigWithAppsCount" } }, "default_daemon_config": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "post": { "operationId": "daemon_config-register-daemon-config", "summary": "Register a new deploy daemon", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "daemonConfigParams" ], "properties": { "daemonConfigParams": { "type": "object", "description": "Daemon configuration parameters", "additionalProperties": { "type": "object" } }, "defaultDaemon": { "type": "boolean", "default": false, "description": "Whether to set the new daemon as the default one" } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Daemon registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "daemonConfig" ], "properties": { "success": { "type": "boolean" }, "daemonConfig": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/DaemonConfig" } ] } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}": { "delete": { "operationId": "daemon_config-unregister-daemon-config", "summary": "Unregister a deploy daemon and remove the ExApps that run on it", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon to remove", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Daemon unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "daemonConfig" ], "properties": { "success": { "type": "boolean" }, "daemonConfig": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/DaemonConfig" } ] } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "put": { "operationId": "daemon_config-update-daemon-config", "summary": "Update a registered deploy daemon", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "daemonConfigParams" ], "properties": { "daemonConfigParams": { "type": "object", "description": "New daemon configuration parameters", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon to update", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Daemon updated", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "daemonConfig" ], "properties": { "success": { "type": "boolean" }, "daemonConfig": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/DaemonConfig" } ] } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}/check": { "post": { "operationId": "daemon_config-verify-daemon-connection", "summary": "Verify the connection to a registered deploy daemon", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon to check", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Connection check result returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/verify_connection": { "post": { "operationId": "daemon_config-check-daemon-connection", "summary": "Check the connection to a deploy daemon from the given parameters", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "daemonParams" ], "properties": { "daemonParams": { "type": "object", "description": "Daemon parameters to check", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Connection check result returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}/add-registry": { "post": { "operationId": "daemon_config-add-daemon-docker-registry", "summary": "Add a Docker registry mapping to a deploy daemon", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "registryMap" ], "properties": { "registryMap": { "type": "object", "description": "Docker registry mapping to add", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Registry added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DaemonConfig" } } } }, "404": { "description": "Daemon config not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "Registry could not be added", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}/remove-registry": { "post": { "operationId": "daemon_config-remove-daemon-docker-registry", "summary": "Remove a Docker registry mapping from a deploy daemon", "description": "This endpoint requires admin access\nThis endpoint requires password confirmation", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "registryMap" ], "properties": { "registryMap": { "type": "object", "description": "Docker registry mapping to remove", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Registry removed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DaemonConfig" } } } }, "404": { "description": "Daemon config not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "Registry could not be removed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}/test_deploy": { "post": { "operationId": "daemon_config-start-test-deploy", "summary": "Start a test deployment on a deploy daemon", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon to deploy on", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Test deploy started", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "404": { "description": "Daemon config not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "Test deploy could not be started", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } }, "delete": { "operationId": "daemon_config-stop-test-deploy", "summary": "Stop the running test deployment", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon the test runs on", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Test deploy stopped", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/index.php/apps/app_api/daemons/{name}/test_deploy/status": { "get": { "operationId": "daemon_config-get-test-deploy-status", "summary": "Get the status of the running test deployment", "description": "This endpoint requires admin access", "tags": [ "daemon_config" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the daemon the test runs on", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Test deploy status returned", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "404": { "description": "Test ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/info/nextcloud_url": { "get": { "operationId": "ocs_ex_app-get-nextcloud-url", "summary": "Get the base URL of this Nextcloud instance", "description": "This endpoint requires admin access", "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Base URL returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "base_url" ], "properties": { "base_url": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/{list}": { "get": { "operationId": "ocs_ex_app-get-ex-apps-list", "summary": "Get a list of registered ExApps", "description": "This endpoint requires admin access", "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "list", "in": "path", "description": "Which ExApps to return", "required": true, "schema": { "type": "string", "default": "enabled", "enum": [ "all", "enabled" ] } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApps list returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExApp" } } } } } } } } }, "400": { "description": "Invalid list type", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/info/{appId}": { "get": { "operationId": "ocs_ex_app-get-ex-app", "summary": "Get information about a registered ExApp", "description": "This endpoint requires admin access", "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp info returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/ExApp" } } } } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/request/{appId}": { "post": { "operationId": "ocs_ex_app-request-to-ex-app", "summary": "Proxy a request from one ExApp to another registered ExApp", "description": "This endpoint requires admin access", "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "route" ], "properties": { "route": { "type": "string", "description": "Route inside the target ExApp to call" }, "userId": { "type": "string", "nullable": true, "default": null, "description": "User to perform the request on behalf of, or null" }, "method": { "type": "string", "default": "POST", "description": "HTTP method to use" }, "params": { "type": "object", "default": {}, "description": "Request parameters", "additionalProperties": { "type": "object" } }, "options": { "type": "object", "default": {}, "description": "Additional request options", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "appId", "in": "path", "description": "ID of the target ExApp", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp response returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ExAppRequestResult" }, { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } ] } } } } } } } }, "400": { "description": "Request to the ExApp failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/request/{appId}/{$userId}": { "post": { "operationId": "ocs_ex_app-ae-request-to-ex-app", "summary": "Proxy a request from one ExApp to another registered ExApp (deprecated alias)", "description": "This endpoint requires admin access", "deprecated": true, "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "route" ], "properties": { "route": { "type": "string", "description": "Route inside the target ExApp to call" }, "userId": { "type": "string", "nullable": true, "default": null, "description": "User to perform the request on behalf of, or null" }, "method": { "type": "string", "default": "POST", "description": "HTTP method to use" }, "params": { "type": "object", "default": {}, "description": "Request parameters", "additionalProperties": { "type": "object" } }, "options": { "type": "object", "default": {}, "description": "Additional request options", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "appId", "in": "path", "description": "ID of the target ExApp", "required": true, "schema": { "type": "string" } }, { "name": "$userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp response returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ExAppRequestResult" }, { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } ] } } } } } } } }, "400": { "description": "Request to the ExApp failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/{appId}/enabled": { "put": { "operationId": "ocs_ex_app-set-ex-app-enabled", "summary": "Enable or disable a registered ExApp", "description": "This endpoint requires admin access", "tags": [ "ocs_ex_app" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "integer", "format": "int64", "description": "New state: 1 to enable, 0 to disable" } } } } } }, "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", "required": true, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "ExApp state changed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "ExApp is already in the requested state or the state change failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "401": { "description": "Current user is not logged in", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Logged in account must be an admin", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } } }, "tags": [ { "name": "ex_apps_page", "description": "ExApps actions controller similar to default one with project-specific changes and additions" }, { "name": "daemon_config", "description": "DaemonConfig actions (for UI)" } ] }