Twilio SendGrid IP Address Management API
The Twilio SendGrid IP Address Management API combines functionality that was previously split between the Twilio SendGrid [IP Address…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Twilio SendGrid IP Address Management API combines functionality that was previously split between the Twilio SendGrid IP Address API and IP Pools API. This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks.
Endpoints 15
IP Address Management
- GETGet a List of all IP Addresses on your Account
/v3/send_ips/ips?ip=string&limit=0&after_key=0&before_key=string&is_leased=true&is_enabled=true&is_parent_assigned=true&pool=string&start_added_at=0&end_added_at=0®ion=all&include_region=falseThis operation returns a list of all IP addresses associated with your account. A sample of IP details is returned with each IP, including which Pools the IP… - POSTAdd a Twilio SendGrid IP Address
/v3/send_ips/ipsThis operation adds a Twilio SendGrid IP address to your account. You can also assign up to 100 Subusers to the IP address at creation. - GETGet Details for an IP Address
/v3/send_ips/ips/:ip?include_region=falseThis operation returns details for a specified IP address. Details include whether the IP is assigned to a parent account, set to warm up automatically, which… - PATCHUpdate Details for an IP Address
/v3/send_ips/ips/:ipThis operation updates an IP address's settings, including whether the IP is set to warm up automatically, if the IP is assigned by a parent account, and… - GETGet a List of Subusers Assigned to an IP
/v3/send_ips/ips/:ip/subusers?after_key=0&limit=0This operation returns a list of Subuser IDs that have been assigned the specified IP address. To retrieve more information about the returned Subusers, use… - POSTAssign a Batch of Subusers to an IP
/v3/send_ips/ips/:ip/subusers:batchAddThis operation appends a batch of Subusers to a specified IP address. This endpoint requires all Subuser assignments to succeed. If a Subuser assignment… - POSTDelete a Batch of Subusers from an IP
/v3/send_ips/ips/:ip/subusers:batchDeleteThis operation removes a batch of Subusers from a specified IP address. - GETGET all IP Pools that have Associated IPs
/v3/send_ips/pools?limit=0&after_key=0&ip=string®ion=all&include_region=falseThis operation returns a list of your IP Pools and a sample of each Pools' associated IP addresses. A maximum of 10 IPs will be returned per IP Pool by… - POSTCreate an IP Pool with a Name and IP Assignments
/v3/send_ips/poolsThis operation will create a named IP Pool and associate specified IP addresses with the newly created Pool. This operation requires all IP assignments to… - GETGet Details for an IP Pool
/v3/send_ips/pools/:poolid?include_region=falseThis operation will return the details for a specified IP Pool, including the Pool's name, ID, a sample list of the IPs associated with the Pool, and the… - PUTUpdate an IP Pool Name
/v3/send_ips/pools/:poolidThis operation will rename an IP Pool. An IP Pool name cannot start with a dot/period (.) or space. - DELETEDelete IP Pool
/v3/send_ips/pools/:poolidThis operation deletes an IP Pool and unassigns all IP addresses associated with the Pool. IP addresses associated with the deleted Pool will remain in your… - GETGet IPs Assigned to an IP Pool
/v3/send_ips/pools/:poolid/ips?limit=0&after_key=0&include_region=falseThis operation returns the IP addresses that are assigned to the specified IP pool. - POSTAdd a Batch of IPs to an IP Pool
/v3/send_ips/pools/:poolid/ips:batchAddThis operation appends a batch of IPs to an IP Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will… - POSTDelete a Batch of IPs from an IP Pool
/v3/send_ips/pools/:poolid/ips:batchDeleteThis operation removes a batch of IPs from an IP Pool. All IPs associated with the Pool will be unassigned from the deleted Pool. However, this operation does…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 15 operations on 10 pathsGET 6POST 6PUT 1PATCH 1DELETE 1
- Main resources
- IP Address Management 15
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid IP Address Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid IP Address Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get a List of all IP Addresses on your Account” (GET /v3/send_ips/ips?ip=string&limit=0&after_key=0&before_key=string&is_leased=true&is_enabled=true&is_parent_assigned=true&pool=string&start_added_at=0&end_added_at=0®ion=all&include_region=false), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid IP Address Management API?
The Twilio SendGrid IP Address Management API combines functionality that was previously split between the Twilio SendGrid [IP Address… It is listed under Communication and has 15 endpoints.
Who publishes the Twilio SendGrid IP Address Management API?
It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio SendGrid IP Address Management API?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid IP Address Management API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid IP Address Management API have?
15 operations on 10 paths (6 GET, 6 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are IP Address Management.
Is forking the Twilio SendGrid IP Address Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.