प्रमाणीकरण

बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/security/scan \
  -H "Authorization: Bearer zdk_live_…"

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह API विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

Queues an on-demand scan and answers 202 with the site's state, which will read scanning once the workflow starts. Gated on sites.view, not on a write key: asking for a fresh scan of your own site changes nothing about it, and it is the first thing a worried customer does. Concurrency is bounded by the workflow id, which is per site. A second request while a scan is running is still a 202 — a scan of this site is in progress, which is what was asked for — and no second scan of the same document root starts. 422 when the site is not running (a suspended or still-provisioning site has no document root to scan). 503 when the durable-execution service is unreachable: answering 202 there would flip the card to scanning… for a scan that was never started, and the customer would watch a spinner for hours.

पॅरामीटर्स

नावप्रकारआवश्यकहे काय आहे
siteId (path)UuidहोयSite ID (UUIDv7).

प्रतिसाद

नावप्रकारआवश्यकहे काय आहे
statusMalwareStatusहोयA site's scan verdict. There is deliberately no unscanned member: a site nothing has looked at yet is clean with last_scan_at: null, which is one nullable timestamp…
last_scan_atobjectहोयWhen a scan last completed. null = never scanned. A scan that failed does not stamp this, so a stale success can never be mistaken for a fresh one.
detectionsMalwareDetection[]होय
recent_resolutionsResolvedMalwareDetection[]होयFindings that were present and are not any more, most recently cleared first — the record of the protection having worked, which an all-clear alone cannot show. resolved_at
can_rescanbooleanहोयWhether rescanSite will accept a request for this site: false while a scan is already running, false for a site that is not running at all (there is no document root to scan),…
last_scan_error_codestring<, scan_conflict, scanner_unreachable, scanner_missing, scan_failed>होयWhy a scan that ran could not finish; empty when none has failed. Non-empty means an attempt was made against this site and broke — an unreachable host, a vendor error, a scan…
unavailable_reasonstringहोयWhy no scan was attempted; empty when one was. A stable machine identifier for the client to localise, never a sentence and never a vendor name. vendor_unsupported — the…
runtimeSiteRuntimeSecurityहोयWhat our runtime sensor saw happen on this site, and whether anything was watching it at all. The malware fields above are a verdict on files at rest; this is the other half —…

ही एंडपॉइंट परत करू शकेल अशा त्रुटी

401 · 403 · 404 · 422 · 429 · 503