Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Target Of Evaluation TOE

This endpoint allows the user to search for a TOE by a valid domain or hostname.

This endpoint allows the user to search for a TOE by a valid domain or hostname. The user must provide a valid domain or hostname in domain query param.

get/v1/toes/by_domains

Query parameters

domainstring required
Example:riskrecon.com

Search TOEs by domain or hostname. This must be a valid domain or hostname.

Response

OK

toe_idstring uuid

The unique identifier for the Target Of Evaluation (TOE).

toe_namestring

The Company or entity name.

seed_hostnamesstring[]

The seed hostnames are the hostnames used to start the scan. This doesn't include all hostnames from the scan results.

toe_typestring nullable

The TOE category.

subscribedboolean

Is the current user subscribed?.

subscription_level'AUTO' | '1' | '2' | '3' nullable

The subscription level for the TOE.

assessment_frequency'one_time' | 'continuous' nullable

Scan frequency. This must be either one_time or continuous. The default is continuous.

hq_locationstring nullable

The location of company headquarters if available.

duns_numbersstring[]

The DUNS number for the TOE. This may or may not be populated.

toe_sizestring nullable

The text description of TOE size.

Example response

[
  {
    "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
    "toe_name": "Riskrecon, CO.",
    "seed_hostnames": [
      "riskrecon.com"
    ],
    "toe_type": "parent",
    "subscription_level": "2",
    "assessment_frequency": "continuous",
    "hq_location": "Sampson street",
    "duns_numbers": [
      "12345"
    ],
    "toe_size": "xl"
  }
]