IP Blocklist Monitoring

Lists monitored IP addresses

SecuritybasicAuth
Request
query Parameters
limit
string

Limit

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
Array
ip
required
string
ip_pool
required
string
description
required
string
state
required
string
required
Array of objects
400

A 400 response

401

A 401 response

get/v1/inboxready/ip_addresses
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ]
}
Register an IP address
SecuritybasicAuth 
Request 
Request Body schema: application/json
optional
ip
required
string
 
ip_pool
required
string
 
description
required
string
 
Responses 
201
A 201 response


Response Schema: application/json
ip
required
string
 
ip_pool
required
string
 
description
required
string
 
state
required
string
 
required
Array of objects
 
400
A 400 response


401
A 401 response


409
A 409 response


post/v1/inboxready/ip_addresses
Request samples 
application/json
null
Response samples 
application/json
[
  • {
    • "description": "this is a description",
    • "ip": "127.0.0.1",
    • "ippool": "swimming",
    • "listed": [],
    • "state": "listed"
    }
]
Get the IP address
SecuritybasicAuth 
Request 
path Parameters
ip
required
string
IP address


 
Responses 
200
A 200 response


Response Schema: application/json
ip
required
string
 
ip_pool
required
string
 
description
required
string
 
state
required
string
 
required
Array of objects
 
400
A 400 response


401
A 401 response


404
A 404 response


get/v1/inboxready/ip_addresses/{ip}
Request samples 
Response samples 
application/json
[
  • {
    • "description": "this is a description",
    • "ip": "127.0.0.1",
    • "ippool": "swimming",
    • "listed": [],
    • "state": "listed"
    }
]
Update the IP address
SecuritybasicAuth 
Request 
path Parameters
ip
required
string
IP address


 
Request Body schema: application/json
optional
ip_pool
required
string
 
description
required
string
 
Responses 
200
A 200 response


Response Schema: application/json
ip
required
string
 
ip_pool
required
string
 
description
required
string
 
state
required
string
 
required
Array of objects
 
400
A 400 response


401
A 401 response


404
A 404 response


put/v1/inboxready/ip_addresses/{ip}
Request samples 
application/json
{
  • "description": "string",
  • "ip_pool": "string"
}
Response samples 
application/json
[
  • {
    • "description": "this is a description",
    • "ip": "127.0.0.1",
    • "ippool": "swimming",
    • "listed": [],
    • "state": "listed"
    }
]
Removes IP from monitoring
SecuritybasicAuth 
Request 
path Parameters
ip
required
string
IP address


 
Responses 
204
A 204 response


400
A 400 response


401
A 401 response


404
A 404 response


delete/v1/inboxready/ip_addresses/{ip}
Request samples 
Response samples 
application/json
{
  • "message": "description of the error"
}
Cookie PolicyGDPR Email ComplianceAcceptable Use PolicyTerms of ServicePrivacy Policy
© 2024 Sinch Mailgun. All rights reserved.