Download the PHP package hauerheinrich/typo3_monitor_api without Composer
On this page you can find all versions of the php package hauerheinrich/typo3_monitor_api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package typo3_monitor_api
typo3_monitor_api
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":
Response
format: json
Every response has at least "status", "value" and "message".
Looks like (domain.tld/typo3-monitor-api/v1/GetPHPVersion):
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']!
