Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Retrieve all recent access attempts

API Overview

api-overview page anchor

IP access management allows you to control which IP addresses can access your account. You can use either the Console or the API.

Twilio SendGrid limits the number of allowed IP addresses to 1000.

(error)

Allowed IP addresses must include your IP address

The list of the allowed IP addresses doesn't include your IP address without your action. You can remove from your IP address from the list of allowed IP addresses and block your access to your account. While Twilio can restore your access, this requires thorough proof of your identity and ownership of your account.

To prevent the accidental removal of your IP address from the allowed addresses, the Console displays your IP address in the Add IP Addresses pane.

To learn more, see IP access management.

Operation overview

operation-overview page anchor

GET/v3/access_settings/activity

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 a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstring

Optional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Query string

query-string page anchor
Property nameTypeRequiredDescription
limitinteger

Optional

Limits the number of IPs to return.

Default: 20

Responses

responses page anchor
200401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

Optional

An array containing the IPs that recently attempted to access your account.

Retrieve all recent access attemptsLink to code sample: Retrieve all recent access attempts
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const queryParams = { limit: 20 };

5


6
const request = {

7
  url: `/v3/access_settings/activity`,

8
  method: "GET",

9
  qs: queryParams,

10
};

11


12
client

13
  .request(request)

14
  .then(([response, body]) => {

15
    console.log(response.statusCode);

16
    console.log(response.body);

17
  })

18
  .catch((error) => {

19
    console.error(error);

20
  });