Getting started

This page takes you from a fresh account to a project that is receiving data. It should take a few minutes.

1. Create an account

Quiet Guard is in closed beta: every account is opened by hand. There are two ways in.

• Ask for access. Open /app/register, give your name, email and password, and say in a few words what you would like to test. Your request goes into a queue; you receive a mail when it is accepted, and another if it is not. Until then, signing in shows a waiting page, not the product.
• Be invited. The operator can create your account directly; you then receive a mail with a link to choose your password, and your account is already approved.

The account is yours; what holds your data is a Team, and you create it yourself at your first sign-in. The form asks for the team name, your business identifier (a French SIREN or an EU VAT number, since Quiet Guard is sold to businesses) and your acceptance of the terms: the team is the party to the contract, so these are statements only the person who binds it can make. Nothing is charged during the beta and no card is asked for.

The team is the tenant: everything, projects, plans, usage, billing, encryption, belongs to a team, not to an individual user. You can invite members later from the Team members page, within the seats your plan carries: one on Free, three on Indie, unlimited on Studio. Projects are unlimited on every plan. Moving to a plan with fewer seats never removes anybody: the team keeps the members it has, and can add nobody new until it is back under the number the plan carries.

The Team is the tenant. All data is scoped to the active team. If you belong to more than one team, switch the active team from the tenant menu in the top bar.

2. Create a project

A Project represents one monitored application (one Laravel app, one site, one service).

1. In the /app panel, open Projects and choose New project.
2. Give it a name (e.g. Acme Store, production).
3. Save. The form's other sections, appearance, uptime probe and the GitHub integration, are optional and can wait.

You now have an empty project ready to receive exceptions, logs and dependency snapshots.

3. Generate a project API key

Each project authenticates its monitored app with a project API key. Keys are stored hashed (SHA-256) and the plaintext value is shown only once.

1. Open your project and go to its API keys (project tokens).
2. Create a key and give it a name (e.g. production).
3. Copy the key immediately. It looks like:

lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Copy it now. The full key is displayed a single time. If you lose it, revoke it and generate a new one, the stored hash cannot be turned back into the original key.

4. Point a client at the ingestion endpoint

The monitored app sends data to your Quiet Guard server over HTTP, authenticating with the project key. Two header styles are accepted:

# Preferred: bearer token
curl -X POST https://your-monitor.example.com/api/v1/ingest \
  -H "Authorization: Bearer lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "exception": {
      "class": "RuntimeException",
      "message": "Something went wrong",
      "file": "/app/Services/Checkout.php",
      "line": 42
    },
    "context": { "environment": "production" }
  }'

# Alternative header
curl -X POST https://your-monitor.example.com/api/v1/ingest \
  -H "X-Monitor-Key: lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "exception": { "class": "RuntimeException" } }'

A successful call returns HTTP 202 Accepted:

{ "message": "accepted", "stored": true, "issue_id": "01kw6tkrd8wjbfv2pktr7ssw43" }

issue_id is the issue's public identifier, a ULID. It is the same value the dashboard URL carries, so you can log it and paste it into the address bar. It is not a row number, and there is no event counter in the response: those would have told every project how many exceptions the whole platform had stored.

In practice you will not craft these requests by hand. Install the official client for your stack, the Laravel SDK is the reference implementation, and configure it with your server URL and project key. The client takes care of capturing exceptions, batching logs and reporting composer.lock.

5. Verify it arrived

Back in the /app panel, open your project from Projects in the sidebar. The first exception you sent appears as an Issue. From here you can explore exception tracking, turn on alerting, and enable paid features such as logs and encrypted storage depending on your plan.

Building your own client? The full request/response contract for every endpoint is in the Ingestion API reference.