FAQ
Frequently asked questions about Apifolio, the OpenAPI and Swagger viewer for Confluence: data, Try it out, formats, Git, public spaces, migration, AI and pricing.
Data and security
Does my spec leave Confluence?
No. Apifolio runs on Atlassian's Forge platform and carries the "Runs on Atlassian" badge: it never sends data to external servers. Specs are read from Confluence as the current user, so page permissions apply. See Security.
Does Apifolio store my API keys or tokens?
No. Code samples use placeholders such as YOUR_TOKEN. What a reader types in Edit request stays in that browser tab's memory and is gone when the editor closes.
Does Apifolio use AI on my data?
Apifolio itself calls no AI service. Copy for AI copies Markdown to your clipboard. The optional Rovo agent runs on Rovo, Atlassian's AI, with your organization's Rovo setup. See AI features.
Using Apifolio
Why is there no "Try it out" button?
Live requests would send data, and often credentials, from Confluence to your API servers, outside Atlassian. Instead, Edit request fills in a ready-to-run request in 17 languages, and you run it in your own tools. See What Apifolio does not do, and why.
Which formats are supported?
OpenAPI 3.0, 3.1 and 3.2 and Swagger 2.0, in YAML or JSON, up to 25 MB. See Supported OpenAPI features.
Which code languages are there?
17: cURL, JavaScript, Python, Go, Java, C#, PHP and Ruby by default, plus PowerShell, cURL for the Windows command prompt, HTTPie, raw HTTP, Node (axios), Python (httpx), Kotlin, Swift and Rust. Editors choose the tabs and their order. See Code samples.
Can I show the same spec on several pages?
Yes. Attach it once, and in the other macros choose Another page and paste the link of the page that holds it (⋯ → Embed this API on another page copies that link). Every page shows the current version of the file.
Can I show just one endpoint in a guide?
Yes. In the macro dialog, pick the endpoint under Only these endpoints. With 1 to 3 endpoints, the macro becomes a compact card.
Can I keep the spec in Git?
Yes. Upload new versions from your CI pipeline. See Keep the docs in sync.
Why doesn't Confluence search find every endpoint of my big API?
The search index of one macro holds 6,000 characters. The macro dialog shows how many endpoints it covers; split a very large API over several macros to cover them all. See Confluence search.
Does it work in public spaces?
Yes, for spec files attached to the same page, up to about 4 MB. Confluence public links don't show app content: use Copy as Confluence content there. See Public spaces.
Moving to Apifolio
We use a Connect app that is being retired. Can we switch?
Yes. Atlassian ends Connect support on 31 January 2027. Insert Apifolio on the page: the dialog imports the old OpenAPI or Swagger macro's spec and display options, and never copies stored credentials. See Moving from another app.
Pricing and support
How much does it cost?
Free for sites with up to 10 users. Larger sites pay per user through the Atlassian Marketplace, with a 30-day free trial. See pricing.
How do I get support?
Write to [email protected]. See the support policy.