1 line
110 KiB
JSON
1 line
110 KiB
JSON
|
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"/api"}],"paths":{"/apps/status":{"get":{"tags":["Apps"],"summary":"Get the status of all available apps.","operationId":"apps_status_apps_status_get","responses":{"200":{"description":"\nReturns a JSON list with the current status of all available apps\n```\n{\n \"data\": [\n {\n \"id\": \"btcpayserver\",\n \"version\": \"v1.13.0\",\n \"installed\": false,\n \"configured\": false,\n \"status\": \"offline\",\n \"local_ip\": null,\n \"http_port\": null,\n \"https_port\": null,\n \"https_forced\": null,\n \"https_self_signed\": null,\n \"hidden_service\": null,\n \"address\": null,\n \"auth_method\": null,\n \"details\": null,\n \"error\": null\n },\n {\n \"id\": \"btc-rpc-explorer\",\n \"version\": \"v3.4.0\",\n \"installed\": false,\n \"configured\": false,\n \"status\": \"offline\",\n \"local_ip\": null,\n ...\n },\n ...\n ],\n \"errors\": [\n {\n \"id\": \"rtl\",\n \"error\": \"App status script execution failed.\n├╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10\n├╴script_name: /home/admin/config.scripts/bonus.rtl.sh status\n│\n╰─▶ 500: Something went wrong!\n ╰╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10\"\n },\n ...\n ]\n}\n```\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppStatusQueryResult"}}}}},"security":[{"JWTBearer":[]}]}},"/apps/update-cache":{"post":{"tags":["Apps"],"summary":"Update the app status cache. Results will be broadcasted to SSE clients.","operationId":"apps_update_cache_apps_update_cache_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/apps/status/{id}":{"get":{"tags":["Apps"],"summary":"Get the status of a single app by id.","operationId":"apps_status_apps_status__id__get","security":[{"JWTBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppStatus"}}}},"404":{"description":"If no or an invalid app id is given."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/apps/status_advanced/{id}":{"get":{"tags":["Apps"],"summary":"Get the advanced status of a single app by id.","description":"Some apps might give status information that is computationally\n to expensive to include in the normal status endpoint.\n\n Available app ids for this endpoint:\n - electrs\n\n> ℹ️ _This endpoint is not implemented on all platforms_","operationId":"apps_status_advanced_apps_status_advanced__id__get","security":[{"JWTBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","required":true,"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"If no or an invalid app id is given."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/apps/install/{app_id}":{"post":{"tags":["Apps"],"summary":"Install an app","description":"Attempts to install an app. The installation process results are\n not returned on this endpoint. Instead, the results are communicated via the SSE\n channels. This call only verifies if the app is available for installation on the\n given platform.","operationId":"apps_install_apps_install__app_id__post","security":[{"JWTBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppId"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"If the app is already installed or not available for
|