{"componentChunkName":"component---src-templates-api-js","path":"/api/ip-pools/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"IP Pools API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage IP pools, which allow you to group and assign dedicated IPs for sending."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"IP Pools"}},"content":[{"element":"copy","content":"<Banner status=\"info\"><a href=\"https://www.sparkpost.com/enterprise-email/\">Enterprise</a> customers, contact your TAM for details.</Banner>\n\n## IP Pool Object\n\n<DataStructure id=\"a8f22bfa3cd44b9d01a7eef12a7e75a1\"   sample=\"%7B%0A%20%20%20%20%22id%22%3A%20%22marketing_ip_pool%22%2C%0A%20%20%20%20%22name%22%3A%20%22Marketing%20IP%20Pool%22%2C%0A%20%20%20%20%22signing_domain%22%3A%20%22example.com%22%2C%0A%20%20%20%20%22fbl_signing_domain%22%3A%20%22sparkpostmail.com%22%2C%0A%20%20%20%20%22ips%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%22external_ip%22%3A%20%2254.244.54.135%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22hostname%22%3A%20%22mta472a.sparkpostmail.com%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22auto_warmup_enabled%22%3A%20true%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22auto_warmup_stage%22%3A%205%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%2C%0A%20%20%20%20%22auto_warmup_overflow_pool%22%3A%20%22overflow_pool%22%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Create an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools"}},"content":[{"element":"copy","content":"Creates an IP Pool and returns a unique ID based on the name. This ID is used for sending with this pool.\n\n<DataStructure id=\"5671f616eeae1173439bb02fb070186a\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\" : \"Marketing IP Pool\",\n      \"fbl_signing_domain\" : \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"id\": \"marketing_ip_pool\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\" : \"Marketing IP Pool\",\n      \"fbl_signing_domain\" : \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Auto Warmup Overflow Pool overflow_pool does not exist.\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\" : \"Marketing IP Pool\",\n      \"fbl_signing_domain\" : \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"overflow_pool has an overflow pool and cannot be an overflow pool\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"marketing_ip_pool"}}}]}},"content":[{"element":"copy","content":"Returns a specific IP Pool."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"id\": \"marketing_ip_pool\",\n          \"name\": \"Marketing IP Pool\",\n          \"fbl_signing_domain\": \"sparkpostmail.com\",\n          \"ips\": [\n              {\n                  \"external_ip\": \"54.244.54.135\",\n                  \"hostname\": \"mta472a.sparkpostmail.com\",\n                  \"auto_warmup_enabled\": true,\n                  \"auto_warmup_stage\": 5\n              },\n              {\n                  \"external_ip\": \"54.244.54.137\",\n                  \"hostname\": \"mta474a.sparkpostmail.com\",\n                  \"auto_warmup_enabled\": false\n              }\n          ],\n          \"signing_domain\": \"example.com\",\n          \"auto_warmup_overflow_pool\": \"overflow_pool\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"IP pool not found.\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"bc972aae04fe60f4b5ff7352e7b36528\"  ></DataStructure>\n\nTo update sending IP pool assignments see [Sending IPs](/api/sending-ips/)."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"name\": \"Updated Marketing Pool\",\n          \"fbl_signing_domain\": \"sparkpostmail.com\",\n          \"id\": \"marketing\",\n          \"auto_warmup_overflow_pool\": \"overflow_pool\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"IP Pool default is reserved and cannot be updated.\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Auto Warmup Overflow Pool overflow_pool does not exist.\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"overflow_pool has an overflow pool and cannot be an overflow pool\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"overflow_pool is an overflow pool and cannot have an overflow pool\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"AUTHORIZATION"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Updated Marketing Pool\",\n      \"fbl_signing_domain\": \"sparkpostmail.com\",\n      \"auto_warmup_overflow_pool\": \"overflow_pool\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"IP Pool not_a_real_pool does not exist.\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete an IP Pool"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"Deletes an IP Pool and moves all sending IPs in that pool to the default pool. The default pool cannot be deleted."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"IP Pool default is reserved.\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"IP Pool marketing does not exist.\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List IP Pools"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List IP Pools"}},"attributes":{"href":{"element":"string","content":"/v1/ip-pools"}},"content":[{"element":"copy","content":"Returns a list of all your IP Pools."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"aHR0cDovL2kuaW1ndXIuY29tL293UndTR3AucG5n"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"      {\n          \"results\": [\n              {\n                  \"id\": \"marketing_ip_pool\",\n                  \"name\": \"Marketing IP Pool\",\n                  \"ips\": [],\n                  \"signing_domain\": \"example.com\",\n                  \"fbl_signing_domain\": \"sparkpostmail.com\",\n                  \"auto_warmup_overflow_pool\": \"overflow_pool\"\n              },\n              {\n                  \"id\": \"default\",\n                  \"name\": \"Default\",\n                  \"ips\": [\n                      {\n                          \"external_ip\": \"54.244.54.135\",\n                          \"hostname\": \"mta472a.sparkpostmail.com\",\n                          \"auto_warmup_enabled\": true,\n                          \"auto_warmup_stage\": 5\n                      }\n                  ]\n              }\n          ]\n      }\n"}]}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"a8f22bfa3cd44b9d01a7eef12a7e75a1"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique pool identifier used through the Transmissions API and SMTP. Auto-generated when created."}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Name of the IP Pool"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"DKIM-verified signing domain"}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"FBL Signing Domain for the pool. Used only for emails to domains that require DKIM for FBL."}},"content":{"key":{"element":"string","content":"fbl_signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Sending IPs within the pool. Sending IP objects include fields `external_ip`,`hostname`, `auto_warmup_enabled` & `auto_warmup_stage`"}},"content":{"key":{"element":"string","content":"ips"},"value":{"element":"array","content":[{"element":"object"}]}}},{"element":"member","meta":{"description":{"element":"string","content":"IP Pool ID to be used as an overflow pool during auto IP warmup. Can specify `shared pool` to overflow to the SparkPost Shared Pool if you have access.<br/>The auto_warmup_overflow_pool `shared pool` is not available for <a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a></strong> customers"}},"content":{"key":{"element":"string","content":"auto_warmup_overflow_pool"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"5671f616eeae1173439bb02fb070186a"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name of the IP Pool"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Domain to use as the DKIM verified signing domain"}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"FBL Signing Domain for the pool"}},"content":{"key":{"element":"string","content":"fbl_signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"IP Pool ID to be used as an overflow pool during auto IP warmup. Can specify `shared pool` to overflow to the SparkPost Shared Pool if you have access.<br/>The auto_warmup_overflow_pool `shared pool` is not available for <a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a></strong> customers"}},"content":{"key":{"element":"string","content":"auto_warmup_overflow_pool"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"bc972aae04fe60f4b5ff7352e7b36528"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name of the IP Pool"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Domain to use as the DKIM verified signing domain. To remove it, set it to an empty string."}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"FBL Signing Domain for the pool. To remove it, set it to an empty string."}},"content":{"key":{"element":"string","content":"fbl_signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"IP Pool ID to be used as an overflow pool during auto IP warmup. Can specify `shared pool` to overflow to the SparkPost Shared Pool if you have access.<br/>The auto_warmup_overflow_pool `shared pool` is not available for <a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a></strong> customers"}},"content":{"key":{"element":"string","content":"auto_warmup_overflow_pool"},"value":{"element":"string"}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":2214},{"element":"number","content":283}]}]}]}},"content":"response payload `400` already defined for `POST` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5263},{"element":"number","content":273}]}]}]}},"content":"response payload `400` already defined for `PUT` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5536},{"element":"number","content":283}]}]}]}},"content":"response payload `400` already defined for `PUT` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5819},{"element":"number","content":284}]}]}]}},"content":"response payload `400` already defined for `PUT` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":3999},{"element":"number","content":46}]}]}]}},"content":"the resource '/v1/ip-pools/{id}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6360},{"element":"number","content":49}]}]}]}},"content":"the resource '/v1/ip-pools/{id}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7533},{"element":"number","content":7}]},{"element":"array","content":[{"element":"number","content":7548},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":7564},{"element":"number","content":24}]},{"element":"array","content":[{"element":"number","content":7596},{"element":"number","content":16}]},{"element":"array","content":[{"element":"number","content":7620},{"element":"number","content":45}]},{"element":"array","content":[{"element":"number","content":7673},{"element":"number","content":47}]},{"element":"array","content":[{"element":"number","content":7728},{"element":"number","content":30}]},{"element":"array","content":[{"element":"number","content":7766},{"element":"number","content":51}]},{"element":"array","content":[{"element":"number","content":7825},{"element":"number","content":61}]},{"element":"array","content":[{"element":"number","content":7894},{"element":"number","content":63}]},{"element":"array","content":[{"element":"number","content":7965},{"element":"number","content":17}]},{"element":"array","content":[{"element":"number","content":7990},{"element":"number","content":16}]},{"element":"array","content":[{"element":"number","content":8014},{"element":"number","content":35}]},{"element":"array","content":[{"element":"number","content":8057},{"element":"number","content":37}]},{"element":"array","content":[{"element":"number","content":8102},{"element":"number","content":27}]},{"element":"array","content":[{"element":"number","content":8137},{"element":"number","content":24}]},{"element":"array","content":[{"element":"number","content":8169},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":8235},{"element":"number","content":67}]},{"element":"array","content":[{"element":"number","content":8310},{"element":"number","content":55}]},{"element":"array","content":[{"element":"number","content":8373},{"element":"number","content":49}]},{"element":"array","content":[{"element":"number","content":8430},{"element":"number","content":24}]},{"element":"array","content":[{"element":"number","content":8462},{"element":"number","content":20}]},{"element":"array","content":[{"element":"number","content":8490},{"element":"number","content":16}]},{"element":"array","content":[{"element":"number","content":8514},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":8534},{"element":"number","content":8}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, separate it by a newline and indent every of its line by 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7258},{"element":"number","content":37}]}]}]}},"content":"the resource '/v1/ip-pools' is already defined"}]},"TableOfContents":[{"anchor":"#ip-pools","title":"IP Pools","children":[{"anchor":"#header-ip-pool-object","title":"IP Pool Object"},{"anchor":"#ip-pools-create-an-ip-pool","title":"Create an IP Pool","children":[{"anchor":"#ip-pools-post-create-an-ip-pool","title":"Create an IP Pool"}]},{"anchor":"#ip-pools-retrieve-an-ip-pool","title":"Retrieve an IP Pool","children":[{"anchor":"#ip-pools-get-retrieve-an-ip-pool","title":"Retrieve an IP Pool"}]},{"anchor":"#ip-pools-update-an-ip-pool","title":"Update an IP Pool","children":[{"anchor":"#ip-pools-put-update-an-ip-pool","title":"Update an IP Pool"}]},{"anchor":"#ip-pools-delete-an-ip-pool","title":"Delete an IP Pool","children":[{"anchor":"#ip-pools-delete-delete-an-ip-pool","title":"Delete an IP Pool"}]},{"anchor":"#ip-pools-list-ip-pools","title":"List IP Pools","children":[{"anchor":"#ip-pools-get-list-ip-pools","title":"List IP Pools"}]}]}],"meta":{"title":"IP Pools API","description":"Manage IP pools, which allow you to group and assign dedicated IPs for sending.","full":false},"fields":{"path":"/api/ip-pools/"}}},"pageContext":{"file":"ip-pools.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}