coss.comdocs

Retrieve the organization's dedicated IPs

GET
/v1/dedicated_ips

The organization's dedicated IP pool (the Dedicated IPs add-on, bought on the dashboard's billing page): its status, its IPs and how much of the last week's mail they delivered. Organization-wide, like domains: every environment's key sees the same pool; only live emails go through it. Without the add-on the status is not_enabled.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The organization's dedicated IPs.

application/json
  1. response

Your organization's dedicated IPs (the Dedicated IPs add-on): a pool managed and warmed up automatically.

object*"dedicated_ip_pool"
Value in"dedicated_ip_pool"
status*string

not_enabled without the Dedicated IPs add-on. provisioning while the pool is set up (waiting when none is free yet), then warming: live emails go through the pool while it warms up its IPs, sending what they can't take yet from shared IPs. ready once at least 95% of the last 7 days' deliveries (at least 1,000) left from your dedicated IPs. releasing after the add-on ends: emails are back on shared IPs, and the pool is released a day later.

Value in"not_enabled""waiting""provisioning""warming""ready""releasing"
ips*array<>

The pool's IPs; the provider adds and removes them with volume.

dedicated_share*|

Share (0–1) of the last 7 days' deliveries that left from the pool's IPs (null: fewer than 1,000).

message*|

What is holding the pool up, if anything.

created_at*|
Formatdate-time
ready_at*|

When it was first ready.

Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.dedicatedIps.get();
{  "object": "dedicated_ip_pool",  "status": "warming",  "ips": [    {      "ip": "198.51.100.10",      "delivered_7d": 18420    }  ],  "dedicated_share": 0.72,  "message": null,  "created_at": "2026-10-12T09:31:00.000Z",  "ready_at": null}