hauerheinrich / typo3_monitor_api
Hauer-Heinrich - TYPO3 monitor api - allows to retrieve various information about the installed TYPO3 cms (response: json).
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:typo3-cms-extension
Requires
- typo3/cms-core: ^12.4.0
Replaces
- typo3-ter/typo3-monitor-api: 1.3.1
README
typo3_monitor_api is a TYPO3 extension. Inspired by zabbix_monitor extension created by (and thanks to) Sven Wappler. typo3_monitor_api extension don't uses zabbix at all and it is not compatible with the zabbix system!
Installation
... like any other TYPO3 extension extensions.typo3.org No TypoScript or PageTs required.
Setup a backend-user (username and password), this user don't need and shouldn't have any rights!!
Usage
domain.tld/typo3-monitor-api/v1/{METHOD}
If required add parameters to the request body as JSON format.
Request
Basic Auth - UserName and UserPassword are from a backend user. format: json (body) Example for method "GetExtensionVersion":
[ { "extensionKey": "news" } ]
Response
format: json
Every response has at least "status", "value" and "message".
Looks like (domain.tld/typo3-monitor-api/v1/GetPHPVersion
):
[ { "status": true, "value": [ { "version": "7.4.27" } ], "message": "" } ]
Methods
get all available methods: domain.tld/typo3-monitor-api/v1/GetAllowedOperations
small list:
- CheckPathExists
- GetApplicationContext
- GetDatabaseAnalyzerSummary
- GetDatabaseVersion
- GetDiskSpace
- GetExtensionList
- GetExtensionVersion
- GetFeatureValue
- GetFileSpoolValue
- GetFilesystemChecksum
- GetInsecureExtensionList
- GetLastExtensionListUpdate
- GetLastSchedulerRun
- GetLogResults
- GetOpCacheStatus
- GetOutdatedExtensionList
- GetPHPVersion
- GetProgramVersion
- GetSystemInfos
- GetTYPO3Version
- GetTotalLogFilesSize
- HasDeprecationLogEnabled
- HasExtensionUpdate
- HasExtensionUpdateList
- HasFailedSchedulerTask
- HasForbiddenUsers
- HasMissingDefaultMailSettings
- HasRemainingUpdates
- HasSecurityUpdate
- HasUpdate
- IOperation
- UpdateMinorTypo3 (HttpMethod: PATCH)
Extension configuration / settings
- api-access.operations.allowedOperations: Allow or disallow specific methods
- api-access.allowedIps: Restrict the endpoint to IP Ranges (e.g. 77.6.178.) or specific IPs. Comma separated lists are possible.
- api-access.blockTime: Duration in minutes that the respective IP should be blocked (e. g. 5 = 5 minutes locked/blocked since last failed attempt)
- api-access.maxCount: how often a request may take place before it is blocked
TODO:
- add better Authentication
- maybe en- decrypt data
Troubleshooting
.htaccess
SetEnvIf Authorization "(.)" HTTP_AUTHORIZATION=$1 or RewriteEngine On RewriteRule . - [e=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
API Request Error
- Unable to call method "getQueryParams" of non-object "request".
-> mostly this comes from TypoScript Conditions like
[traverse(request.getQueryParams(), 'tx_news_pi1/action') == 'detail']
then check the availablitiy of the "request object" too, like[request && traverse(request.getQueryParams(), 'tx_news_pi1/action') == 'detail']
!