Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Create an IPRM rule  API call creates an IP rule, which will whitelist or blacklist an IP address. 


Sample request

POST https://api.armor.com/iprm/custom-rule


{
  "ip": "23.251.224.0",
  "rule": "blacklist",
  "expirationTime": "2018-07-24T17:37:31.327569Z"
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/iprm/custom-rulePOST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
ipThe IP address to configureIntegerRequired
  • 22.11.22.11
ruleTo allow (whitelist) or block (blacklist) the corresponding IP address

String

Required
  • whitelist
  • blacklist
expirationTime

The date that the rule will expire

If you have the Write Dynamic Threat Blocking Rule Never Expire IP permission assigned to your account, then to create a rule without an expiration date, you can enter: 9999-12-31T23:59:59.9999999Z

IntegerRequired
  • 2018-07-24T17:37:31.327569

Sample return

StatusResponse
200