{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-reverse-dns-v3/list-reverse-dns":{"get":{"operationId":"communication_sendgrid_reverse_dns_v3_list_reverse_dns","summary":"Retrieve all reverse DNS records","description":"GET /v3/whitelabel/ips","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"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…","schema":{"type":"integer","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…"}},{"name":"offset","in":"query","required":false,"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`…","schema":{"type":"integer","default":0,"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`…"}},{"name":"ip","in":"query","required":false,"description":"The IP address segment that you'd like to use in a prefix search.","schema":{"type":"string","description":"The IP address segment that you'd like to use in a prefix search."}},{"name":"on-behalf-of","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-reverse-dns-v3/set-up-reverse-dns":{"post":{"operationId":"communication_sendgrid_reverse_dns_v3_set_up_reverse_dns","summary":"Set up reverse DNS","description":"POST /v3/whitelabel/ips","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"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…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-reverse-dns-v3/get-reverse-dns":{"get":{"operationId":"communication_sendgrid_reverse_dns_v3_get_reverse_dns","summary":"Retrieve a reverse DNS record","description":"GET /v3/whitelabel/ips/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the reverse DNS record that you would like to retrieve.","schema":{"type":"string","description":"The ID of the reverse DNS record that you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-reverse-dns-v3/delete-reverse-dns":{"post":{"operationId":"communication_sendgrid_reverse_dns_v3_delete_reverse_dns","summary":"Delete a reverse DNS record","description":"DELETE /v3/whitelabel/ips/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the reverse DNS record that you would like to retrieve."},"on-behalf-of":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-reverse-dns-v3/validate-reverse-dns":{"post":{"operationId":"communication_sendgrid_reverse_dns_v3_validate_reverse_dns","summary":"Validate a reverse DNS record","description":"POST /v3/whitelabel/ips/{id}/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the reverse DNS record that you would like to validate."},"on-behalf-of":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}