Retrieve all assigned IPs

API Overview

Elements that can be shared among more than one endpoint definition.

Operation overview

GET/v3/ips/assigned

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve only assigned IP addresses.

A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

200

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

ipstring

Optional

The IP address.

poolsarray[string]

Optional

The IP pools that this IP address has been added to.

warmupboolean

Optional

Indicates if this IP address is currently warming up.

start_dateinteger

Optional

The start date that this IP address was entered into warmup.

Retrieve all assigned IPs

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const request = {
5  url: `/v3/ips/assigned`,
6  method: "GET",
7};
8
9client
10  .request(request)
11  .then(([response, body]) => {
12    console.log(response.statusCode);
13    console.log(response.body);
14  })
15  .catch((error) => {
16    console.error(error);
17  });