Create a key to copy examples filled with your team.
Clusters
A named shared-IP sending environment.
A cluster is a named sending environment. Create always sets ip_assignment to shared. KYC must be approved first. The API returns 403 {error: kyc_required} before that.
Create fields
| Field | Description |
|---|---|
name |
Required. |
plan |
Hourly send cap. nano, micro, small, medium, large, xl, or burst. Default nano. |
size |
small, medium, or large. |
region |
Stored on the cluster. Default manual. |
Status and hosts
| Field | Description |
|---|---|
sending_ready |
Active desired status and a live shared pool. |
smtp_endpoint |
STARTTLS on port 587. AUTH PLAIN. |
http_endpoint |
POST /api/inject/v1 with the SMTP username and password. |
Suspend and resume match the cluster page. Suspended clusters fail send with cluster_not_ready.
Teardown
DELETE /api/v1/clusters/:id calls Cluster#teardown!. The row stays. desired_status becomes deprovisioned. The cluster list hides it. Show still returns it for history. Live SMTP credentials are disabled in one shot. Sending domains, tenants, and inboxes are not cluster children, so they stay. Resume cannot un-teardown a deprovisioned cluster. That request returns 422 {error: "archived"}.
Dedicated IPs are not customer-provisionable. Create always uses the shared pool.