Get the diagnostics report
An anonymised description of this installation to attach to a bug
report: Spree and gem versions, runtime and infrastructure, settings
changed from their defaults, and recent Spree errors by class and code
location. It never contains names, emails, URLs, credentials or error
messages. markdown is the same report ready to paste into a GitHub
issue. Available to signed-in admins who can manage the store; a
secret API key gets a 404.
GET
/
api
/
v3
/
admin
/
diagnostics
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
jwtToken: 'eyJhbGciOi...',
})
// Needs a client created with `jwtToken`: a secret key is refused.
const report = await client.diagnostics.get()
console.log(report.markdown)curl --request GET \
--url http://{defaultHost}/api/v3/admin/diagnostics \
--header 'Authorization: Bearer <token>'{
"spree_version": "6.0.3",
"sections": [
{
"key": "platform",
"title": "Spree",
"rows": [
{
"label": "Version",
"value": "6.0.3"
},
{
"label": "Gems",
"value": "spree_api 6.0.3, spree_core 6.0.3"
},
{
"label": "Other gems built on Spree",
"value": "0"
}
]
},
{
"key": "runtime",
"title": "Runtime",
"rows": [
{
"label": "Ruby",
"value": "4.0.9 (arm64-darwin25)"
},
{
"label": "Rails",
"value": "8.1.4.1"
},
{
"label": "Environment",
"value": "test"
},
{
"label": "Operating system",
"value": "Linux 6.8.0 x86_64"
},
{
"label": "Web server",
"value": "Puma 8.0.2"
}
]
},
{
"key": "infrastructure",
"title": "Infrastructure",
"rows": [
{
"label": "Database",
"value": "sqlite3 3.54.1"
},
{
"label": "Queue adapter",
"value": "test"
},
{
"label": "Cache store",
"value": "null_store"
},
{
"label": "File storage",
"value": "test"
}
]
},
{
"key": "preferences",
"title": "Changed settings",
"rows": []
},
{
"key": "dashboard",
"title": "Dashboard",
"rows": [
{
"label": "@spree/dashboard",
"value": "6.0.4"
}
]
}
],
"errors": [],
"generated_at": "2026-01-15T12:00:00.000Z",
"markdown": "<details>\n<summary>Spree 6.0.3 diagnostics (2026-01-15T12:00:00Z)</summary>\n\n**Spree**\n\n| | |\n| --- | --- |\n| Version | 6.0.3 |\n| Gems | spree_api 6.0.3, spree_core 6.0.3 |\n| Other gems built on Spree | 0 |\n\n**Runtime**\n\n| | |\n| --- | --- |\n| Ruby | 4.0.9 (arm64-darwin25) |\n| Rails | 8.1.4.1 |\n| Environment | test |\n| Operating system | Linux 6.8.0 x86_64 |\n| Web server | Puma 8.0.2 |\n\n**Infrastructure**\n\n| | |\n| --- | --- |\n| Database | sqlite3 3.54.1 |\n| Queue adapter | test |\n| Cache store | null_store |\n| File storage | test |\n\n**Dashboard**\n\n| | |\n| --- | --- |\n| @spree/dashboard | 6.0.4 |\n\n**Recent errors**\n\nNone recorded.\n\n</details>",
"issue_url": "https://github.com/spree/spree/issues/new?template=bug_report.yml&environment=%3Cdetails%3E%0A%3Csummary%3ESpree%206.0.3%20diagnostics%20%282026-01-15T12%3A00%3A00Z%29%3C%2Fsummary%3E%0A%0A%2A%2ASpree%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Version%20%7C%206.0.3%20%7C%0A%7C%20Gems%20%7C%20spree_api%206.0.3%2C%20spree_core%206.0.3%20%7C%0A%7C%20Other%20gems%20built%20on%20Spree%20%7C%200%20%7C%0A%0A%2A%2ARuntime%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Ruby%20%7C%204.0.9%20%28arm64-darwin25%29%20%7C%0A%7C%20Rails%20%7C%208.1.4.1%20%7C%0A%7C%20Environment%20%7C%20test%20%7C%0A%7C%20Operating%20system%20%7C%20Linux%206.8.0%20x86_64%20%7C%0A%7C%20Web%20server%20%7C%20Puma%208.0.2%20%7C%0A%0A%2A%2AInfrastructure%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Database%20%7C%20sqlite3%203.54.1%20%7C%0A%7C%20Queue%20adapter%20%7C%20test%20%7C%0A%7C%20Cache%20store%20%7C%20null_store%20%7C%0A%7C%20File%20storage%20%7C%20test%20%7C%0A%0A%2A%2ADashboard%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20%40spree%2Fdashboard%20%7C%206.0.4%20%7C%0A%0A%2A%2ARecent%20errors%2A%2A%0A%0ANone%20recorded.%0A%0A%3C%2Fdetails%3E",
"issue_prefilled": true
}{
"error": {
"code": "authentication_required",
"message": "Authentication required"
}
}Query Parameters
Was this page helpful?
⌘I
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
jwtToken: 'eyJhbGciOi...',
})
// Needs a client created with `jwtToken`: a secret key is refused.
const report = await client.diagnostics.get()
console.log(report.markdown)curl --request GET \
--url http://{defaultHost}/api/v3/admin/diagnostics \
--header 'Authorization: Bearer <token>'{
"spree_version": "6.0.3",
"sections": [
{
"key": "platform",
"title": "Spree",
"rows": [
{
"label": "Version",
"value": "6.0.3"
},
{
"label": "Gems",
"value": "spree_api 6.0.3, spree_core 6.0.3"
},
{
"label": "Other gems built on Spree",
"value": "0"
}
]
},
{
"key": "runtime",
"title": "Runtime",
"rows": [
{
"label": "Ruby",
"value": "4.0.9 (arm64-darwin25)"
},
{
"label": "Rails",
"value": "8.1.4.1"
},
{
"label": "Environment",
"value": "test"
},
{
"label": "Operating system",
"value": "Linux 6.8.0 x86_64"
},
{
"label": "Web server",
"value": "Puma 8.0.2"
}
]
},
{
"key": "infrastructure",
"title": "Infrastructure",
"rows": [
{
"label": "Database",
"value": "sqlite3 3.54.1"
},
{
"label": "Queue adapter",
"value": "test"
},
{
"label": "Cache store",
"value": "null_store"
},
{
"label": "File storage",
"value": "test"
}
]
},
{
"key": "preferences",
"title": "Changed settings",
"rows": []
},
{
"key": "dashboard",
"title": "Dashboard",
"rows": [
{
"label": "@spree/dashboard",
"value": "6.0.4"
}
]
}
],
"errors": [],
"generated_at": "2026-01-15T12:00:00.000Z",
"markdown": "<details>\n<summary>Spree 6.0.3 diagnostics (2026-01-15T12:00:00Z)</summary>\n\n**Spree**\n\n| | |\n| --- | --- |\n| Version | 6.0.3 |\n| Gems | spree_api 6.0.3, spree_core 6.0.3 |\n| Other gems built on Spree | 0 |\n\n**Runtime**\n\n| | |\n| --- | --- |\n| Ruby | 4.0.9 (arm64-darwin25) |\n| Rails | 8.1.4.1 |\n| Environment | test |\n| Operating system | Linux 6.8.0 x86_64 |\n| Web server | Puma 8.0.2 |\n\n**Infrastructure**\n\n| | |\n| --- | --- |\n| Database | sqlite3 3.54.1 |\n| Queue adapter | test |\n| Cache store | null_store |\n| File storage | test |\n\n**Dashboard**\n\n| | |\n| --- | --- |\n| @spree/dashboard | 6.0.4 |\n\n**Recent errors**\n\nNone recorded.\n\n</details>",
"issue_url": "https://github.com/spree/spree/issues/new?template=bug_report.yml&environment=%3Cdetails%3E%0A%3Csummary%3ESpree%206.0.3%20diagnostics%20%282026-01-15T12%3A00%3A00Z%29%3C%2Fsummary%3E%0A%0A%2A%2ASpree%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Version%20%7C%206.0.3%20%7C%0A%7C%20Gems%20%7C%20spree_api%206.0.3%2C%20spree_core%206.0.3%20%7C%0A%7C%20Other%20gems%20built%20on%20Spree%20%7C%200%20%7C%0A%0A%2A%2ARuntime%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Ruby%20%7C%204.0.9%20%28arm64-darwin25%29%20%7C%0A%7C%20Rails%20%7C%208.1.4.1%20%7C%0A%7C%20Environment%20%7C%20test%20%7C%0A%7C%20Operating%20system%20%7C%20Linux%206.8.0%20x86_64%20%7C%0A%7C%20Web%20server%20%7C%20Puma%208.0.2%20%7C%0A%0A%2A%2AInfrastructure%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20Database%20%7C%20sqlite3%203.54.1%20%7C%0A%7C%20Queue%20adapter%20%7C%20test%20%7C%0A%7C%20Cache%20store%20%7C%20null_store%20%7C%0A%7C%20File%20storage%20%7C%20test%20%7C%0A%0A%2A%2ADashboard%2A%2A%0A%0A%7C%20%7C%20%7C%0A%7C%20---%20%7C%20---%20%7C%0A%7C%20%40spree%2Fdashboard%20%7C%206.0.4%20%7C%0A%0A%2A%2ARecent%20errors%2A%2A%0A%0ANone%20recorded.%0A%0A%3C%2Fdetails%3E",
"issue_prefilled": true
}{
"error": {
"code": "authentication_required",
"message": "Authentication required"
}
}
