ReadMe.io · Authentication Profile

Readmeio Authentication

Authentication

ReadMe.io secures its APIs with http across 2 declared security schemes, as derived from its OpenAPI definitions.

CompanyApisDocumentationAPI DocumentationDeveloper ExperienceDeveloper PortalOpenAPIDeveloper HubAPI Metrics
Methods: http Schemes: 2 OAuth flows: API key in: header

Security Schemes

BearerAuth http
scheme: bearer
BasicAuth http
scheme: basic

Source

Authentication Profile

readmeio-authentication.yml Raw ↑ 
generated: '2026-07-20'
method: searched
source: https://docs.readme.com/main/reference/authentication
docs: https://docs.readme.com/main/reference/authentication
summary:
  types:
  - http
  api_key_in:
  - header
  oauth2_flows: []
  note: >-
    ReadMe uses project API keys. v2 passes the key as an HTTP Bearer token; the
    legacy v1 API uses HTTP Basic auth with the API key as the username.
schemes:
- name: BearerAuth
  type: http
  scheme: bearer
  applies_to: ReadMe API (v2), Developer Metrics API
  base_url: https://api.readme.com/v2
  header: 'Authorization: Bearer README_API_KEY'
  example: >-
    curl https://api.readme.com/v2/projects/me -X GET
    --header "Authorization: Bearer README_API_KEY"
  sources:
  - https://docs.readme.com/main/reference/authentication
- name: BasicAuth
  type: http
  scheme: basic
  applies_to: ReadMe API (v1, Legacy)
  base_url: https://dash.readme.com/api/v1
  note: >-
    API key supplied via HTTP Basic auth. Not available to projects using ReadMe
    Refactored; superseded by the v2 Bearer scheme.
  sources:
  - https://docs.readme.com/main/reference/legacy-api
key_management:
  where: ReadMe dashboard — Configuration > API Keys
  programmatic:
  - createApiKey
  - getApiKeys
  - getApiKey
  - updateApiKey
  - deleteApiKey
  rotation: API keys can be rotated from the dashboard.