UPupguard
vendors

Start monitoring a vendor

Request will fail if you are currently monitoring all the vendors you are licensed for in CyberRisk.

If your account keeps the vendor without monitoring it, the vendor keeps its portfolios, tier, labels and attributes. The labels param adds labels. It does not replace them. The tier param replaces the tier.

post/vendor/monitor

Request

Query parameters

idinteger

The ID of the vendor to begin monitoring. e.g. 123456789

hostnamestring

The hostname of the vendor to be monitored. e.g. "upguard.com". Required when id is not specified. When id is specified this field will be ignored.

labelsstring[]

The labels to assign to the vendor. If you want to update the labels for an already monitored vendor use the /vendor/labels endpoint.

tierinteger

The tier to assign to the vendor.

wait_for_scanboolean

Flag indicating whether the request should wait for scan results on new unknown vendors.

Response

The vendor was successfully added to the monitored list

assessment_statusstring

Assessment status for the vendor. Possible values are Published, In progress, Not assessed. The field will be omitted for non monitored vendors.

attributesobject

The attributes applied to the vendor. If no attributes are applied this field will be omitted

automatedScoreinteger

The automated score of the vendor without questionnaire. Omitted if no current scanning score.

domain_count_activeinteger

The total number of active domains for this vendor.

domain_count_inactiveinteger

The total number of inactive domains for this vendor.

domain_count_totalinteger

The total number of domains for this vendor.

first_monitoredstring

The date that this vendor was monitored by your organization.

idinteger

The id of the vendor. Its possible for a hostname to change which vendor it belongs to for a number of reasons (eg. Company's legal entity changes, improved data quality, etc...). For this reason, do not assume a hostname will always return the same vendor id.

industry_average_scoreinteger

The average overall score for the industry this vendor falls into.

industry_groupstring

The industry group this vendor falls into.

industry_sectorstring

The industry sector this vendor falls into. Industry sectors contain multiple industry groups.

labelsstring[]

The labels applied to the vendor. If no labels are present this field will be omitted.

last_assessedstring date-time

Date of the last assessment for the vendor. The field will be omitted if no published assessment is present.

lifecycle_stagestring

The lifecycle stage of the vendor in your account: procurement, onboarding, in_use, offboarding or archived. Omitted if the vendor has no stage.

namestring

The name of the vendor

notestring

The note applied to the vendor. If no note is applied this field will be omitted

overallScoreinteger

The current score of the vendor including automated and questionnaire. Omitted if no current overall score.

portfoliosstring[]

The portfolios applied to the vendor. If no portfolios are applied this field will be omitted

primary_hostnamestring

The primary hostname of the vendor

questionnaireScoreinteger

The current questionnaire score of the vendor. Omitted if no current questionnaire score.

reassessment_datestring date-time

Optional date of the next scheduled assessment for the vendor.

scoreinteger

NOTE: deprecated (use AutomatedScore). The current automated score of the vendor. A -1 value represents no current score for the vendor.

tierinteger

The tier applied to the vendor. If no tier is applied to the vendor this field will be omitted

Changes

No recorded changes to this operation across all 2 revisions of this API.