...
Prior to Hillary R1, the locations/target configuration could be created and edited via the iQSonar user interface, or optionally by uploading a CSV file. The facility to modify (add and remove) target configurations via the RestAPI was initially introduced in Hillary R1 and further refined in Hillary R2. At the time of writing, the facility to modify credentials is still restricted to CSV import or manual editing via the User Interface
Instructions
Target configuration via the RestAPI relies on data stored in the JSON file format, rather than CSV files. The data stored in the file is the same, but the format of the file is quite different. To edit a JSON file and text editor can be used (for example Notepad) but an editor specifically designed for use by Programmers (for example Notepad++) would be preferred.
...
| Field | Description | Can be empty? | Example or Possible Values |
|---|---|---|---|
| LocationPath | Name of the location. Sub-locations seperated by the pipe symbol "|" | NO | Sample|Node Sample|Node2|Leaf1 Sample|Node2|Leaf2 |
| Target | What category of target is this (Either Application or Device) | NO | Device Application |
| Type | What sub-type of target is this (What type of Device, or Which Application) | NO | See the list of valid target types |
| Name | The name of the location (This is a freeform text field) | NO | Main Lab QA Lab My Test Location |
| Instance Name | The name of the database instance | YES | For scanning database application targets |
| Hostname | The host name for hostname targets | YES | vm-test.localdomain www.myserver.example.com vm-myserver |
| StartIP | The Start IP Address - use this for Application targets, Single, Range and Subnet targets | YES | 10.0.0.1 |
| EndIP | The End IP Address - use this for Range targets only | YES | 10.0.0.99 |
| SubnetMask | The netmask - as a number not as a dotted quat quad - use for Subnet targets only | YES | Use "24" not "255.255.255.0" "0" can be used for an empty target |
| Port | The port on which to scan, for Application Targets only | YES | E.g. scan a web server on port 80 usually, but might also be port 8080 |
| Exclusion | Whether this is a target exclusion. Use to exclude IP addresses from a larger list | YES | Must be "True" or "False". Empty implies False |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Name":"LOCATION TARGET",
"Version":"1.3",
"Locations":
[
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Hostname",
"Name":"Hostname Target 1",
"InstanceName":"",
"Hostname":"vm-myserver",
"StartIP":"",
"EndIP":"",
"SubnetMask":"0",
"Port":"",
"Exclusion":""
},
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Single",
"Name":"Single IP Address",
"InstanceName":"",
"Hostname":"",
"StartIP":"10.0.0.1",
"EndIP":"",
"SubnetMask":"0",
"Port":"",
"Exclusion":""
},
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Range",
"Name":"Multiple IP Addresses",
"InstanceName":"",
"Hostname":"",
"StartIP":"10.0.0.2",
"EndIP":"10.0.0.99",
"SubnetMask":"0",
"Port":"",
"Exclusion":""
},
{
"LocationPath":"Demo|SecondNetwork",
"Target":"Device",
"Type":"Subnet",
"Name":"Different network",
"InstanceName":"",
"Hostname":"",
"StartIP":"192.168.1.0",
"EndIP":"",
"SubnetMask":"24",
"Port":"",
"Exclusion":""
}
]
} |
...