Skip to main content
A provider connection lets Squasher create the delivery setup in your cloud account, so that you do not configure each drain by hand. Start a connection from Integrations in the dashboard, or through the Squasher API.

Supported providers

Vercel and Railway connect the same way: install or approve Squasher in the provider, then choose the provider project in Integrations. The Cloudflare connection can also pull zone and Worker analytics. See Cloudflare analytics metrics. PlanetScale has no connect plan: you send the service token in one request. See PlanetScale.

Connect from the dashboard

  1. Open your project and select Settings in the sidebar, then the Integrations tab.
  2. On the provider card, select Connect. For Render, enter a Render API key. For AWS, choose the Region and the log groups, then select Open CloudFormation.
  3. Approve the access in the provider. Squasher returns you to Integrations with a message.
  4. If the card asks for a choice, for example the Cloudflare Workers or the Google Cloud project, make it on the card.
A card that shows Manual setup cannot connect from the dashboard yet. Its button opens the steps that set up the same delivery by hand. A card that shows Unavailable has no other path. Repair checks the connection and recreates missing resources that Squasher owns. Disconnect removes them.

Connect through the API

Prerequisites

  • An API key with the project:write permission for the project. The ingest key from the Setup page does not have it. See API keys.
  • Access to the provider account, with permission to approve the connection.

Start a connection

1

Request a connect plan

Replace cloudflare with aws, gcp, render, notion, or sentry.
For AWS, send the Region and the log groups in settings:
To use the account-level subscription policy instead of named log groups, send "account_wide": true.
2

Approve access in the provider

The response has an action. When it has a url, a person opens it and approves access. An API client cannot approve it. The AWS launch link expires at expires_at and works once. For Render, the action is api_key_form: go to the next step.
3

Choose what to connect

Each path starts with /v1/projects/<project-id>/provider-connections.
4

Check the connection

Each connection has a status and a last_error. For the freshness and the last error of each data stream, request GET /v1/projects/<project-id>/provider-health, or run squasher integrations health.

Repair or remove a connection

  • POST .../provider-connections/<provider>/reconcile reads the provider again and updates the status.
  • DELETE .../provider-connections/<provider> removes the resources that Squasher created and the ingest key that it made for them.
  • For AWS, delete the squasher-logs CloudFormation stack in AWS instead. The API cannot remove it.
Squasher does not replace a provider resource that another tool owns. For example, if Render already streams workspace metrics to another destination, Squasher keeps it and pulls metrics instead.

Next steps

Provider connections API

See every request and response field.

HTTP API

Send logs from a drain or forwarder that you run.