Publish
Configuration
Download

Stoplight Docs API

  • Version: 1.0
  • Host: next-api.stoplight.io
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json

Stoplight exposes a simple API that enables you to programmatically publish and unpublish documentation, download build zips, and modify a docs configuration.

Additionally, you can retrieve a documents build list and configuration

This enables more advanced automation and integrations into existing workflows. For example, continuous integrations services such as Travis, Jenkins, and Circle CI.

Authentication

The Stoplight Docs API uses Bearer Authentication (also called token authentication).

You must include an Authorization header when making requests to the API:

Authorization: Bearer <token>

You can generate your Stoplight Access Tokens from User Settings in Stoplight.

For example:

Authorization: Bearer abcdefghijklmnopqrstuvwxyz1234567890