Skip to main content

API Product Documentation Pages

API Products can have custom documentation pages to provide additional context for consumers.

List documentation pages​

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

Create a documentation page​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/docPages" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "quickstart",
    "displayName": "Quick Start Guide",
    "content": "# Quick Start\n\nFollow these steps to get started..."
  }'

Get a documentation page​

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

Update a documentation page​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/docPages/<page-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "quickstart",
    "displayName": "Quick Start Guide (Updated)",
    "content": "# Quick Start\n\nUpdated guide content..."
  }'

Delete a documentation page​

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

Reorder documentation pages​

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