Skip to main content

​
Endpoint

GET /api/all-docs-paths
Returns an array of documentation path objects for all products, or for a filtered subset of products when the products query parameter is provided. dev-portal uses this endpoint to discover all available documentation pages at build time.
Visit http://localhost:8080/api/all-docs-paths to verify the unified docs API container has finished initializing. The endpoint returns data only after the content processing step completes on startup.

​
Query parameters

​
products
string[]
One or more product slugs to filter results. When omitted, paths for all configured products are returned.Repeat the parameter to include multiple products: ?products=terraform-plugin-framework&products=terraform-enterpriseThe legacy alias ptfe-releases is automatically mapped to terraform-enterprise.

​
Example requests

curl http://localhost:8080/api/all-docs-paths

​
Response

Returns a JSON object with a result array. Each element in the array represents a single documentation page path.
200
{
  "result": [
    {
      "path": "terraform-plugin-framework/plugin/framework",
      "itemPath": "plugin/framework",
      "created_at": "2023-05-12T00:00:00Z"
    },
    {
      "path": "terraform-plugin-framework/plugin/functions",
      "itemPath": "plugin/functions",
      "created_at": "2023-06-01T00:00:00Z"
    }
  ]
}

​
Response fields

​
result
object[]
required
Array of path objects for all matching documentation pages.

​
Error responses

StatusBodyCause
404Not foundNone of the requested product slugs could be resolved, or no paths exist for any of the specified products.

Build docs developers (and LLMs) love

Get started for freeTalk to us