--- title: "Get Asset Discovery Status" method: GET path: "/discovery/status/" tags: ["Asset Discovery"] --- # Get Asset Discovery Status `GET /discovery/status/` ## Response `200` - DiscoveryStatusSchema - `running_scans_count` integer, required — Number of asset discovery scans currently running. - `last_complete_scan` DiscoveryScan, required - `id` string, required — A unique Base58 value identifying this object. - `type` 'regular' | 'scheduled' — Type of asset discovery scan: * `regular` - Regular * `scheduled` - Scheduled - `created_at` string, date-time, required — Date and time of when the asset discovery scan was created, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" - `started_at` string, date-time, nullable — Date and time of when the asset discovery scan started, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" - `completed_at` string, date-time, nullable — Date and time of when the asset discovery scan completed, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" - `status` 'queued' | 'canceling' | 'canceled' | 'pending' | 'in_progress' | 'completed' | 'failed' — Status of the asset discovery scan: (Defaults to `pending`) * `queued` - Queued * `canceling` - Canceling * `canceled` - Canceled * `pending` - Pending * `in_progress` - In progress * `completed` - Completed * `failed` - Failed - `domain_then` Domain, required — Mixin to handle obfuscation of sensitive fields in serializers. - `hostname` string, required — Domain name with an associated IP address or an IP address itself. For example, "my.example.com", "example.com", or "37.139.17.48". The maximum length is 256 characters. - `id` string, required — A unique Base58 value identifying this object. - `verification_token` string, uuid, required — Token used to verify the domain. Read-only. - `verification_date` string, date-time, nullable, required — Date and time of the verification of the domain, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302" - `verification_method` 'file' | 'back_office' | 'existing_domain' | 'dns_txt' | 'dns' | 'dns_cname' | 'meta_tag' | 'whitelist' | 'email' | 'aws_route53' | 'cloudflare' | 'waved' | 'akamai', required — Method used in the domain verification: * `file` - Verifies the domain against a text file in the root directory of the website. Learn more in [this article](https://help.probely.com/en/articles/3289281-how-to-verify-the-ownership-of-a-target-using-a-txt-file). * `back_office` - Automatically set if manually verified in the back-office. Read-only. * `existing_domain` - Automatically set if the upper-level domain is verified. For example, "my.example.com" is automatically verified if "example.com" is verified. Read-only. * `dns_txt` - Verifies the domain against a TXT record in the Domain Name System (DNS). Learn more in [this article](https://help.probely.com/en/articles/3285635-how-to-verify-the-ownership-of-a-target-using-dns-txt-records). * `dns` - Same as `dns_txt`. * `dns_cname` - Verifies the domain against a CNAME record in the Domain Name System (DNS). Learn more in [this article](https://help.probely.com/en/articles/5642359-how-to-verify-the-ownership-of-a-target-using-dns-cname-records). * `meta_tag` - Verifies the domain against a meta tag in the index page of the website. Learn more in [this article](https://help.probely.com/en/articles/5642393-how-to-verify-the-ownership-of-a-target-using-a-meta-tag). * `whitelist` - Automatically verifies if the domain is in the whitelist * `email` - Automatically verifies a domain if the user's email is in the same domain as the target * `aws_route53` - Automatically verifies a domain if the hostname exists as an AWS Route53 Zone. * `cloudflare` - Automatically verifies a domain if the host name exists and is verified as a CloudflareZone. * `waved` - Automatically verifies a domain if there is a waver agreement. * `akamai` - Automatically verifies a domain if the host name exists as an AkamaiHost. - `verification_last_error` string, nullable, required — Error of the last verification of the domain. Empty if no error occurred. - `verified` boolean, required — If true, the domain is verified. Read-only. - `basic_auth_username` string, nullable — Username used for basic authentication. - `basic_auth_password` string, nullable — Password used for basic authentication. - `basic_auth_password_is_sensitive` boolean — Controls [sensitivity and obfuscation](https://help.probely.com/en/articles/12141165-how-to-manage-secrets-and-sensitive-data-in-snyk-api-web) of `basic_auth_password` field. If `true` the field is masked on Interfaces and Audit logs. When account's **Secrets Obfuscation setting** is also enabled, the API's field output will be `OBFUSCATED_`. - `port` integer, nullable — IP Port to send the requests to. If not defined, uses the default ports for HTTPS and HTTP (if the verification method requires making HTTP requests). - `discovery_enabled` boolean — If true, the domain is available for use in Asset Discovery. If false, the domain can only be used in targets. This parameter is only applicable if you are entitled to use Asset Discovery. You can contact Snyk API & Web's support to enable the feature. Learn more about Asset Discovery in the [Overview of Asset Discovery](https://help.probely.com/en/articles/9220762-overview-of-probely-s-asset-discovery). Defaults to true. - `source` Source, required - `id` string, required — Identifier of the source. - `name` string, required — Name of the source. The maximum length is 256 characters. - `next_scheduled_scan_at` string, date-time, required — Date and time of when the next asset discovery scan will start, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302". ## Other responses - `400` - `401` - `500` --- [API](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation.md) · [All operations](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/probely/snyk-api-web-s-api-reference-documentation/revisions/e29879bff01b/schema)