{ "opencollection": "1.0.0", "info": { "name": "Twilio SendGrid Provisioning Account Reverse DNS API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Reverse DNS", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all reverse DNS records", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/whitelabel/ips", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used." }, { "name": "offset", "value": "", "type": "query", "description": "The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0` represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the `offset` to the page size as determined by `limit`. Use multiples of the page size as your `offset` to request further consecutive pages. E.g. assume your page size is set to `10`. An `offset` of `10` requests the second page, an `offset` of `20` requests the third page and so on, provided there are sufficiently many items in your list." }, { "name": "ip", "value": "", "type": "query", "description": "The IP address segment that you'd like to use in a prefix search." } ] }, "docs": "**This endpoint allows you to retrieve a paginated list of all the Reverse DNS records created by this account.**\n\nYou may include a search key by using the `ip` query string parameter. This enables you to perform a prefix search for a given IP segment (e.g., `?ip=\"192.\"`).\n\nYou can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list " }, { "info": { "name": "Set up reverse DNS", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/whitelabel/ips", "headers": [ { "name": "on-behalf-of", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to set up reverse DNS.**" }, { "info": { "name": "Retrieve a reverse DNS record", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/whitelabel/ips/:id", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the reverse DNS record that you would like to retrieve." } ] }, "docs": "**This endpoint allows you to retrieve a reverse DNS record.**\n\nYou can retrieve the IDs associated with all your reverse DNS records using the \"Retrieve all reverse DNS records\" endpoint." }, { "info": { "name": "Delete a reverse DNS record", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/whitelabel/ips/:id", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the reverse DNS record that you would like to retrieve." } ] }, "docs": "**This endpoint allows you to delete a reverse DNS record.**\n\nA call to this endpoint will respond with a 204 status code if the deletion was successful.\n\nYou can retrieve the IDs associated with all your reverse DNS records using the \"Retrieve all reverse DNS records\" endpoint." }, { "info": { "name": "Validate a reverse DNS record", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/whitelabel/ips/:id/validate", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the reverse DNS record that you would like to validate." } ] }, "docs": "**This endpoint allows you to validate a reverse DNS record.**\n\nAlways check the `valid` property of the response’s `validation_results.a_record` object. This field will indicate whether it was possible to validate the reverse DNS record. If the `validation_results.a_record.valid` is `false`, this indicates only that Twilio SendGrid could not determine the validity your reverse DNS record — it may still be valid.\n\nIf validity couldn’t be determined, you can check the value of `validation_results" } ] } ], "bundled": true }