Bump Api
1.0

This is the official Bump.sh API documentation. Obviously created with Bump.sh.

The Bump.sh API is a REST API. It enables you to create, update or preview your API(s) documentation, create stand-alone documentation diffs or validate a documentation definition (currently in OpenAPI or AsyncAPI). Our webhook also lets you get notifications every time a change is introduced in your API.

This is the documentation for version 1.0 of the API. Last update on Apr 13, 2023.

Base URL
https://bump.sh/api/v1

Check the API status

GET /ping

Responds a pong if the API is up and running.

Responses

  • 200

    Success

    Hide response attribute Show response attribute object
    • pong string

      Sentence about ping and pong

  • API is currently down

GET /ping
curl \
 -X GET https://bump.sh/api/v1/ping
Response examples (200)
{
  "pong": "And that's how ping-pong ball is bumped"
}