Create Asset IP

Creates a new asset IP address.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

POST /api/sonar/ip-addresses

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d ip="192.168.1.100" \
     -d hostname="server01" \
     -d description="Web server" \
     -d scoring_type="priority" \
     -d priority=high \
     -X POST \
     https://HOSTNAME/api/sonar/ip-addresses

Request Parameters

Key	Required	Type	Description	Note
guid	X	String	IP address GUID	36-character GUID. Randomly generated if not set
ip	O	String	IP address
site_guid	X	String	Site GUID	36 characters
category_guid	X	String	Category GUID	36 characters
description	X	String	Description	Maximum 2000 characters
emp_guid	X	String	Primary contact GUID	36 characters
emp_guid2	X	String	Secondary contact GUID	36 characters
hostname	X	String	Hostname	Maximum 255 characters
os_name	X	String	OS name	Maximum 50 characters
os_ver	X	String	OS version	Maximum 20 characters
workgroup	X	String	Workgroup	Maximum 255 characters
location	X	String	Location	Maximum 255 characters
mac	X	String	MAC address
installed	X	String	Installation date	`yyyy-MM-dd'T'HH:mm:ss.SSSX` format
scoring_type	O	String	Scoring type	`priority` or `cia`
priority	X	String	Priority	Required when scoring_type is `priority`. One of `low`, `medium`, `high`
confidentiality	X	String	Confidentiality	Required when scoring_type is `cia`. One of `low`, `medium`, `high`
integrity	X	String	Integrity	Required when scoring_type is `cia`. One of `low`, `medium`, `high`
availability	X	String	Availability	Required when scoring_type is `cia`. One of `low`, `medium`, `high`

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
  "error_code": "null-argument",
  "error_msg": "ip should be not null"
}

Invalid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

CIA values included when scoring_type is priority

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'confidentiality', 'integrity', 'availability' must not be set when type is 'priority'."
}

Priority value included when scoring_type is cia

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'priority' must not be set when type is 'cia'."
}

Invalid priority value

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'priority' should be one of 'low', 'medium', 'high'."
}

Invalid CIA value

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'confidentiality' should be one of 'low', 'medium', 'high'."
}

Unsupported scoring_type

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "unsupported type: ABC"
}

Duplicate IP address

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "duplicate ip address: 192.168.1.100"
}

No permission

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}