Views:
Quarantine an IP address and create a response.

Definition

quarantine/quarantine

Parameters

Parameter Type Description
ip IP address IP address for the target host. Required to create or close a response.
id integer Response History ID that is displayed in the Response History table on the SMS.
  • To close a response, either IP or ID must be specified.
policy string Specific Active Response Policy to implement.
  • The policy name is case sensitive and must match an existing SMS Active Response policy name.
  • The Allow an SNMP Trap or Web Service call to invoke this Policy initiation setting must be enabled for this policy.
  • This argument is not necessary to close a response and, if provided, is ignored.
timeout long Optional argument to specify the duration of response.
  • The specified value overrides the default already in the policy.
  • If no parameter is specified, the timeout value from the policy is used.
  • This argument is not necessary to close a response and, if provided, is ignored.

Example

curl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/quarantine/
quarantine?ip=<target_ip>&policy=<policy_name>&timeout=<minutes_to_quarantine>"