Skip to main content

API Documentation Pages

You can attach custom documentation pages to APIs to provide additional context, guides, or references beyond the API specification.

List documentation pages​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages" \
  -H "Authorization: Bearer <your-token>"

Create a documentation page​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "getting-started",
    "displayName": "Getting Started",
    "content": "# Getting Started\n\nThis guide helps you get started with the API..."
  }'

Get a documentation page​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages/<page-id>" \
  -H "Authorization: Bearer <your-token>"

Update a documentation page​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages/<page-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "getting-started",
    "displayName": "Getting Started Guide",
    "content": "# Getting Started Guide\n\nUpdated content..."
  }'

Delete a documentation page​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages/<page-id>" \
  -H "Authorization: Bearer <your-token>"

Reorder documentation pages​

Change the display order of documentation pages:

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/docPages/order" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '["<page-id-1>", "<page-id-2>", "<page-id-3>"]'

Git-synced documentation​

Documentation pages can be configured to sync from a Git repository. See API Git Integration for details.