{ "swagger": "2.0", "basePath": "/api", "paths": { "/browse/": { "get": { "responses": { "200": { "description": "Success" } }, "summary": "Get the known vendors", "description": "Get the known vendors.", "operationId": "get_vendors", "tags": [ "browse" ] } }, "/browse/{vendor}": { "parameters": [ { "name": "vendor", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Get the known products for a vendor", "description": "Get the known products for a vendor.", "operationId": "get_vendor_products", "tags": [ "browse" ] } }, "/bundle/": { "get": { "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/BundlesList" } } } }, "summary": "List all bundles", "operationId": "list_bundles", "parameters": [ { "name": "uuid", "in": "query", "type": "string", "description": "UUID of the bundle." }, { "name": "author", "in": "query", "type": "string", "description": "Author (login) of the bundle." }, { "name": "vuln_id", "in": "query", "type": "string", "description": "Id of a vulnerability referenced by the bundle." }, { "name": "meta", "in": "query", "type": "string", "description": "Query for the meta JSON field. Example: meta=[{'tags': ['tcp']}]" }, { "name": "per_page", "in": "query", "type": "integer", "description": "Number of elements to return.", "default": 10 }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "bundle" ] }, "post": { "responses": { "201": { "description": "Success.", "schema": { "type": "array", "items": { "$ref": "#/definitions/BundlesList" } } }, "400": { "description": "JSON validation failed or incorrect payload to instantiate a bundle." }, "403": { "description": "Administrator permission required." } }, "description": "Create a bundle.", "operationId": "post_bundles_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Bundle" } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "bundle" ] } }, "/bundle/{bundle_uuid}": { "parameters": [ { "name": "bundle_uuid", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Bundle" } }, "404": { "description": "Bundle not found." } }, "description": "Get a bundle with its UUID.", "operationId": "get_bundle_item", "parameters": [ { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "bundle" ] }, "delete": { "responses": { "204": { "description": "Success." }, "403": { "description": "Administrator permission required or not the author of the bundle." }, "404": { "description": "Bundle not found." } }, "summary": "Endpoint for deleting a bundle", "description": "Delete a bundle.\nOnly an admin can delete a bundle.", "operationId": "delete_bundle_item", "tags": [ "bundle" ] } }, "/comment/": { "get": { "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommentsList" } } } }, "summary": "List all comments", "operationId": "list_comments", "parameters": [ { "name": "uuid", "in": "query", "type": "string", "description": "UUID of the comment." }, { "name": "vuln_id", "in": "query", "type": "string", "description": "Vulnerability related to the comment." }, { "name": "author", "in": "query", "type": "string", "description": "Author of the comment." }, { "name": "meta", "in": "query", "type": "string", "description": "Query for the meta JSON field. Example: meta=[{'tags': ['PoC']}]" }, { "name": "per_page", "in": "query", "type": "integer", "description": "Number of elements to return.", "default": 10 }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "comment" ] }, "post": { "responses": { "201": { "description": "Success.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommentsList" } } }, "400": { "description": "JSON validation failed or incorrect payload to instantiate a comment." }, "403": { "description": "Commenter permission required or not the author of the comment." } }, "summary": "Create a new comment related to a security advisory (vulnerability)", "description": "Create a comment related to a security advisory.", "operationId": "post_comments_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Comment" } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "comment" ] } }, "/comment/{comment_uuid}": { "parameters": [ { "name": "comment_uuid", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Comment" } }, "404": { "description": "Comment not found." } }, "description": "Get a comment with its UUID.", "operationId": "get_comment_item", "parameters": [ { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "comment" ] }, "delete": { "responses": { "204": { "description": "Success." }, "403": { "description": "Commenter permission required or not the author of the comment." }, "404": { "description": "Comment not found." } }, "summary": "Endpoint for deleting a comment", "description": "Delete a comment.", "operationId": "delete_comment_item", "tags": [ "comment" ] } }, "/cve/{vulnerability_id}": { "parameters": [ { "name": "vulnerability_id", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "description": "Alias for /api/vulnerability/", "parameters": [ { "name": "with_meta", "in": "query", "type": "boolean", "description": "Include metada.", "default": false } ], "deprecated": true, "tags": [ "legacy" ] }, "delete": { "responses": { "204": { "description": "Success." }, "403": { "description": "Admin permission required." }, "422": { "description": "Not possible to edit a vulnerability from the requested source." } }, "summary": "Endpoint for deleting a vulnerability", "description": "Alias for /api/vulnerability/", "deprecated": true, "tags": [ "legacy" ] } }, "/epss/{vulnerability_id}": { "parameters": [ { "name": "vulnerability_id", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success." }, "404": { "description": "Problem when retrieving EPSS." } }, "description": "Experimental - Get the EPSS score of a vulnerability.", "operationId": "get_epss_item", "tags": [ "epss" ] } }, "/search/{vendor}/{product}": { "parameters": [ { "name": "vendor", "in": "path", "required": true, "type": "string" }, { "name": "product", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Returns a list of vulnerabilities related to the product", "description": "Alias for /api/vulnerability/search//", "operationId": "get_vendor_product_vulnerabilities_/search//", "deprecated": true, "tags": [ "legacy" ] } }, "/sighting": { "get": { "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/SightingsList" } } } }, "summary": "List all sightings", "operationId": "list_sightings", "parameters": [ { "name": "uuid", "in": "query", "type": "string", "description": "UUID of the sighting." }, { "name": "type", "in": "query", "type": "string", "description": "Type of sightings:\n - Seen: The vulnerability was mentioned, discussed, or seen somewhere by the user.\n - Exploited: This vulnerability was exploited and seen by the user reporting the sighting.\n - Not exploited: This vulnerability was not exploited or seen by the user reporting the sighting.\n - Confirmed: The vulnerability is confirmed from an analyst perspective.\n - Not confirmed: The user expresses doubt about the veracity of the vulnerability.\n - Patched: This vulnerability was successfully patched by the user reporting the sighting.\n - Not patched: This vulnerability was not successfully patched by the user reporting the sighting.", "enum": [ "seen", "exploited", "not-exploited", "confirmed", "not-confirmed", "patched", "not-patched" ] }, { "name": "vuln_id", "in": "query", "type": "string", "description": "Vulnerability related to the sighting." }, { "name": "author", "in": "query", "type": "string", "description": "Author of the sighting (login)." }, { "name": "date_from", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be bigger or equal than this value. Format: YYYY-MM-DD" }, { "name": "date_to", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be smaller or equal than this value. Format: YYYY-MM-DD" }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "sighting" ] }, "post": { "responses": { "201": { "description": "Success.", "schema": { "type": "array", "items": { "$ref": "#/definitions/SightingsList" } } }, "400": { "description": "Incorrect payload to instantiate a sighting." }, "409": { "description": "Duplicate sighting." } }, "summary": "Create a new sighting", "description": "Create a new sighting.", "operationId": "post_sightings_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Sighting" } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "sighting" ] } }, "/sighting/": { "get": { "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/SightingsList" } } } }, "summary": "List all sightings", "operationId": "list_sightings", "parameters": [ { "name": "uuid", "in": "query", "type": "string", "description": "UUID of the sighting." }, { "name": "type", "in": "query", "type": "string", "description": "Type of sightings:\n - Seen: The vulnerability was mentioned, discussed, or seen somewhere by the user.\n - Exploited: This vulnerability was exploited and seen by the user reporting the sighting.\n - Not exploited: This vulnerability was not exploited or seen by the user reporting the sighting.\n - Confirmed: The vulnerability is confirmed from an analyst perspective.\n - Not confirmed: The user expresses doubt about the veracity of the vulnerability.\n - Patched: This vulnerability was successfully patched by the user reporting the sighting.\n - Not patched: This vulnerability was not successfully patched by the user reporting the sighting.", "enum": [ "seen", "exploited", "not-exploited", "confirmed", "not-confirmed", "patched", "not-patched" ] }, { "name": "vuln_id", "in": "query", "type": "string", "description": "Vulnerability related to the sighting." }, { "name": "author", "in": "query", "type": "string", "description": "Author of the sighting (login)." }, { "name": "date_from", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be bigger or equal than this value. Format: YYYY-MM-DD" }, { "name": "date_to", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be smaller or equal than this value. Format: YYYY-MM-DD" }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "sighting" ] }, "post": { "responses": { "201": { "description": "Success.", "schema": { "type": "array", "items": { "$ref": "#/definitions/SightingsList" } } }, "400": { "description": "Incorrect payload to instantiate a sighting." }, "409": { "description": "Duplicate sighting." } }, "summary": "Create a new sighting", "description": "Create a new sighting.", "operationId": "post_sightings_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Sighting" } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "sighting" ] } }, "/sighting/{sighting_uuid}": { "parameters": [ { "name": "sighting_uuid", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Sighting" } }, "404": { "description": "Sighting not found." } }, "description": "Get a sighting with its UUID.", "operationId": "get_sighting_item", "parameters": [ { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "sighting" ] } }, "/stats/vulnerability/most_commented": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Returns the most commented vulnerabilities.", "operationId": "get_vulnerability_most_commented", "parameters": [ { "name": "date_from", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be bigger or equal than this value. Format: YYYY-MM-DD" }, { "name": "date_to", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be smaller or equal than this value. Format: YYYY-MM-DD" }, { "name": "limit", "in": "query", "type": "integer", "description": "The top elements to take into account in the query.", "default": 10 }, { "name": "output", "in": "query", "type": "string", "description": "The format of the output.", "default": "json", "enum": [ "json", "markdown" ] } ], "tags": [ "stats" ] } }, "/stats/vulnerability/most_sighted": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Returns the most sighted vulnerabilities.", "operationId": "get_vulnerability_most_sighted", "parameters": [ { "name": "date_from", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be bigger or equal than this value. Format: YYYY-MM-DD" }, { "name": "date_to", "in": "query", "type": "string", "format": "date", "description": "The date of the sightings must be smaller or equal than this value. Format: YYYY-MM-DD" }, { "name": "sighting_type", "in": "query", "type": "string", "description": "The type of the sighting.", "default": "", "enum": [ "seen", "exploited", "not-exploited", "confirmed", "not-confirmed", "patched", "not-patched" ] }, { "name": "limit", "in": "query", "type": "integer", "description": "The top elements to take into account in the query.", "default": 10 }, { "name": "output", "in": "query", "type": "string", "description": "The format of the output.", "default": "json", "enum": [ "json", "markdown" ] } ], "tags": [ "stats" ] } }, "/system/configInfo": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Get non-sensitive information about the configuration of the system.", "operationId": "get_config_info", "tags": [ "system" ] } }, "/system/dbInfo": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Get more information about the current databases in use and when it was updated", "operationId": "get_info", "tags": [ "system" ] } }, "/system/info": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Alias for /api/sytem/dbInfo", "operationId": "get_info_/system/info", "deprecated": true, "tags": [ "system" ] } }, "/system/redis_up": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Check if redis is up and running", "operationId": "get_redis_up", "tags": [ "system" ] } }, "/user/": { "get": { "responses": { "200": { "description": "Success.", "schema": { "type": "array", "items": { "$ref": "#/definitions/UsersList" } } }, "403": { "description": "Admin permission required." } }, "summary": "List all users", "description": "Only available to administrators.", "operationId": "list_users", "parameters": [ { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "user" ] }, "post": { "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/UserFull" } }, "201": { "description": "Success." } }, "summary": "Create a non-admin user", "description": "Create a non-admin user.\nThe user will be active but must have to confirm the account with the email sent by the instance.", "operationId": "post_users_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "type": "object", "properties": { "login": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string" }, "email": { "type": "string" } } } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "user" ] } }, "/user/api_key": { "post": { "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/UserFull" } }, "403": { "description": "Wrong API key submitted." }, "404": { "description": "User not found." } }, "summary": "Regenerating the API key of the authenticated user with the current API key", "description": "Regenerating the API key of the authenticated user with the current API key.", "operationId": "post_user_new_api_key", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/API%20Key" } }, { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "user" ] } }, "/user/me": { "get": { "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/UserFull" } }, "404": { "description": "User not found." } }, "summary": "Get information about the currently authenticated user", "description": "Get information about the currently authenticated user.", "operationId": "get_user_self", "parameters": [ { "name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask" } ], "tags": [ "user" ] } }, "/user/{user_id}": { "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "integer" } ], "delete": { "responses": { "204": { "description": "Success." }, "403": { "description": "Administrator permission required or not the current user." }, "404": { "description": "User not found." } }, "summary": "Endpoint for deleting a user", "description": "Delete a user.", "operationId": "delete_user_item", "tags": [ "user" ] } }, "/vulnerability/": { "post": { "responses": { "200": { "description": "Success." }, "400": { "description": "JSON validation failed." }, "403": { "description": "Reporter permission required." }, "422": { "description": "Not possible to edit a vulnerability from the requested source." } }, "summary": "Endpoint for creating and editing vulnerabilities in the local source", "description": "Create a vulnerability with the CVE version 5 format.", "operationId": "post_vulnerabilities_list", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "type": "object", "properties": { "data": { "type": "string" } } } } ], "tags": [ "vulnerability" ] } }, "/vulnerability/browse/": { "get": { "responses": { "200": { "description": "Success" } }, "summary": "Get the known vendors", "description": "Get the known vendors.", "operationId": "get_vendors", "tags": [ "vulnerability" ] } }, "/vulnerability/last": { "get": { "responses": { "200": { "description": "Success" } }, "description": "Get the last vulnerabilities", "operationId": "get_last", "tags": [ "vulnerability" ] } }, "/vulnerability/last/{number}": { "parameters": [ { "name": "number", "in": "path", "required": true, "type": "integer" } ], "get": { "responses": { "200": { "description": "Success" } }, "description": "Get the last vulnerabilities", "operationId": "get_last", "tags": [ "vulnerability" ] } }, "/vulnerability/last/{source}": { "parameters": [ { "name": "source", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "description": "Get the last vulnerabilities", "operationId": "get_last", "tags": [ "vulnerability" ] } }, "/vulnerability/last/{source}/{number}": { "parameters": [ { "name": "source", "in": "path", "required": true, "type": "string" }, { "name": "number", "in": "path", "required": true, "type": "integer" } ], "get": { "responses": { "200": { "description": "Success" } }, "description": "Get the last vulnerabilities", "operationId": "get_last", "tags": [ "vulnerability" ] } }, "/vulnerability/search/{vendor}/{product}": { "parameters": [ { "name": "vendor", "in": "path", "required": true, "type": "string" }, { "name": "product", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Returns a list of vulnerabilities related to the product", "description": "Returns a list of vulnerabilities related to the product.", "operationId": "get_vendor_product_vulnerabilities", "tags": [ "vulnerability" ] } }, "/vulnerability/{vulnerability_id}": { "parameters": [ { "name": "vulnerability_id", "in": "path", "required": true, "type": "string" } ], "get": { "responses": { "200": { "description": "Success" } }, "description": "Alias for /api/vulnerability/", "parameters": [ { "name": "with_meta", "in": "query", "type": "boolean", "description": "Include metada.", "default": false } ], "deprecated": true, "tags": [ "legacy" ] }, "delete": { "responses": { "204": { "description": "Success." }, "403": { "description": "Admin permission required." }, "422": { "description": "Not possible to edit a vulnerability from the requested source." } }, "summary": "Endpoint for deleting a vulnerability", "description": "Alias for /api/vulnerability/", "deprecated": true, "tags": [ "legacy" ] } } }, "info": { "title": "Vulnerability-Lookup API", "version": "2.1.0", "description": "
API to query Vulnerability-Lookup. A project from CIRCL.

Back to the main page

Official documentation of the project.", "license": { "name": "GNU Affero General Public License version 3", "url": "https://www.gnu.org/licenses/agpl-3.0.html" } }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "securityDefinitions": { "apikey": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "security": [ { "apikey": [] } ], "tags": [ { "name": "system", "description": "Endpoints for retrieving various information about the system's status." }, { "name": "vulnerability", "description": "Vulnerability related operations." }, { "name": "legacy", "description": "Legacy endpoints for vulnerabilities." }, { "name": "browse", "description": "Endpoints for accessing vendor and product information." }, { "name": "stats", "description": "Endpoint for retrieving various statistics." }, { "name": "comment", "description": "Comment related operations." }, { "name": "user", "description": "User related operations." }, { "name": "bundle", "description": "Bundle related operations." }, { "name": "sighting", "description": "Sighting related operations." }, { "name": "epss", "description": "EPSS related operations." } ], "definitions": { "Comment": { "properties": { "uuid": { "type": "string", "description": "Comment id." }, "vulnerability_lookup_origin": { "type": "string", "description": "UUID of the Vulnerability Lookup origin instance.", "readOnly": true, "default": "1a89b78e-f703-45f3-bb86-59eb712668bd" }, "title": { "type": "string", "description": "Comment id." }, "description": { "type": "string", "description": "Description." }, "description_format": { "type": "string", "description": "Description format (markdown or text)." }, "vulnerability": { "type": "string", "description": "Vulnerability id." }, "creation_timestamp": { "type": "string", "format": "date-time", "description": "Creation time of the comment.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "Updated time of the comment.", "readOnly": true }, "related_vulnerabilities": { "type": "array", "description": "One or more vulnerability references (CVE ID, GHSA-ID, PYSEC ID, etc.) for this comment.", "items": { "type": "string" } }, "meta": { "type": "object", "description": "Zero or more meta-fields." }, "author": { "readOnly": true, "allOf": [ { "$ref": "#/definitions/User" } ] } }, "type": "object" }, "User": { "properties": { "login": { "type": "string", "description": "Login of the user.", "readOnly": true }, "name": { "type": "string", "description": "Name of the user.", "readOnly": true }, "uuid": { "type": "string", "description": "UUID of the user.", "readOnly": true } }, "type": "object" }, "CommentsList": { "properties": { "metadata": { "description": "Metada related to the result.", "allOf": [ { "$ref": "#/definitions/metadata" } ] }, "data": { "type": "array", "description": "List of comments.", "items": { "$ref": "#/definitions/Comment" } } }, "type": "object" }, "metadata": { "properties": { "count": { "type": "integer", "description": "Total number of the items of the data.", "readOnly": true }, "offset": { "type": "integer", "description": "Position of the first element of the data from the total data amount.", "readOnly": true }, "limit": { "type": "integer", "description": "Requested limit data.", "readOnly": true } }, "type": "object" }, "UserFull": { "properties": { "id": { "type": "integer", "description": "User id." }, "login": { "type": "string", "description": "User login." }, "name": { "type": "string", "description": "User name." }, "organisation": { "type": "string", "description": "User organisation." }, "email": { "type": "string", "description": "User email." }, "apikey": { "type": "string", "description": "User API key.", "readOnly": true }, "is_admin": { "type": "boolean", "description": "Boolean specifying whether the user is administrator." }, "is_reporter": { "type": "boolean", "description": "Boolean specifying whether the user is reporter." }, "is_commenter": { "type": "boolean", "description": "Boolean specifying whether the user is commenter." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation time of the user.", "readOnly": true }, "last_seen": { "type": "string", "format": "date-time", "description": "Last seen time of the user.", "readOnly": true } }, "type": "object" }, "API Key": { "properties": { "apikey": { "type": "string", "description": "The current API key of the user." } }, "type": "object" }, "UsersList": { "properties": { "metadata": { "description": "Metada related to the result.", "allOf": [ { "$ref": "#/definitions/metadata" } ] }, "data": { "type": "array", "description": "List of users.", "items": { "$ref": "#/definitions/UserFull" } } }, "type": "object" }, "Bundle": { "properties": { "uuid": { "type": "string", "description": "Bundle id." }, "vulnerability_lookup_origin": { "type": "string", "description": "UUID of the Vulnerability Lookup origin instance.", "readOnly": true, "default": "1a89b78e-f703-45f3-bb86-59eb712668bd" }, "name": { "type": "string", "description": "Bundle id." }, "description": { "type": "string", "description": "Description." }, "creation_timestamp": { "type": "string", "format": "date-time", "description": "Updated time of the bundle.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "Updated time of the bundle.", "readOnly": true }, "related_vulnerabilities": { "type": "array", "description": "One or more vulnerability references (CVE ID, GHSA-ID, PYSEC ID, etc.) for this bundle.", "items": { "type": "string" } }, "meta": { "type": "object", "description": "Zero or more meta-fields." }, "author": { "readOnly": true, "allOf": [ { "$ref": "#/definitions/User" } ] } }, "type": "object" }, "BundlesList": { "properties": { "metadata": { "description": "Metada related to the result.", "allOf": [ { "$ref": "#/definitions/metadata" } ] }, "data": { "type": "array", "description": "List of bundles.", "items": { "$ref": "#/definitions/Bundle" } } }, "type": "object" }, "Sighting": { "properties": { "uuid": { "type": "string", "description": "Sighting UUID.", "readOnly": true }, "creation_timestamp": { "type": "string", "format": "date-time", "description": "Creation time of the sighting." }, "type": { "type": "string", "description": "Type of the sighting." }, "source": { "type": "string", "description": "The source of the sighting (Fediverse status URI, link, tool, etc.)." }, "vulnerability": { "type": "string", "description": "Vulnerability id." }, "author": { "readOnly": true, "allOf": [ { "$ref": "#/definitions/User" } ] } }, "type": "object" }, "SightingsList": { "properties": { "metadata": { "description": "Metada related to the result.", "allOf": [ { "$ref": "#/definitions/metadata" } ] }, "data": { "type": "array", "description": "List of sightings.", "items": { "$ref": "#/definitions/Sighting" } } }, "type": "object" } }, "responses": { "ParseError": { "description": "When a mask can't be parsed" }, "MaskError": { "description": "When any error occurs on mask" } } }