API Documentation — version 1
Hardware
Sample API URLs
To get all hardware items:
https://{your-site}.vendorrisk.com/api/v1/hardware.xml?token={api_key}
XML output:
<hardwares>
<hardware>
[see fields below]
</hardware>
<hardware>
[see fields below]
</hardware>
</hardwares>
To get a specific hardware item:
https://{your-site}.vendorrisk.com/api/v1/hardware/sample-hardware.xml?token={api_key}
XML output:
<hardware>
<vendor>Sample Vendor</vendor>
<name>Web Server</name>
<user>John Doe</user>
<contract>Hardware Agreement</contract>
<cost>10000</cost>
<po_number>12345-6789</po_number>
<serial_num>010010101010</serial_num>
<hardware_type>Server</hardware_type>
<location>Off-site</location>
<serial_num>010010101010</serial_num>
<description>Our new web server.</description>
<last_upgrade_date>12/11/2009</last_upgrade_date>
<last_upgrade_details></last_upgrade_details>
<acquired_date>12/11/2008</acquired_date>
<retired_date>12/11/2012</retired_date>
<support_end_date>12/11/2010</support_end_date>
<admin>Jane Doe</admin>
<reviewer>John Doe</reviewer>
<watchlist>Yes</watchlist>
<watchlist_reason></watchlist_reason>
<watchlist_mitigation></watchlist_mitigation>
<risk_level>High</risk_level>
<non_public_data>No</non_public_data>
<financial_data>No</financial_data>
<third_party_required>Yes</third_party_required>
<third_party>SysTrust</third_party>
<third_party_other></third_party_other>
<recovery_time>1 hour</recovery_time>
<recovery_point>1 hour</recovery_point>
<review_frequency>Quarterly</review_frequency>
<permalink>web-server</permalink>
<created_at>12/12/2009 8:00 PM</created_at>
<updated_at>01/25/2010 8:00 PM</updated_at>
</hardware>
