Skip to main content

API Reference

Protocol Buffer API reference for the EdgeRun API service

Package
edgerun.api

This API reference covers the Protocol Buffer message definitions for the EdgeRun API service. These messages are used for authentication, user management, and system operations.

Protocol Buffers: EdgeRun uses Protocol Buffers (protobuf) for efficient, type-safe communication between services. All API operations use these message definitions for request and response handling.

Message Categories

Authentication

Authentication

Secure API access with JWT tokens and role-based permissions.

Rate Limiting

Rate Limiting

Protect your API with configurable rate limits and quotas.

Monitoring

Monitoring

Track API usage, performance, and errors in real-time.

Message Reference

Usage Examples

Authentication Flow

The typical authentication flow using these messages:

  1. Client sends AuthChallengeRequest with provider ID and public key
  2. Server responds with AuthChallengeResponse containing challenge and nonce
  3. Client signs challenge and sends AuthRequest with signature
  4. Server verifies signature and returns AuthResponse with tokens

Security

Our API is secured with industry-standard authentication and encryption.

Error Handling

All API operations can return ErrorResponse messages:

  • INVALID_SIGNATURE: Authentication signature verification failed
  • USER_NOT_FOUND: Requested user does not exist
  • INSUFFICIENT_PERMISSIONS: User lacks required permissions
  • SERVICE_UNAVAILABLE: Backend service is temporarily unavailable

Next Steps

Orchestrator

Orchestrator

Manage deployments and resources across providers.

Provider

Provider

Register and manage infrastructure providers.

Auth

Auth

Handle authentication and authorization.