Sign in to fill these examples with your own keys. Sign in Start free trial

Firewall

Pre-send recipient checks for the token's team.

Pre-send recipient checks for the token's team. Toggle catalog checks, then add deny or allow domains and addresses. Allow wins. SMTP uses the same policy.

GET /api/v1/teams/:obfuscated_team_id/firewall

Get the team's firewall. available_checks is the live catalog.

request.sh
1curl -sS -X GET \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 https://app.postshiba.com/api/v1/teams/KjkAJW/firewall
response.json
1{ 2 "enabled_checks": [ 3 "temp_providers", 4 "plus_addressing" 5 ], 6 "available_checks": [ 7 "temp_providers", 8 "free_providers", 9 "plus_addressing" 10 ], 11 "entries": [ 12 { 13 "id": "BnMkLo", 14 "list": "deny", 15 "value": "mailinator.com", 16 "created_at": "2026-08-31T00:00:00Z" 17 } 18 ] 19}

PATCH /api/v1/teams/:obfuscated_team_id/firewall

Replace enabled_checks. Unknown ids are rejected. Missing checks are off.

request.sh
1curl -sS -X PATCH \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 -H 'Content-Type: application/json' \ 4 -d '{"firewall":{"enabled_checks":["temp_providers","plus_addressing"]}}' \ 5 https://app.postshiba.com/api/v1/teams/KjkAJW/firewall
response.json
1{ 2 "enabled_checks": [ 3 "temp_providers", 4 "plus_addressing" 5 ], 6 "available_checks": [ 7 "temp_providers", 8 "free_providers", 9 "plus_addressing" 10 ], 11 "entries": [ 12 { 13 "id": "BnMkLo", 14 "list": "deny", 15 "value": "mailinator.com", 16 "created_at": "2026-08-31T00:00:00Z" 17 } 18 ] 19}

POST /api/v1/teams/:obfuscated_team_id/firewall_entries

Add a deny or allow value. Domains match subdomains. Addresses match the plus-stripped mailbox.

request.sh
1curl -sS -X POST \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 -H 'Content-Type: application/json' \ 4 -d '{"firewall_entry":{"list":"deny","value":"mailinator.com"}}' \ 5 https://app.postshiba.com/api/v1/teams/KjkAJW/firewall_entries
response.json
1{ 2 "id": "BnMkLo", 3 "list": "deny", 4 "value": "mailinator.com", 5 "created_at": "2026-08-31T00:00:00Z" 6}

DELETE /api/v1/firewall_entries/:id

Remove a deny or allow value.

  • id: Public firewall entry id
request.sh
1curl -sS -X DELETE \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 https://app.postshiba.com/api/v1/firewall_entries/:firewall_entry_id