Beacon

List all documentation pages

GEThttps://example.com/api/v1/docs.json

Returns the metadata for every page, sorted by slug.

Responses

200

Metadata for every page

Content type: application/json

  • docsarray<object>Required
    Show Child Attributes
    • slugstringRequired
    • titlestringRequired
    • descriptionstringRequired
    • urlstring (uri)Required
    • markdownUrlstring (uri)Required
    • apiUrlstring (uri)Required
{
  "docs": [
    {
      "slug": "quickstart",
      "title": "Quickstart",
      "description": "Create a site and deploy it.",
      "url": "https://example.com/quickstart",
      "markdownUrl": "https://example.com/quickstart.md",
      "apiUrl": "https://example.com/api/v1/docs/quickstart.json"
    }
  ]
}

Code samples

curl --request GET \
  --url 'https://example.com/api/v1/docs.json'