Create a key to copy examples filled with your team.
Clusters
Shared-IP sending environments.
Create a shared-IP sending cluster. A pending team can create one. A second cluster returns 403 {error: kyc_required} until the team is approved. Suspend and resume match the cluster page. DELETE tears the cluster down. The row stays, desired_status becomes deprovisioned, and live SMTP credentials are disabled. Domains are untouched. Send on smtp_endpoint (port 587) or http_endpoint (POST /api/inject/v1) with the SMTP username and password.
GET /api/v1/teams/:team_id/clusters
List live clusters for the token's team. Excludes deprovisioned.
GET /api/v1/clusters/:id
Get one cluster, including computed status, SMTP, and HTTP inject.
id: Cluster id
POST /api/v1/teams/:team_id/clusters
Create a shared-IP cluster. Issues a default SMTP user that is not in the response. A pending team can create one. A second cluster returns 403 {error: kyc_required} until the team is approved. Returns 403 {error: payment_required} when Stripe billing is on and the team has no card.
PATCH /api/v1/clusters/:id
Update name, region, size, or plan. Changing plan updates the hourly throttle immediately. Returns 422 {error: archived} if the cluster is deprovisioned.
id: Cluster id
POST /api/v1/clusters/:id/resume
Resume sending. Returns 422 {error: archived} if the cluster is deprovisioned.
id: Cluster id
DELETE /api/v1/clusters/:id
Teardown the cluster. Row stays. desired_status becomes deprovisioned. Live SMTP credentials are disabled. Domains are untouched.
id: Cluster id