ReadMe Custom Pages API
Manage custom documentation pages
ReadMe Custom Pages API is one of 14 APIs that ReadMe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Custom Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://metrics.readme.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ReadMe Custom Pages API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic auth using your ReadMe API key as the username (password blank).
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage custom documentation pages
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ReadMe 12
Other APIs ReadMe publishes across the network.