API: Scan Properties¶

Make sure to read the API Overview before reading this document.

Creating a Scan Property¶

Variable	Description
section	Must be set to `scan_properties`.
action	Must be set to `create`.
api_key	Must be set to your unique API key.
scan_id	An integer or set of integers specifying the set of scan IDs you would like to create property for. You can specify a single integer or a comma-separated list of integers (Examples: `1005` or `1005,1010,1254`).
name	A string which specifies the name of your new property. Case-sensitive. Limited to 100 characters.
value	A string which specifies the value of your new property. Case-sensitive. Limited to 100 characters.

If your scan property is successfully created, we will respond with raw XML containing a status of 1.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <status>1</status>
</xml>

Variable	Description
section	Must be set to `scan_properties`.
action	Must be set to `retrieve`.
api_key	Must be set to your unique API key.
scan_id	An integer which specifies your scan ID.
name	A string which specifies the name of the property. Not case sensitive. Limited to 100 characters.

If we successfully receive your variables, we will respond with raw XML containing status and scan property information.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <status>1</status>
    <value>40820</value>
</xml>

Variable	Description
section	Must be set to `scan_properties`.
action	Must be set to `delete`.
api_key	Must be set to your unique API key.
scan_id	An integer which specifies your scan ID.
name	A string which specifies the name of the property. Case-sensitive. Limited to 100 characters.

If your scan property is successfully deleted, we will respond accordingly with raw XML containing a status of 1.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <status>1</status>
</xml>