README.md

Vitals for Statamic

You can monitor your installations with this addon on vitals-for-statamic.com.

Provide vitals of your Statamic installation for external usage.

{
	"system": {
		"name": "System name",
		"domain": "https:\/\/site.tld",
		"environment": "production",
		"laravel": "9.6.0",
		"php": "8.1.4",
		"debug": false
	},
	"statamic": {
		"version": "3.3.4",
		"cp_url": "https:\/\/site.tld\/cp",
		"latest_version": "3.4.1",
		"pro": true,
		"antlers_version": "runtime",
		"static_page_cache": "full",
		"update_available": true
	},
	"addons": [
		{
			"name": "Collaboration",
			"package": "statamic\/collaboration",
			"version": "0.4.0",
			"latest_version": "0.4.0",
			"update_available": false
		},
		{
			"name": "Export",
			"package": "youfront\/statamic-export",
			"version": "1.0.1",
			"latest_version": "1.0.3",
			"update_available": true
		}
	],
	"updates_available": 2
}

How to Install

You can search for this addon in the Tools > Addons section of the Statamic control panel and click install, or run the following command from your project root:

composer require marcorieser/statamic-vitals

Configuration

Be sure to generate an access key which is used to authenticate external requests.

php please vitals:generate-key

How to Use

Send a post request to the vitals endpoint https://site.tld/api/statamic-vitals/vitals.

curl --request POST \
  --url https://site.tld/api/statamic-vitals/vitals \
  --header 'Content-Type: application/json' \
  --data '{
	"access_key":"4Vz?xNc_eE&2uqQL"
}'

Parameters

Parameter	Description	Default	Required
access_key	The access key in your .env file	''	*
clear_cache	Whether the vitals should be generated freshly	false