Bump.sh API documentation

Toggle dark mode

API Changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Topics

Introduction
Authentication

Endpoints

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

Webhooks

Documentation change
- Structure change
  POST

Powered by Bump.sh

Branches

Manage branches of a given documentation

External documentation