On this page

Get remaining IPs count

API Overview

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

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

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultsarray[object]

Show child properties for results

Get remaining IPs count

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