Logo

First steps

  • Read the Docs tutorial
  • Getting Started with Sphinx
  • Getting Started with MkDocs
  • Importing Your Documentation
  • Choosing Between Our Two Platforms

Features

  • Main Features
  • Configuration File
  • VCS Integrations
  • Custom Domains
  • Versioned Documentation
  • Downloadable Documentation
  • Documentation Hosting Features
  • Server Side Search
  • Traffic Analytics
  • Preview Documentation from Pull Requests
  • Build Notifications and Webhooks
  • Security Log
  • Connecting Your VCS Account
  • Build process
  • Build customization
  • Environment Variables
  • Badges
  • Site Support
  • Frequently Asked Questions

How-to Guides

  • Guides for documentation authors
  • Guides for project administrators
  • Guides for developers and designers
  • Example projects

Advanced features

  • Subprojects
  • Single Version Documentation
  • Flyout Menu
  • Feature Flags
  • Localization of Documentation
  • User-defined Redirects
  • Automatic Redirects
  • Automation Rules
  • Canonical URLs
  • Public API
    • API v3
    • API v2

Read the Docs for Business

  • Read the Docs for Business
  • Organizations
  • Project Privacy Level
  • Sharing
  • Single Sign-On

About Read the Docs

  • Security
  • DMCA Takedown Policy
  • Policy for Abandoned Projects
  • Changelog
  • About Read the Docs
  • Read the Docs Team
  • Read the Docs Open Source Philosophy
  • The Story of Read the Docs
  • Advertising
  • Sponsors of Read the Docs
  • Legal Documents and Policies
  • Developer Documentation
  • Glossary
  • Google Summer of Code
Read the Docs user documentation
  • »
  • Public API
  • Edit on GitHub

Public APIΒΆ

This section of the documentation details the public API usable to get details of projects, builds, versions and other details from Read the Docs.

  • API v3
    • Authentication and authorization
      • Token
      • Session
    • Resources
      • Projects
      • Versions
      • Builds
      • Subprojects
      • Translations
      • Redirects
      • Environment Variables
      • Organizations
      • Remote Organizations
      • Remote Repositories
    • Embed
    • Additional APIs
  • API v2
    • Authentication and authorization
    • Resources
      • Projects
      • Versions
      • Builds
      • Embed
      • Undocumented resources and endpoints
Previous Next

© Copyright 2010, Read the Docs, Inc & contributors. Revision a2ca1afe.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds