Was zurückkommt

Teil der API-Referenz. Authentifizierung, Scopes, Anfragegrenzen und Fehler stehen im Überblick.

BitHive Reporting Desk API · 0.11.0

Was zurückkommt

`ContractState`

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`kind` erforderlich	string	notice_clause für eine Mitteilungsklausel eines Kunden, gdpr_controller für einen Verantwortlichen, für den das Konto personenbezogene Daten verarbeitet.
`counterparty` erforderlich	string
`archived_at` erforderlich	string,null (date-time)	Wann der Vertrag archiviert wurde; null, solange er in Verwendung ist.

`Product`

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`name` erforderlich	string
`created_at` erforderlich	string (date-time)
`archived` erforderlich	boolean	Ein archiviertes Produkt wird nicht mehr überwacht.

`ProductList`

Parameter	Typ	Beschreibung
`products` erforderlich	Array von object

`SBOM`

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`product_id` erforderlich	string (uuid)
`format` erforderlich	string
`spec_version` erforderlich	string	Version der Spezifikation, der das Dokument folgt, zum Beispiel 1.6 oder SPDX-2.3.
`sha256` erforderlich	string	SHA-256 des gespeicherten Dokuments, hexadezimal in Kleinbuchstaben. Es adressiert das Dokument.
`component_count` erforderlich	integer	Komponenten, die das Dokument aufgeführt hat, nach Entfernen von Wiederholungen.
`source` erforderlich	string	Ob der Upload über die Oberfläche oder über diese API kam.
`created_at` erforderlich	string (date-time)
`release`	string	Die Produktversion, die das Dokument beschreibt. Fehlt, wenn niemand sie benannt hat und das Dokument keine angab.
`on_market` erforderlich	boolean	Die Produktversion ist auf dem Markt und bleibt deshalb auch nach neueren Uploads überwacht.
`monitored` erforderlich	boolean	Abgleich und Fälle folgen diesem Upload, weil er auf dem Markt ist oder der neueste des Produkts ist.
`on_market_refused`	boolean	Nur in der Antwort auf einen Upload: on_market=true wurde verlangt, während das Produkt bereits 25 Produktversionen auf dem Markt hatte. Das Dokument wird trotzdem gespeichert und überwacht, solange es der neueste Upload ist.
`generated_from`	Array von string	Nur bei einem Dokument, das der Reporting Desk aus Lockfiles oder Manifesten geschrieben hat (API 0.9.0): die Namen der Dateien, ohne ihre Verzeichnisse.
`partial`	boolean	Nur bei einem Dokument, das der Reporting Desk geschrieben hat, und nur, wenn true: Die Dateien nennen nur einen Teil dessen, was der Build verwendet (eine pom.xml nennt keine transitive Abhängigkeit, eine requirements.txt ohne `--hash` in jeder festgelegten Zeile muss es nicht, und ein go.mod für ein Go vor 1.17 nennt nur die direkten), deshalb werden die Komponenten, die nicht im Dokument stehen, nicht überwacht.
`left_out`	integer	Nur bei einem teilweisen Dokument, das der Reporting Desk geschrieben hat: wie viele Abhängigkeiten die Dateien ohne exakte Version genannt und deshalb ausgelassen haben.

`ReleaseChange`

Parameter	Typ	Beschreibung
`release`	string	Der neue Name der Produktversion; eine leere Zeichenkette entfernt ihn.
`on_market`	boolean	True bringt die Produktversion auf den Markt, false nimmt sie vom Markt.

`SBOMList`

Parameter	Typ	Beschreibung
`sboms` erforderlich	Array von object

`Component`

Parameter	Typ	Beschreibung
`name` erforderlich	string
`version` erforderlich	string	Leer, wenn das Dokument keine Version angab; eine solche Komponente kann nicht abgeglichen werden.
`purl` erforderlich	string	Package-URL, wie das Dokument sie enthielt; leer, wenn es keine enthielt.

`ComponentList`

Parameter	Typ	Beschreibung
`components` erforderlich	Array von object
`total` erforderlich	integer

`Finding`

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`component` erforderlich	object
`vulnerability` erforderlich	object
`evidence` erforderlich	string	Ob die Quelle die betroffene Version ausdrücklich nannte oder ob die Version mit einem veröffentlichten Bereich verglichen wurde; `cpe`, wenn eine Komponente ohne abgeglichene Paket-URL über ihren CPE-Namen und die betroffenen Versionen der NVD abgeglichen wurde, sodass der Build eine zurückportierte Korrektur enthalten kann; `check`, wenn ihr CPE keinen Hersteller nennt und sie nur über das Produkt abgeglichen wurde, was keinen Vorgang und keine Alarmierung auslöst, bis eine Person den Hersteller in der Oberfläche bestätigt.
`matched_range`	string	Der Bereich, der über einen verglichenen Treffer entschied.
`state` erforderlich	string
`exploited` erforderlich	boolean	Die Schwachstelle ist als ausgenutzt bekannt, was die 24-Stunden-Meldung auslöst.
`exploited_cve`	string	Die Kennung, unter der der Katalog ausgenutzter Schwachstellen sie führt.
`exploited_since`	string (date)	Der Tag, an dem der Katalog sie aufnahm.
`ransomware` erforderlich	boolean	Der Katalog hat sie mit einer Ransomware-Kampagne in Verbindung gebracht.
`first_seen_at` erforderlich	string (date-time)	Wann der Reporting Desk diesen Befund zuerst sah. Meldefristen werden ab unserer eigenen Kenntnis gemessen.
`last_seen_at` erforderlich	string (date-time)
`sbom_id` erforderlich	string (uuid)	Der überwachte Upload, in dem der Befund festgestellt wurde.
`release`	string	Die Produktversion, die dieser Upload beschreibt. Fehlt, wenn niemand sie benannt hat.
`decision`	object	Die geltende Aussage zur Produktversion und zur Schwachstelle. Fehlt, wenn keine gilt oder die Produktversion keinen Namen hat.

`Decision`

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`release` erforderlich	string
`vulnerability` erforderlich	string	Die Kennung der Schwachstelle, wie die Befunde sie nennen.
`status` erforderlich	string
`justification`	string	Warum die Produktversion nicht betroffen ist; nur bei not_affected.
`impact_statement`	string	Warum die Produktversion nicht betroffen ist, in den Worten des Kontos; nur bei not_affected.
`action_category`	string	Die Abhilfe; nur bei affected.
`action_statement`	string	Was die Kunden des Kontos tun sollten; nur bei affected.
`decided_at` erforderlich	string (date-time)
`supersedes`	string (uuid)	Die Aussage, an deren Stelle diese getreten ist; fehlt bei der ersten ihrer Produktversion und Schwachstelle.
`finding_id`	string (uuid)	Der Befund, an dem sie getroffen wurde; fehlt, sobald der Abgleich diesen Befund ersetzt hat oder wenn sie über die API getroffen wurde.
`stale` erforderlich	boolean	Der Hinweis hat sich geändert, nachdem die Aussage getroffen wurde, oder danach wurde eine Komponente abgeglichen. Die Aussage gilt weiter, bis jemand neu entscheidet.

`DecisionList`

Parameter	Typ	Beschreibung
`decisions` erforderlich	Array von object

`NewDecision`

Parameter	Typ	Beschreibung
`releases` erforderlich	Array von string	Die benannten Produktversionen, um die es in der Aussage geht; für jede wird eine Aussage geschrieben.
`vulnerability` erforderlich	string
`status` erforderlich	string
`justification`	string
`impact_statement`	string
`action_category`	string
`action_statement`	string

`FindingList`

Parameter	Typ	Beschreibung
`findings` erforderlich	Array von object
`total` erforderlich	integer
`exploited` erforderlich	integer	Wie viele davon eine Meldefrist auslösen.

`NotMonitoredGroup`

Parameter	Typ	Beschreibung
`reason` erforderlich	string
`ecosystem`	string	Das Ökosystem, wenn der Grund eines betrifft, damit ein Client sieht, dass es um Alpine geht und nicht nur, dass etwas nicht unterstützt wird.
`explanation`	string	Was genau ungelöst ist. Bei „version could not be read“: Diese Versionen lassen sich nicht ordnen und werden deshalb nicht gegen Advisories geprüft, die einen Bereich betroffener Versionen angeben; gegen Advisories, die ihre genaue Version nennen, werden sie weiterhin abgeglichen. Eine solche Komponente kann also Befunde haben und trotzdem hier als nicht überwacht zählen.
`components` erforderlich	integer

`Coverage`

Parameter	Typ	Beschreibung
`sbom_id`	string (uuid)	Der Upload, den dies beschreibt; fehlt, wenn das Produkt keinen hat.
`components` erforderlich	integer
`monitored` erforderlich	integer
`monitored_percent` erforderlich	number	Der überwachte Anteil, auf eine Nachkommastelle gerundet.
`not_monitored` erforderlich	Array von object

`CaseList`

Parameter	Typ	Beschreibung
`cases` erforderlich	Array von object
`next_cursor` erforderlich	stringnull	Als `cursor` gesendet, liest er die nächste Seite; auf der letzten Seite null.

`CaseSummary`

Ein CRA-Fall, wie eine Liste ihn zeigt.

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`type` erforderlich	string	Der Auslöser nach Artikel 14 Absatz 1 oder 3.
`state` erforderlich	string	Wie weit der Fall ist: offen, Stufe für Stufe als eingereicht erfasst, nach dem Abschlussbericht abgeschlossen oder verworfen.
`product_id` erforderlich	string (uuid)
`cve` erforderlich	stringnull	Die CVE, die der Katalog ausgenutzter Schwachstellen nennt, oder die mit dem Fall eingegebene.
`euvd_id` erforderlich	stringnull	Die mit dem Fall eingegebene Kennung der EU-Schwachstellendatenbank.
`advisory_id` erforderlich	stringnull	Der Hinweis, gegen den die Komponenten des Produkts abgeglichen wurden.
`detected_at` erforderlich	string (date-time)	Wann der Fall erfasst wurde. Ändert sich nie.
`became_aware_at` erforderlich	string (date-time)	Wann der Hersteller Kenntnis erlangt hat; ab diesem Zeitpunkt laufen die Fristen von 24 und 72 Stunden.
`next_deadline` erforderlich	object oder null	Die Stufe, deren gespeicherte Frist als Nächstes ansteht und noch nicht erfüllt ist. null, wenn der Fall keine offene Frist hat: immer bei einem abgeschlossenen oder verworfenen Fall, aber auch bei einem laufenden Fall, solange die Frist der nächsten Meldung noch nicht begonnen hat, etwa beim Abschlussbericht zu einer Schwachstelle, solange `fix_available_at` nicht erfasst ist. null heißt nicht, dass keine Meldung geschuldet ist; lesen Sie dazu den Stand des Falls.

`CaseDueStage`

Parameter	Typ	Beschreibung
`stage` erforderlich	string
`due_at` erforderlich	string (date-time)

`Case`

Ein CRA-Fall mit seinen gespeicherten Fristen und dem Stand der Meldung jeder Stufe.

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`type` erforderlich	string
`state` erforderlich	string
`product_id` erforderlich	string (uuid)
`cve` erforderlich	stringnull
`euvd_id` erforderlich	stringnull
`advisory_id` erforderlich	stringnull
`detected_at` erforderlich	string (date-time)
`became_aware_at` erforderlich	string (date-time)
`next_deadline` erforderlich	object oder null	Die Stufe, deren gespeicherte Frist als Nächstes ansteht und noch nicht erfüllt ist. null, wenn der Fall keine offene Frist hat: immer bei einem abgeschlossenen oder verworfenen Fall, aber auch bei einem laufenden Fall, solange die Frist der nächsten Meldung noch nicht begonnen hat, etwa beim Abschlussbericht zu einer Schwachstelle, solange `fix_available_at` nicht erfasst ist. null heißt nicht, dass keine Meldung geschuldet ist; lesen Sie dazu den Stand des Falls.
`first_notified_at` erforderlich	string,null (date-time)	Die erste erfolgreiche Zustellung eines Alarms zu dem Fall; null, solange keiner zugestellt wurde.
`first_acknowledged_at` erforderlich	string,null (date-time)	Wann eine Person den Fall erstmals bestätigt hat.
`fix_available_at` erforderlich	string,null (date-time)	Wann eine Korrektur- oder Abhilfemaßnahme verfügbar wurde; ab diesem Zeitpunkt läuft die Frist für den Abschlussbericht zu einer Schwachstelle.
`occurred_at` erforderlich	string,null (date-time)	Wann der schwere Vorfall eingetreten ist, nach Angabe des Herstellers.
`deadlines` erforderlich	Array von object	Die gespeicherten Fristen in der Reihenfolge ihrer Fälligkeit. Eine Stufe, die noch auf ihren Ausgangszeitpunkt wartet, hat noch keine.
`reports` erforderlich	Array von object	Die Meldung jeder Stufe: Frühwarnung, Schwachstellen- oder Vorfallmeldung und Abschlussbericht, in dieser Reihenfolge.

`CaseDeadline`

Parameter	Typ	Beschreibung
`stage` erforderlich	string
`due_at` erforderlich	string (date-time)
`basis` erforderlich	string	Der Zeitpunkt, ab dem die Frist zählt.
`basis_at` erforderlich	string (date-time)
`met_at` erforderlich	string,null (date-time)	Wann die Meldung der Stufe eingereicht wurde, laut Erfassung; bis dahin null.
`on_time` erforderlich	booleannull	Ob die Meldung der Stufe bis `due_at` eingereicht wurde: true, wenn `met_at` nicht nach due_at liegt; null, solange keine Einreichung erfasst ist. Verglichen werden die beiden Zeitpunkte, wie BitHive sie gespeichert hat. `due_at` zählt ab dem Zeitpunkt, zu dem die Frist der Stufe beginnt: bei der Frühwarnung und der Schwachstellen- oder Vorfallmeldung ab der Kenntnisnahme, beim Abschlussbericht zu einer Schwachstelle ab `fix_available_at` und beim Abschlussbericht zu einem schweren Vorfall ab der erfassten Übermittlung der Vorfallmeldung. Ändert sich dieser Zeitpunkt, verschiebt sich `due_at`, und `on_time` kann sich ändern. Darüber hinaus sagt der Wert nichts über die Pflicht aus.
`rule` erforderlich	string	Die Regel, die die Frist berechnet hat; leer bei einer Frist, die eine frühere Version geschrieben hat, bis sie ihre Regel erhält.
`rule_version` erforderlich	integer

`CaseReport`

Parameter	Typ	Beschreibung
`stage` erforderlich	string
`state` erforderlich	string	Keine Meldung, Entwurf gespeichert oder als eingereicht erfasst.
`submitted_at` erforderlich	string,null (date-time)	Wann die Meldung auf der Plattform der ENISA eingereicht wurde, laut Erfassung.
`recorded_at` erforderlich	string,null (date-time)	Wann sie im Reporting Desk als eingereicht markiert wurde.

`RecordList`

Parameter	Typ	Beschreibung
`records` erforderlich	Array von object

`RecordSummary`

Eine Vorfallsakte, wie eine Liste sie zeigt, mit ihrer nächsten laufenden Frist.

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`summary` erforderlich	string
`state` erforderlich	string	Der Status des Falls, offen, bis die Vorfallsakte geschlossen ist.
`entered_at` erforderlich	string (date-time)
`aware_at` erforderlich	string (date-time)
`occurred_at` erforderlich	string,null (date-time)
`regimes` erforderlich	Array von string
`next_deadline` erforderlich	object oder null

`NextDeadline`

Parameter	Typ	Beschreibung
`obligation` erforderlich	string
`stage` erforderlich	string
`due_at` erforderlich	string (date-time)
`overdue` erforderlich	boolean

`Record`

Eine Vorfallsakte mit den Pflichten, die die Person sieht, die das Token erstellt hat.

Parameter	Typ	Beschreibung
`id` erforderlich	string (uuid)
`summary` erforderlich	string
`state` erforderlich	string
`entered_at` erforderlich	string (date-time)
`aware_at` erforderlich	string (date-time)
`occurred_at` erforderlich	string,null (date-time)
`regimes` erforderlich	Array von string
`next_deadline` erforderlich	object oder null
`detail` erforderlich	string
`definitions` erforderlich	Array von string
`answers` erforderlich	object
`items` erforderlich	Array von object
`obligations` erforderlich	Array von object

`RecordItem`

Parameter	Typ	Beschreibung
`kind` erforderlich	string
`name` erforderlich	string

`Obligation`

Eine Pflicht eines Moduls an einer Vorfallsakte, bestimmt durch ihre Art und ihre Partei.

Parameter	Typ	Beschreibung
`key` erforderlich	string
`regime` erforderlich	string
`type` erforderlich	string
`party` erforderlich	object
`party_name` erforderlich	string
`applicability` erforderlich	string
`suggested` erforderlich	string
`reason` erforderlich	string
`decided_by` erforderlich	string
`decided_at` erforderlich	string (date-time)
`stages` erforderlich	Array von object

`ObligationParty`

Parameter	Typ	Beschreibung
`kind` erforderlich	string
`id`	string (uuid)

`RecordStage`

Eine Stufe und ihre gespeicherte Frist oder der Zeitpunkt, auf den sie wartet; durch eine Antwort geschlossen.

Parameter	Typ	Beschreibung
`id` erforderlich	string
`closed` erforderlich	boolean
`due_at` erforderlich	string,null (date-time)
`met_at` erforderlich	string,null (date-time)
`rule` erforderlich	string
`rule_version` erforderlich	integer
`waiting_for` erforderlich	string

`NewRecord`

Was angegeben wird, wenn ein Vorfall erfasst wird.

Parameter	Typ	Beschreibung
`summary` erforderlich	string
`detail`	string
`aware_at` erforderlich	string (date-time)
`occurred_at`	string,null (date-time)
`definitions` erforderlich	Array von string
`legal_entities`	Array von string (uuid)
`contracts`	Array von string (uuid)
`member_states`	Array von string
`services`	Array von string
`answers`	object

`NewSubmission`

Die Meldung einer Stufe, wie eingereicht, mit dem, wohin sie ging.

Parameter	Typ	Beschreibung
`obligation` erforderlich	string
`stage` erforderlich	string
`language` erforderlich	string
`values` erforderlich	object
`submitted_at` erforderlich	string (date-time)
`submitted_by` erforderlich	string
`reference`	string
`sent` erforderlich	object	Der Kanal, über den sie ging, je Empfänger.
`not_sent_reason`	string

`Submission`

Die Kopie der Einreichung der Meldung einer Stufe.

Parameter	Typ	Beschreibung
`record` erforderlich	string (uuid)
`obligation` erforderlich	string
`stage` erforderlich	string
`submitted_at` erforderlich	string (date-time)
`recorded_at` erforderlich	string (date-time)
`submitted_by` erforderlich	string
`reference` erforderlich	string
`channel` erforderlich	string
`recipient` erforderlich	string
`sent` erforderlich	Array von object
`not_sent` erforderlich	Array von string
`template` erforderlich	string
`template_version` erforderlich	integer
`language` erforderlich	string
`sha256` erforderlich	string

`SubmissionSent`

Parameter	Typ	Beschreibung
`recipient` erforderlich	string
`channel` erforderlich	string

`Problem`

Problemdetails nach RFC 9457.

Parameter	Typ	Beschreibung
`type` erforderlich	string
`title` erforderlich	string
`status` erforderlich	integer
`detail`	string

Der Vertrag selbst. Diese Seite entsteht aus dem OpenAPI-Dokument des Dienstes. Es ist als Datei veröffentlicht, damit ein Client-Generator denselben Vertrag lesen kann, den diese Seite beschreibt. openapi.yaml herunterladen

Doku

14 Tage kostenlos testen