KubeBuddy Radar API – Getting Started
← Back to Docs

KubeBuddy Radar API – Getting Started

Start with an authenticated catalog request, then try user-specific endpoints with your account.

Quick Summary

  • Base URL: https://radar.kubebuddy.io/api/kb-radar/v1
  • Catalog endpoints: require auth (browser session or API key)
  • User endpoints: HTTP Basic Auth with WordPress application passwords

1) Get your API key

  • Go to Account -> Developer API Access
  • Create a key and copy it (shown once)
  • Keys are WordPress Application Passwords tied to your user
  • Use your WordPress username + the key for auth

Your account page only shows keys created for the logged-in user.

Store keys securely and revoke them when no longer needed.

2) Try a catalog request (auth required)

Use HTTP Basic Auth (application password) or a browser session. Let’s fetch the first 3 projects:

curl -u "username:app_password" \
  "https://radar.kubebuddy.io/api/kb-radar/v1/projects?per_page=3"

Sample response:

{
  "page": 1,
  "per_page": 3,
  "total": 256,
  "total_pages": 86,
  "items": [
    {
      "id": 12,
      "name": "Argo CD",
      "description": "Declarative GitOps CD for Kubernetes",
      "category": "CI/CD",
      "cncf_status": "graduated",
      "repo_url": "https://github.com/argoproj/argo-cd",
      "homepage": "https://argo-cd.readthedocs.io",
      "latest_version": "v2.10.4",
      "latest_published_at": "2024-06-02 10:35:20"
    }
  ]
}

Try searching and filtering:

Try with PowerShell:

$user = "your_username"
$pass = "your_app_password"
$token = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$user`:$pass"))
$headers = @{ Authorization = "Basic $token" }

# Basic request
Invoke-RestMethod "https://radar.kubebuddy.io/api/kb-radar/v1/projects?per_page=3" -Headers $headers

# Search and filter
$graduated = Invoke-RestMethod "https://radar.kubebuddy.io/api/kb-radar/v1/projects?cncf_status=graduated&per_page=10" -Headers $headers
$graduated.items | ForEach-Object { Write-Host "$($_.name) - $($_.category)" }

Try with Python:

import requests
from requests.auth import HTTPBasicAuth

auth = HTTPBasicAuth("your_username", "your_app_password")

# Basic request
response = requests.get("https://radar.kubebuddy.io/api/kb-radar/v1/projects?per_page=3", auth=auth)
data = response.json()
print(f"Found {data['total']} projects total")

# Get security releases
security = requests.get(
    "https://radar.kubebuddy.io/api/kb-radar/v1/recent-releases?limit=10&security_only=1",
    auth=auth
)
releases = security.json()
for rel in releases['releases']:
    print(f"{rel['name']} {rel['version']} - {rel['security_severity']}")

3) Common errors & troubleshooting

401 Unauthorized

Problem: Missing or invalid authentication credentials

Solutions:

  • Make sure you’re using your WordPress username, not your email address
  • Verify your application password is correct (copy it exactly, including spaces)
  • Check that the Authorization header is properly formatted
  • Test with a simple curl command first: curl -u "user:pass" "URL"

403 Forbidden

Problem: Authenticated but not authorized for this resource

Solutions:

  • Check your plan level – some endpoints require Pro or Pro Plus
  • Verify you haven’t exceeded your subscription limit
  • Make sure the endpoint exists and you’re using the correct HTTP method

404 Not Found

Problem: Endpoint doesn’t exist

Solutions:

  • Check the base URL: https://radar.kubebuddy.io/api/kb-radar/v1
  • Verify the endpoint path in the API reference
  • Make sure the resource ID exists (e.g., project ID)

Testing Your Setup

Quick test to verify your credentials work:

# Test authentication with dashboard endpoint
curl -v -u "your_username:your_app_password" \
  "https://radar.kubebuddy.io/api/kb-radar/v1/dashboard"

# If successful, you'll see your account info
# If 401, check your username and password

Next Steps

Now that you’ve made your first requests, here’s what to explore next:

1. Explore More Endpoints

  • GET /stats – Get platform statistics
  • GET /recent-releases – See what’s new across all projects (now with category and security filters)
  • GET /popular-projects – Discover trending tools
  • GET /projects – Browse all projects (now with search and CNCF status filters)
  • GET /subscriptions – View your tracked projects (authenticated)

2. Try Advanced Filtering

  • Search for specific projects: ?search=prometheus
  • Filter by CNCF maturity: ?cncf_status=graduated
  • Get only security releases: ?security_only=1
  • Filter by category: ?category=CI/CD

3. Build Something

  • Create a Slack bot for release notifications
  • Add a dashboard widget showing your tracked projects
  • Set up CI/CD checks for dependency updates
  • Build a custom mobile app

3. Read the Full Documentation

Need help?

Contact support and include any error details.

Contact support

← Back to Docs