Get remaining IPs count

API Overview

The IP Address API lets you manage the dedicated IP addresses assigned to your SendGrid account. Use these endpoints to add dedicated IP addresses, list IP addresses, check how many IP addresses you can add, and inspect IP pool assignments.

Operation overview

GET/v3/ips/remaining

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

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

This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultsarray[object]

Optional

Show results properties

Get remaining IPs count

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const request = {
5  url: `/v3/ips/remaining`,
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  });