UPupguard
vendors

List vendor assessments

Changed on

Returns a list of assessments for a specific vendor. Each assessment groups together versions over time.

Note: use /api/public/vendor/security_profile/assessment instead for security profile assessments.

Required API key permissions: VendorRisk (select when creating API key in Account Settings)

get/vendor/assessment/list

Request

Query parameters

vendor_idinteger

The ID of the vendor for which to return assessments. e.g. 123456789 Required when vendor_primary_hostname is not specified.

vendor_primary_hostnamestring

The primary hostname of the vendor for which to return assessments. e.g. "upguard.com" Required when vendor_id is not specified.

statusstring

Filter by assessment state. Valid values: active, archived, all Defaults to 'active' if not set.

Response

List of vendor assessments

Example response

{
  "assessments": [
    {
      "archived_at": "2024-06-01T10:00:00Z",
      "author_email": "john.smith@example.com",
      "author_name": "John Smith",
      "id": 1234567890123,
      "name": "Q1 2024 Security Assessment",
      "published_date": "2024-03-20T15:30:00Z",
      "reassessment_date": "2024-12-31T00:00:00Z",
      "scope": [
        "upguard.com",
        "api.upguard.com"
      ],
      "status": "published",
      "version_number": 2
    }
  ]
}

Changes