API Endpoints API

by readme.io

Overview

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

API Endpoints is a development API from readme.io. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 31 endpoints.

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: https://dash.readme.io/api/v1
Version: 2.0.0
Endpoints: 31
OpenAPI: Specification ↗
Spec updated: 2020-07-22

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://dash.readme.io/api/v1/" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

JavaScript

const response = await fetch("https://dash.readme.io/api/v1/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://dash.readme.io/api/v1/",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/`	Get metadata about the current project
GET	`/api-specification`	Get API specification metadata
POST	`/api-specification`	Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/automatically-sync-api-specification-with-github
PUT	`/api-specification/{id}`	Update an API specification in ReadMe
DELETE	`/api-specification/{id}`	Delete an API specification in ReadMe
GET	`/categories/{slug}`	Get category
GET	`/categories/{slug}/docs`	Get docs for category
GET	`/changelogs`	Get changelogs
POST	`/changelogs`	Create changelog
GET	`/changelogs/{slug}`	Get changelog
PUT	`/changelogs/{slug}`	Update changelog
DELETE	`/changelogs/{slug}`	Delete changelog
GET	`/custompages`	Get custom pages
POST	`/custompages`	Create custom page
GET	`/custompages/{slug}`	Get custom page
PUT	`/custompages/{slug}`	Update custom page
DELETE	`/custompages/{slug}`	Delete custom page
POST	`/docs`	Create doc
POST	`/docs/search`	Search docs
GET	`/docs/{slug}`	Get doc
PUT	`/docs/{slug}`	Update doc
DELETE	`/docs/{slug}`	Delete doc
GET	`/errors`	Get errors
POST	`/swagger`deprecated	DEPRECATED. Instead use https://docs.readme.com/developers/reference/api-specification#uploadapispecification to upload a Swagger file to ReadMe
PUT	`/swagger/{id}`deprecated	DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#updateapispecification to update a Swagger file.
DELETE	`/swagger/{id}`deprecated	DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#deleteapispecification to delete a Swagger file in ReadMe
GET	`/version`	Get versions
POST	`/version`	Create version
GET	`/version/{versionId}`	Get version
PUT	`/version/{versionId}`	Update version
DELETE	`/version/{versionId}`	Delete version