# Beekon Cloud

> Beekon Cloud, the hosted Beekon server, in early access. Where to start with an account and keys, the SDK's Cloud mode, and how the platform handles your data.

Source: https://docs.getbeekon.com/cloud/

Beekon Cloud is the managed, hosted side of Beekon: the server API, the [console](https://docs.getbeekon.com/cloud/console/) and the SDK’s cloud mode. It is in **early access**. Self-serve sign-up arrives with a coming console release ([Sign up and set up your workspace](https://docs.getbeekon.com/cloud/sign-up/)); until then we set up each early-access organisation with its team. If you have been given a console sign-in or keys, everything on this page and in the [server API reference](https://docs.getbeekon.com/api/) works for you today.

## You have been given access: start here

1. **Sign in to the console** at [console.getbeekon.com](https://console.getbeekon.com) with the account we set up for you. Pick your project in the project switcher. See [The console](https://docs.getbeekon.com/cloud/console/).

2. **Issue your keys** on the console’s [API keys](https://docs.getbeekon.com/cloud/console/developers/#api-keys) page (owners and admins). A new project starts with none. The SDK key (`bkproj_<cell>_…`) goes in your app. A server key (`bkserv_<cell>_…`) stays on your backend and carries the [scopes](https://docs.getbeekon.com/api/scopes/) chosen when it was issued. The second segment of either key is your region, which names your API host: `https://api.<cell>.getbeekon.com`.

3. **Call the server API**: [Server API quickstart](https://docs.getbeekon.com/api/quickstart/) takes a server key to a page of locations in four `curl` commands.

4. **Send locations.** From an app, configure the SDK’s [Cloud mode](https://docs.getbeekon.com/start/configuration/#cloud-mode) with the SDK key. With no app yet, upload locations from your server with [`POST /v1/ingest`](https://docs.getbeekon.com/api/ingest/).

5. **Add a geofence and a webhook**, then watch the events arrive: draw one on the console’s [Geofences](https://docs.getbeekon.com/cloud/console/configure/#geofences), add an endpoint on [Webhooks](https://docs.getbeekon.com/cloud/console/developers/#webhooks), and read [Events](https://docs.getbeekon.com/cloud/console/monitor/#events). The [Geofences](https://docs.getbeekon.com/api/geofences/), [Webhooks](https://docs.getbeekon.com/api/webhooks/) and [Events](https://docs.getbeekon.com/api/events/) APIs do the same from your backend.

Questions, problems, and the requests on this page that have no button or endpoint yet go to your Beekon contact, or through [getbeekon.com](https://getbeekon.com).

## Cloud mode (the SDK side)

In Cloud mode you configure the SDK with one project key, and the server owns the rest:

* **Setup.** `BeekonConfig.cloud(projectKey: "bkproj_<cell>_…")`. The key names your project’s region, and the SDK derives its endpoints from it without a network call. See [Configuration](https://docs.getbeekon.com/start/configuration/#cloud-mode).
* **Config.** Tracking settings come from the project’s remote config document, cached on the device. The SDK clamps every remote value to its own safe ranges, so no server value can drain the battery or redirect uploads. Tracking never waits for config.
* **Geofences.** You draw them centrally (circles and polygons). Each device receives the fences near it with its sync response, and shows crossing notifications even when the app has been killed and the device is offline. See [Geofencing](https://docs.getbeekon.com/guide/geofencing/).
* **Device control.** Config acknowledgements, health reports and remote commands (flush, upload logs) travel in the same sync exchange.
* **Monthly active users.** `setUserId(...)` binds a user id to each location when it is recorded; a device with no user id counts by its install id.

Cloud mode uses the same SDK client and the same wire contracts as every other mode.

## How the platform handles your data

These are Beekon Cloud’s rules for your data, in plain words.

**Acceptance is durable, within your plan’s retention window.**

* A successful upload (`2xx`) means the accepted locations are stored durably for as long as your plan retains data.
* Locations older than your retention window are deleted by a sweep that deletes nothing when in doubt.
* If your plan has no retention window, data is kept until you delete it.
* Your project’s window is shown on the console’s **Locations** page and in **Project settings › Data retention**. It is set by your plan: to change it, ask your Beekon contact.

**The MAU cap discards nothing.** A project can opt into a monthly active user (MAU) cap. It alerts — the console, the status pill and `billing.usage_threshold` events — and never stops usage: past the cap, new users are still admitted, counted and billed, and every location is kept. See [the MAU cap](https://docs.getbeekon.com/cloud/usage/#usage-and-the-mau-cap).

**Deletion and export on demand.** Everything stored for one end user (`user_id`) can be erased or exported: every table, verified by re-count, and recorded with a keyed hash rather than the identifier itself. A whole project can be erased too. Who can do what, and how, is on [Your data](https://docs.getbeekon.com/cloud/usage/#your-data-retention-erase-and-export).

## Without Beekon Cloud

The SDK works without Beekon Cloud and needs no account. In Custom mode it uploads to your own server, with batching and retries; in Local mode nothing leaves the device. Background tracking and geofencing work in both ([Configuration](https://docs.getbeekon.com/start/configuration/)).

[Get started ](https://docs.getbeekon.com/start/)Install, configure and start tracking. One page for all four platforms.

[Turn on sync ](https://docs.getbeekon.com/guide/sync/)Upload to your own server: the payload and a working ingest endpoint.

## Ask for early access

Want Beekon Cloud for your team? Reach out via [getbeekon.com](https://getbeekon.com).
