Skip to main content
GET
Get IP warmup ramp plan

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

targetDailyVolume
integer
required

Steady-state daily volume the warmup ramp aims toward (1-10M/day). Required.

startingVolume
integer

Optional custom day-one daily cap (overrides the default curve start).

growthFactor
number

Optional daily-growth multiplier applied day over day (1.05-4; default ~1.5).

Response

The warmup ramp schedule inside the standard { data, meta } envelope: data carries the day-by-day send-volume caps climbing from the day-one starting volume up to the steady-state target daily volume.

The warmup ramp schedule inside the standard { data, meta } envelope: data carries the day-by-day send-volume caps climbing from the day-one starting volume up to the steady-state target daily volume.