Bump API documentation

Toggle dark mode

API Changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Topics

Introduction
Authentication

Endpoints

Diffs
- POST
  Create a diff
- GET
  Fetch detailed information from an existing diff
Ping
- GET
  Check the API status
Previews
- POST
  Create a preview
- PUT
  Update an existing preview
Versions
- POST
  Create a new version
- GET
  Fetch a full documentation version including diff summary
Validations
- POST
  Validate a documentation definition
Hubs
- GET
  Fetch information of an existing Hub

Webhooks

Documentation change
- POST
  Structure change

Powered by Bump.sh

Previews