Readme

API Endpoints

Create beautiful product and API documentation with our developer friendly platform.

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Create beautiful product and API documentation with our developer friendly platform.

Endpoints 31

Projects

  • GETGet metadata about the current project/Returns project data for API key

API Specification

  • GETgetAPISpecification/api-specification?perPage=10&page=1Get API specification metadata
  • POSTuploadAPISpecification/api-specificationUpload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/automatically-sync-api-specification-with-github
  • PUTupdateAPISpecification/api-specification/:idUpdate an API specification in ReadMe
  • DELETEdeleteAPISpecification/api-specification/:idDelete an API specification in ReadMe

Categories

  • GETGet category/categories/:slugReturns the category with this slug
  • GETGet docs for category/categories/:slug/docsReturns the docs and children docs within this category

Changelog

  • GETGet changelogs/changelogs?perPage=10&page=1Returns a list of changelogs associated with the project API key
  • POSTCreate changelog/changelogsCreate a new changelog inside of this project
  • GETGet changelog/changelogs/:slugReturns the changelog with this slug
  • PUTUpdate changelog/changelogs/:slugUpdate a changelog with this slug
  • DELETEDelete changelog/changelogs/:slugDelete the changelog with this slug

Custom Pages

  • GETGet custom pages/custompages?perPage=10&page=1Returns a list of custom pages associated with the project API key
  • POSTCreate custom page/custompagesCreate a new custom page inside of this project
  • GETGet custom page/custompages/:slugReturns the custom page with this slug
  • PUTUpdate custom page/custompages/:slugUpdate a custom page with this slug
  • DELETEDelete custom page/custompages/:slugDelete the custom page with this slug

Docs

  • POSTCreate doc/docsCreate a new doc inside of this project
  • POSTSearch docs/docs/search?search=stringReturns all docs that match the search
  • GETGet doc/docs/:slugReturns the doc with this slug
  • PUTUpdate doc/docs/:slugUpdate a doc with this slug
  • DELETEDelete doc/docs/:slugDelete the doc with this slug

Errors

  • GETGet errors/errorsReturns with all of the error page types for this project

Swagger

  • POSTuploadSwagger/swaggerDeprecated. DEPRECATED. Instead use https://docs.readme.com/developers/reference/api-specification#uploadapispecification to upload a Swagger file to ReadMe
  • PUTupdateSwagger/swagger/:idDeprecated. DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#updateapispecification to update a Swagger file.
  • DELETEdeleteSwagger/swagger/:idDeprecated. DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#deleteapispecification to delete a Swagger file in ReadMe

Version

  • GETGet versions/versionRetrieve a list of versions associated with a project API key
  • POSTCreate version/versionCreate a new version
  • GETGet version/version/:versionIdReturns the version with this version ID
  • PUTUpdate version/version/:versionIdUpdate an existing version
  • DELETEDelete version/version/:versionIdDelete a version

API details

Base URL
https://dash.readme.io/api/v1
Authentication
HTTP Basic authentication (username and password)
Operations
31 operations on 17 pathsGET 12POST 7PUT 6DELETE 6
3 marked deprecated
Main resources
Changelog 5Custom Pages 5Docs 5Version 5API Specification 4Swagger 3Categories 2Errors 1Projects 1
Description format
OpenAPI 3.0.2, API version 2.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the API Endpoints in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the API Endpoints collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get metadata about the current project” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the API Endpoints?

Create beautiful product and API documentation with our developer friendly platform. It is listed under Developer tools and has 31 endpoints.

Who publishes the API Endpoints?

It is listed from Readme's public API description (an OpenAPI document), not published by Readme on Swastik Codes. Anyone who controls readme.io can claim the profile by adding a DNS TXT record.

What is the base URL of the API Endpoints?

Requests go to https://dash.readme.io/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the API Endpoints?

With HTTP Basic authentication (username and password).

How many endpoints does the API Endpoints have?

31 operations on 17 paths (12 GET, 7 POST, 6 PUT, 6 DELETE). The largest groups are Changelog, Custom Pages, Docs, Version.

Is forking the API Endpoints free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.