Readme API Key

Description

General

Documentation: https://docs.readme.com/main/reference
Summary: ReadMe is a developer hub for documentation. It provides a platform where teams can create, manage, and share documentation and guides. It can be used for API documentation, product guides, and more. It's a tool to make it easier to document systems, processes, and APIs.
IPs allowlist: ReadMe does not currently support IP restriction for accessing the service. For more information, refer to the official documentation.
Scopes: No API permissions are specified upon creation.

Revoke the secret

In the event of a security issue, the secret key for a project can be revoked and a new secret key can be generated.

Check for suspicious activity

Each API call can be tracked so suspicious activity can be tracked.

Details for `Readme apikey`

Family: Api
Category: Other
Company: Readme
High recall: False
Validity check available: True
On-premise instances exist: False
Only valid secrets raise an alert: False
Minimum number of matches: 1
Occurrences found for one million commits: 0.21
Prefixed: False
PreValidators:

- type: ContentWhitelistPreValidator
  patterns:
    - rdme_

Examples

- text: >
    README_KEY="rdme_xn8s9h606d8fd1fc6aef1d552ef4ed057114f9e1a9ef8fcc69b80b255a4a8120273xxx"
  apikey: rdme_xn8s9h606d8fd1fc6aef1d552ef4ed057114f9e1a9ef8fcc69b80b255a4a8120273xxx

- text: |
    http.setRequestProperty("Authorization", "Basic rdme_xn8s9h40869bd282cdf7524c8293189ffe33baaa36c420c32664072df1629a83xxxa97");
  apikey: rdme_xn8s9h40869bd282cdf7524c8293189ffe33baaa36c420c32664072df1629a83xxxa97

# Fat-fingered secret
- text: Xrdme_xn8s9h40869bd282cdf7524c8293189ffe33baaa36c420c32664072df1629a83xxxa97
  apikey: rdme_xn8s9h40869bd282cdf7524c8293189ffe33baaa36c420c32664072df1629a83xxxa97