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

Fetch information of an existing Hub

GET /hubs/{hub_id_or_slug}
Authorization token Basic token

Fetch information of an existing Hub including the list of APIs it contains. The response follows the APIs.json specification

Path parameters

  • hub_id_or_slug string Required

    UUID or slug of a Hub which can be CI deployment settings page of your hub

Responses

  • • 200

    Hub successfully retrieved

    Hide response attributes Show response attributes object
    • name string

      The name of the Hub

    • description string

      The description of the Hub

    • url string

      The public URL of the hub

    • created date

      Creation date of this Hub

    • modified date

      Last udpate date of this Hub

    • apis array[object]

      The list of APIs belonging to this Hub

      Hide apis attributes Show apis attributes
      • id string

        UUID of this API

      • name string

        Name of this API

      • description string

        Description of this API from the latest definition

      • slug string

        Slug of this API

      • url string

        public documentation URL

      • version string

        Version of this API taken from the latest definition

      • properties array[object]

        Extra properties attached to this API

        Hide properties attributes Show properties attributes
        • type string

          Type of the extra property

          Values are x-access-level or x-definition-type.

        • data string

          Content of the extra property

      • created date

        Creation date of this API

      • modified date

        Last udpate date of this API
  • • 404

    Hub not found

GET /hubs/{hub_id_or_slug} 
curl \
 -X GET https://bump.sh/api/v1/hubs/{hub_id_or_slug} \
 -H "Authorization: Token $ACCESS_TOKEN"
Response examples (200) 
{
  "name": "My train company hub",
  "description": "# Welcome to my train company\n\nThis hub contains all APIs belonging to [my train company](https://demo.bump.sh/).\nFeel free to visit the documentation or changes of our APIs lifecycle.\n",
  "url": "https://demo.bump.sh/",
  "created": "2022-01-07",
  "modified": "2022-04-07",
  "apis": [
    {
      "id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
      "name": "Bump",
      "description": "This is the official Bump API documentation. Obviously created with Bump.",
      "slug": "bump",
      "url": "https://developers.bump.sh/",
      "version": "1.0",
      "properties": [
        {
          "type": "x-access-level",
          "data": "string"
        }
      ],
      "created": "2022-01-07",
      "modified": "2022-04-07"
    }
  ]
}