Skip to content

docs: explain file downloads with checkly api - #537

Open
sbezludny wants to merge 1 commit into
mainfrom
codex/api-download-docs
Open

sbezludny wants to merge 1 commit into
mainfrom
codex/api-download-docs

Conversation

@sbezludny

Copy link
Copy Markdown
Contributor

Downloading a ZIP with checkly api can now preserve the response bytes. Add a download example and explain when responses are formatted as JSON, when bodies are streamed unchanged, and how --jq and --include affect the output.

Depends on checkly/checkly-cli#1502. Keep this PR in draft until the CLI behavior is released.

Validation: ran the exact npx checkly api /path/to/file > report.zip example against a local HTTP server with the fixed CLI, compared the saved bytes with the source ZIP, and passed unzip -t. The repository frontmatter check and git diff --check also pass. Mintlify preview and full site checks are left to CI.

@mintlify

mintlify Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 1, 2026, 7:31 PM

This branch was successfully deployed

1 active deployment
staging — 5ce9210b Deployed Oct 1, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant