# LogFleet

## Docs

- [Create Agent](https://docs.logfleet.io/api-reference/agents/create.md): Manually register a new agent
- [Delete Agent](https://docs.logfleet.io/api-reference/agents/delete.md): Remove an agent from the organization
- [Get Agent](https://docs.logfleet.io/api-reference/agents/get.md): Returns agent details by ID
- [List Agents](https://docs.logfleet.io/api-reference/agents/list.md): Returns all agents for the organization
- [Update Agent](https://docs.logfleet.io/api-reference/agents/update.md): Update agent details
- [Create API Key](https://docs.logfleet.io/api-reference/api-keys/create.md): Create a new API key for edge agents. The raw key is only returned once in the response. Store it securely.
- [Get API Key](https://docs.logfleet.io/api-reference/api-keys/get.md): Returns API key details (without the actual key)
- [List API Keys](https://docs.logfleet.io/api-reference/api-keys/list.md): Returns all API keys for the organization
- [Revoke API Key](https://docs.logfleet.io/api-reference/api-keys/revoke.md): Revoke an API key. This cannot be undone.
- [Forgot Password](https://docs.logfleet.io/api-reference/auth/forgot-password.md): Initiates password reset flow. In production, sends email with reset link. In development, returns token in response for testing.
- [Login](https://docs.logfleet.io/api-reference/auth/login.md): Authenticate user and obtain JWT token
- [Register](https://docs.logfleet.io/api-reference/auth/register.md): Creates a new organization and its first admin user
- [Reset Password](https://docs.logfleet.io/api-reference/auth/reset-password.md): Reset password using token from forgot-password email
- [List Invoices](https://docs.logfleet.io/api-reference/billing/invoices.md): Returns the organization's invoices
- [Current Billing Period](https://docs.logfleet.io/api-reference/billing/period.md): Returns the current billing period dates
- [Get Plan Limits](https://docs.logfleet.io/api-reference/billing/plan-limits.md): Returns the limits for the organization's current plan
- [List Plans](https://docs.logfleet.io/api-reference/billing/plans.md): Returns all available plans with their limits and pricing
- [Get Quota](https://docs.logfleet.io/api-reference/billing/quota.md): Returns current usage vs plan limits
- [Get Usage](https://docs.logfleet.io/api-reference/billing/usage.md): Returns aggregated usage for billing period
- [Agent Health](https://docs.logfleet.io/api-reference/dashboard/agent-health.md): Returns aggregated health status of all agents
- [Recent Agents](https://docs.logfleet.io/api-reference/dashboard/recent-agents.md): Returns recently active agents (limit 10)
- [Usage Summary](https://docs.logfleet.io/api-reference/dashboard/usage.md): Returns usage metrics for the current billing period
- [Send Heartbeat](https://docs.logfleet.io/api-reference/edge/heartbeat.md): Report agent status and health metrics
- [Push Metrics](https://docs.logfleet.io/api-reference/edge/metrics.md): Submit extracted metrics to the platform
- [Edge API Overview](https://docs.logfleet.io/api-reference/edge/overview.md): Endpoints used by edge agents
- [Register Agent](https://docs.logfleet.io/api-reference/edge/register.md): Register a new edge agent with the platform
- [Stream Logs](https://docs.logfleet.io/api-reference/edge/stream.md)
- [Sync Config](https://docs.logfleet.io/api-reference/edge/sync-config.md): Edge agents poll this endpoint to get their metric extraction config. Returns empty response if agent is up to date.
- [Create Metric Config](https://docs.logfleet.io/api-reference/metric-configs/create.md): Create a new metric extraction configuration
- [Delete Metric Config](https://docs.logfleet.io/api-reference/metric-configs/delete.md): Delete a metric config and all its definitions
- [Get Metric Config](https://docs.logfleet.io/api-reference/metric-configs/get.md): Returns a metric config by ID
- [List Metric Configs](https://docs.logfleet.io/api-reference/metric-configs/list.md): Returns all metric extraction configs for the organization
- [Get Config Metrics](https://docs.logfleet.io/api-reference/metric-configs/metrics.md): Returns all metric definitions for a config
- [Metric Configs Overview](https://docs.logfleet.io/api-reference/metric-configs/overview.md): Configure log-to-metric extraction at the edge
- [Update Metric Config](https://docs.logfleet.io/api-reference/metric-configs/update.md): Update a metric config. Requires version for optimistic locking.
- [Get Config Versions](https://docs.logfleet.io/api-reference/metric-configs/versions.md): Returns version history for a config
- [Get Organization](https://docs.logfleet.io/api-reference/organization/get.md): Returns the authenticated user's organization
- [Update Organization](https://docs.logfleet.io/api-reference/organization/update.md): Update organization settings
- [API Overview](https://docs.logfleet.io/api-reference/overview.md): LogFleet REST API reference
- [Get Session](https://docs.logfleet.io/api-reference/streaming/get-session.md): Returns status of a streaming session
- [List Sessions](https://docs.logfleet.io/api-reference/streaming/list-sessions.md): Returns all active streaming sessions for the organization
- [Start Streaming](https://docs.logfleet.io/api-reference/streaming/start.md): Initiate a new log streaming session from an agent
- [Stop Streaming](https://docs.logfleet.io/api-reference/streaming/stop.md): End an active streaming session
- [WebSocket Connection](https://docs.logfleet.io/api-reference/streaming/websocket.md): Real-time log streaming via WebSocket
- [Authentication](https://docs.logfleet.io/authentication.md): Understanding LogFleet authentication methods
- [Project Structure](https://docs.logfleet.io/concepts/project-structure.md): Understanding LogFleet repositories and components
- [Custom Metrics](https://docs.logfleet.io/guides/custom-metrics.md): Extract metrics from logs at the edge
- [End-to-End Setup](https://docs.logfleet.io/guides/e2e-setup.md): Complete walkthrough from cloud to edge to dashboard
- [Edge Agent Setup](https://docs.logfleet.io/guides/edge-agent-setup.md): Deploy and configure LogFleet edge agents
- [FAQ](https://docs.logfleet.io/guides/faq.md): Frequently asked questions about LogFleet
- [Log Streaming](https://docs.logfleet.io/guides/log-streaming.md): On-demand real-time log streaming from edge agents
- [Performance & Capacity Planning](https://docs.logfleet.io/guides/performance.md): Hardware requirements, benchmarks, and tuning guidelines for LogFleet deployments
- [Resilience and Failure Handling](https://docs.logfleet.io/guides/resilience.md): What happens when things go wrong and how LogFleet handles it
- [Security and Compliance](https://docs.logfleet.io/guides/security.md): How LogFleet protects your data and what we are working on
- [Troubleshooting](https://docs.logfleet.io/guides/troubleshooting.md): Diagnose and resolve common LogFleet issues
- [Vector Configuration](https://docs.logfleet.io/guides/vector-configuration.md): Customize log collection, transforms, and sinks
- [Introduction](https://docs.logfleet.io/introduction.md): Edge-first observability for distributed fleets. Ship metrics, stream logs on-demand.
- [Quickstart](https://docs.logfleet.io/quickstart.md): Get your first logs flowing in 5 minutes

## OpenAPI Specs

- [openapi](https://docs.logfleet.io/openapi.yaml)

## Optional

- [Home](https://logfleet.io)
- [GitHub](https://github.com/sadhiappan/logfleet)