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. |
size |
small, medium, or large. |
region |
Stored on the cluster. Default manual. |
cluster.json
1
{
2
"cluster": {
3
"name": "edge",
4
"size": "small",
5
"region": "manual"
6
}
7
}
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.
Dedicated IPs are not customer-provisionable. Create always uses the shared pool.