Health check PDF reports – Configly Help Centre

Overview

Download a formatted PDF version of a health check report. The PDF provides a printable summary suitable for sharing with stakeholders or archiving outside Configly.

Request

curl "https://api.configly.app/v1/connections/{connectionId}/health-check/pdf?tier=solo" \
  -H "Authorization: Bearer cly_your_key" \
  -o health-check-report.pdf

Query parameter	Type	Default	Description
`tier`	string	`solo`	Report tier: `solo`, `multi-instance`, or `agency`
`reportId`	string	latest	ID of a specific report to render. Defaults to the most recent report.

Response

The response is a raw PDF file, not the standard JSON envelope used by other endpoints.

Content-Type: application/pdf
Content-Disposition: attachment; filename="health-check-report-{tier}.pdf"

Binary response

This endpoint returns a raw PDF file. If you are using a JSON-based HTTP client, ensure you handle the response as a binary stream rather than parsing it as JSON.

Tier gating

Available tiers: Solo Multi-Instance Agency

Each subscription plan can only download PDF tiers at or below its own level:

Solo can download the solo tier only.
Multi-Instance can download solo and multi-instance.
Agency can download all three tiers.

Requesting a tier above your plan level returns 403 FORBIDDEN.

Error codes

Status	Code	Description
400	`VALIDATION_ERROR`	Invalid `tier` value
403	`FORBIDDEN`	Requested tier is above your subscription plan
404	`NOT_FOUND`	No health check reports found for this connection

For running and fetching health checks, see Running health checks.

Related to