Public API

The Baseguard API provides programmatic access to manage your mesh network. Use it to automate node management, configure access control, and integrate Baseguard into your infrastructure workflows.

Full Documentation

For the complete interactive API reference with all endpoints, request/response schemas, and example payloads:

Base URL

https://api.baseguard.net/openapi

For self-hosted deployments, use your control plane URL.

Authentication

All requests require an API key. Create one in the console:

1. Go to Keys > API Keys
2. Click Create API Key
3. Copy the generated key (shown only once)

Include the key in the Authorization header along with your organization Id:

curl -H "Authorization: Bearer bgapi_xxxxxxxxxxxx" \
     -H "x-bg-organization-id: your-org-id" \
     https://api.baseguard.net/openapi/v1/node

Required Headers

Find your organization ID by running baseguard organizations or viewing organization settings in the console.

Best Practices

1. Don't hardcode keys — Use environment variables
2. Rotate regularly — Change keys periodically
3. Use minimal permissions — Request only needed access
4. Monitor usage — Review audit logs for anomalies