openapi: 3.0.3 info: title: 'SecurityHive API Documentation' description: '' version: 1.0.0 servers: - url: 'https://api.securityhive.io' tags: - name: Applications description: 'Manage the applications that have been discovered on your assets.' - name: Assets description: 'Manage assets that have been discovered on your network.' - name: Certificates description: 'Manage certificates that have been discovered on your network.' - name: Endpoints description: '' - name: Integrations description: "\nAPIs for managing integrations" - name: Me description: "\nAPIs for managing the authenticated user" - name: Tags description: 'Tags can be used to categorize assets.' - name: Users description: "\nAPIs for managing users" - name: Vulnerabilities description: 'Manage vulnerabilities that have been discovered on your network.' - name: 'Webhook Events' description: "\nAPIs for managing webhook events" - name: Webhooks description: "\nAPIs for managing webhooks" components: securitySchemes: default: type: http scheme: bearer description: 'You can retrieve your token by visiting the dashboard and clicking Generate new token at your profile.' security: - default: [] paths: /v1/applications: get: summary: 'List applications.' operationId: listApplications description: " Retrieve all applications for the current company. Look at the 'Retrieve an application' endpoint for more details on the application object.\n " parameters: - in: query name: 'filter[vendor]' description: '' example: microsoft required: false schema: type: 'Filter applications by vendor.' description: '' example: microsoft nullable: false - in: query name: 'filter[product]' description: '' example: windows required: false schema: type: 'Filter applications by product.' description: '' example: windows nullable: false - in: query name: 'filter[version]' description: '' example: 1.2.0 required: false schema: type: 'Filter applications by version.' description: '' example: 1.2.0 nullable: false - in: query name: sort description: '' example: vendor required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor' description: '' example: vendor nullable: false enum: - cpe - vendor - product - version - in: query name: include description: '' example: assets required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: assets nullable: false enum: - assets responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d13-0a36-4922-bc0c-625d1f17cc8e cpe: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*' vendor: Oracle product: Database version: 2.46.1854 update: build8214 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d13-0b8c-4554-8f02-9fab2565072e cpe: 'cpe:2.3:a:mozilla:thunderbird:*:*:*:*:*:*:*:*' vendor: Mozilla product: Thunderbird version: 19.0.7519 update: update1 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d13-0a36-4922-bc0c-625d1f17cc8e cpe: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*' vendor: Oracle product: Database version: 2.46.1854 update: build8214 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d13-0b8c-4554-8f02-9fab2565072e cpe: 'cpe:2.3:a:mozilla:thunderbird:*:*:*:*:*:*:*:*' vendor: Mozilla product: Thunderbird version: 19.0.7519 update: update1 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' items: type: object properties: id: type: string example: 9fe86d13-0a36-4922-bc0c-625d1f17cc8e cpe: type: string example: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*' vendor: type: string example: Oracle product: type: string example: Database version: type: string example: 2.46.1854 update: type: string example: build8214 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Applications /v1/applications/export: get: summary: 'Export applications.' operationId: exportApplications description: " Export all applications for the current company in CSV or XLSX format.\n " parameters: - in: query name: type description: '' example: csv required: true schema: type: 'The type of export to generate' description: '' example: csv nullable: false enum: - csv - xlsx - in: query name: 'filter[vendor]' description: '' example: microsoft required: false schema: type: 'Filter applications by vendor.' description: '' example: microsoft nullable: false - in: query name: 'filter[product]' description: '' example: windows required: false schema: type: 'Filter applications by product.' description: '' example: windows nullable: false - in: query name: 'filter[version]' description: '' example: 1.2.0 required: false schema: type: 'Filter applications by version.' description: '' example: 1.2.0 nullable: false - in: query name: sort description: '' example: product required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor' description: '' example: product nullable: false enum: - cpe - vendor - product - version responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Applications requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: csv nullable: false enum: - csv - xlsx required: - type '/v1/applications/{id}': get: summary: 'Retrieve an application.' operationId: retrieveAnApplication description: " Retrieves an by its ID.\n " parameters: - in: query name: include description: '' example: assets required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: assets nullable: false enum: - assets responses: 200: description: 'Successfully retrieved application' content: application/json: schema: type: object example: data: id: 9fe86d13-1032-4c38-9d5d-8f9a76d80745 cpe: 'cpe:2.3:a:apple:iwork:*:*:*:*:*:*:*:*' vendor: Apple product: iWork version: 1.97.2033 update: sp1 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d13-1032-4c38-9d5d-8f9a76d80745 cpe: type: string example: 'cpe:2.3:a:apple:iwork:*:*:*:*:*:*:*:*' vendor: type: string example: Apple product: type: string example: iWork version: type: string example: 1.97.2033 update: type: string example: sp1 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' tags: - Applications parameters: - in: path name: id description: 'The ID of the application.' example: itaque required: true schema: type: string /v1/assets: get: summary: 'List assets.' operationId: listAssets description: " Retrieve all assets for the current company. Look at the 'Retrieve an asset' endpoint for more details on the asset object.\n " parameters: - in: query name: 'filter[name]' description: '' example: Laptop-1 required: false schema: type: 'Filter assets by name.' description: '' example: Laptop-1 nullable: false - in: query name: 'filter[host]' description: '' example: 192.168.1.1 required: false schema: type: 'Filter assets by their IP-address.' description: '' example: 192.168.1.1 nullable: false - in: query name: 'filter[mac_address]' description: '' example: '3A:5E:D6:95:BF' required: false schema: type: 'Filter assets by their MAC-address.' description: '' example: '3A:5E:D6:95:BF' nullable: false - in: query name: 'filter[hostname]' description: '' example: laptop-1.local required: false schema: type: 'Filter assets by their hostname.' description: '' example: laptop-1.local nullable: false - in: query name: 'filter[tags][]' description: '' example: 'New,Old' required: false schema: type: 'Filter assets by their tags.' description: '' example: 'New,Old' nullable: false - in: query name: 'filter[licensed]' description: '' example: 'true,false' required: false schema: type: 'Filter assets by licensed status.' description: '' example: 'true,false' nullable: false - in: query name: sort description: '' example: licensed required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: licensed nullable: false enum: - name - host - last_seen - licensed - in: query name: include description: '' example: scans required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: scans nullable: false enum: - certificates - software - tags - scans responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-c0ff-48e0-87fa-4901a1a35e32 company_id: '4402193' name: 'Raymundo Mraz' identifier: 'A5:65:22:7C:9C:F0' host: 237.248.87.124 mac_address: 'A5:65:22:7C:9C:F0' hostname: parker.com operating_system: quis operating_system_name: rerum first_seen: '1994-08-13T23:56:46.000000Z' last_seen: '2025-08-30T21:02:13.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: true change_license_at: null - id: 9fe86d12-c480-474b-8e4d-7971d18fafe2 company_id: '181115' name: 'Leone Vandervort MD' identifier: 193.115.233.243 host: 193.115.233.243 mac_address: null hostname: rowe.org operating_system: quia operating_system_name: qui first_seen: '1972-08-29T19:48:59.000000Z' last_seen: '2025-07-14T17:35:42.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: false change_license_at: '2025-09-22T17:29:18.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d12-c0ff-48e0-87fa-4901a1a35e32 company_id: '4402193' name: 'Raymundo Mraz' identifier: 'A5:65:22:7C:9C:F0' host: 237.248.87.124 mac_address: 'A5:65:22:7C:9C:F0' hostname: parker.com operating_system: quis operating_system_name: rerum first_seen: '1994-08-13T23:56:46.000000Z' last_seen: '2025-08-30T21:02:13.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: true change_license_at: null - id: 9fe86d12-c480-474b-8e4d-7971d18fafe2 company_id: '181115' name: 'Leone Vandervort MD' identifier: 193.115.233.243 host: 193.115.233.243 mac_address: null hostname: rowe.org operating_system: quia operating_system_name: qui first_seen: '1972-08-29T19:48:59.000000Z' last_seen: '2025-07-14T17:35:42.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: false change_license_at: '2025-09-22T17:29:18.000000Z' items: type: object properties: id: type: string example: 9fe86d12-c0ff-48e0-87fa-4901a1a35e32 company_id: type: string example: '4402193' name: type: string example: 'Raymundo Mraz' identifier: type: string example: 'A5:65:22:7C:9C:F0' host: type: string example: 237.248.87.124 mac_address: type: string example: 'A5:65:22:7C:9C:F0' hostname: type: string example: parker.com operating_system: type: string example: quis operating_system_name: type: string example: rerum first_seen: type: string example: '1994-08-13T23:56:46.000000Z' last_seen: type: string example: '2025-08-30T21:02:13.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: [] ssh_key: type: string example: null average_scan_duration: type: integer example: 0 licensed: type: boolean example: true change_license_at: type: string example: null links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Assets post: summary: 'Create asset.' operationId: createAsset description: "Will create a new asset for the current company. \n " parameters: [] responses: 200: description: 'Successfully created asset' content: application/json: schema: type: object example: data: id: 9fe86d12-cd39-4464-9f49-fb8d059a5aba company_id: '2857872' name: 'Richard Terry' identifier: 'EA:B6:D8:C6:7C:DB' host: 239.70.17.177 mac_address: 'EA:B6:D8:C6:7C:DB' hostname: tromp.biz operating_system: eum operating_system_name: aut first_seen: '1978-04-14T12:42:03.000000Z' last_seen: '2016-08-18T05:13:07.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: true change_license_at: '2025-09-25T17:19:34.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-cd39-4464-9f49-fb8d059a5aba company_id: type: string example: '2857872' name: type: string example: 'Richard Terry' identifier: type: string example: 'EA:B6:D8:C6:7C:DB' host: type: string example: 239.70.17.177 mac_address: type: string example: 'EA:B6:D8:C6:7C:DB' hostname: type: string example: tromp.biz operating_system: type: string example: eum operating_system_name: type: string example: aut first_seen: type: string example: '1978-04-14T12:42:03.000000Z' last_seen: type: string example: '2016-08-18T05:13:07.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: [] ssh_key: type: string example: null average_scan_duration: type: integer example: 0 licensed: type: boolean example: true change_license_at: type: string example: '2025-09-25T17:19:34.000000Z' 422: description: 'duplicate host found' content: application/json: schema: type: object example: message: 'host must be unique' properties: message: type: string example: 'host must be unique' tags: - Assets requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: yaziplfst nullable: false host: type: string description: 'A valid IPv4 or IPv6 address. Must be unique' example: eveniet nullable: false licensed: type: boolean description: '' example: false nullable: false required: - name - host - licensed /v1/assets/actions: patch: summary: 'Bulk asset action.' operationId: bulkAssetAction description: "Will perform a bulk action on assets (Add Tags, Remove Tags or delete). \n " parameters: [] responses: 204: description: 'bulk action performed successfully' content: application/json: schema: type: array items: type: object example: [] tags: - Assets requestBody: required: true content: application/json: schema: type: object properties: data: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: action: type: string description: '' example: addTags nullable: false enum: - addTags - removeTags - delete - assignLicense - removeLicense id: type: string description: '' example: qui nullable: false data: type: object description: '' example: [] nullable: false properties: tags: type: object description: '' example: [] nullable: false properties: { } required: - tags required: - action - id required: - data '/v1/assets/{id}': get: summary: 'Retrieve an asset.' operationId: retrieveAnAsset description: " Retrieves an asset by its ID.\n " parameters: - in: query name: include description: '' example: certificates required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: certificates nullable: false enum: - certificates - software - tags - scans responses: 200: description: 'Successfully retrieved asset' content: application/json: schema: type: object example: data: id: 9fe86d12-d214-4823-a562-98b6cddcce97 company_id: '8798716' name: 'Dr. Hershel Bahringer PhD' identifier: 'DB:44:F0:17:89:D7' host: 228.2.213.12 mac_address: 'DB:44:F0:17:89:D7' hostname: schmeler.com operating_system: minima operating_system_name: reprehenderit first_seen: '1987-03-08T11:51:42.000000Z' last_seen: '1980-02-22T08:36:57.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: true change_license_at: '2025-10-13T05:44:04.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-d214-4823-a562-98b6cddcce97 company_id: type: string example: '8798716' name: type: string example: 'Dr. Hershel Bahringer PhD' identifier: type: string example: 'DB:44:F0:17:89:D7' host: type: string example: 228.2.213.12 mac_address: type: string example: 'DB:44:F0:17:89:D7' hostname: type: string example: schmeler.com operating_system: type: string example: minima operating_system_name: type: string example: reprehenderit first_seen: type: string example: '1987-03-08T11:51:42.000000Z' last_seen: type: string example: '1980-02-22T08:36:57.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: [] ssh_key: type: string example: null average_scan_duration: type: integer example: 0 licensed: type: boolean example: true change_license_at: type: string example: '2025-10-13T05:44:04.000000Z' tags: - Assets patch: summary: 'Update asset.' operationId: updateAsset description: "Will update an existing asset \n " parameters: [] responses: 200: description: 'Successfully updated asset' content: application/json: schema: type: object example: data: id: 9fe86d12-d796-4d12-95fd-e25fb645840c company_id: '6073557' name: 'Mr. Daren Schulist' identifier: 'CA:5F:92:7A:CC:BE' host: 93.192.191.219 mac_address: 'CA:5F:92:7A:CC:BE' hostname: witting.info operating_system: non operating_system_name: voluptatem first_seen: '1975-06-24T17:42:48.000000Z' last_seen: '2000-02-20T16:08:22.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: [] ssh_key: null average_scan_duration: 0 licensed: true change_license_at: '2025-09-29T15:09:41.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-d796-4d12-95fd-e25fb645840c company_id: type: string example: '6073557' name: type: string example: 'Mr. Daren Schulist' identifier: type: string example: 'CA:5F:92:7A:CC:BE' host: type: string example: 93.192.191.219 mac_address: type: string example: 'CA:5F:92:7A:CC:BE' hostname: type: string example: witting.info operating_system: type: string example: non operating_system_name: type: string example: voluptatem first_seen: type: string example: '1975-06-24T17:42:48.000000Z' last_seen: type: string example: '2000-02-20T16:08:22.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: [] ssh_key: type: string example: null average_scan_duration: type: integer example: 0 licensed: type: boolean example: true change_license_at: type: string example: '2025-09-29T15:09:41.000000Z' 422: description: 'name field is empty' content: application/json: schema: type: object example: message: 'name is required' properties: message: type: string example: 'name is required' tags: - Assets requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: fsxyxrf nullable: false licensed: type: boolean description: '' example: true nullable: false required: - name - licensed delete: summary: 'Delete asset.' operationId: deleteAsset description: "Will delete an existing asset \n " parameters: [] responses: 204: description: 'asset deleted successfully' content: application/json: schema: type: array items: type: object example: [] tags: - Assets parameters: - in: path name: id description: 'The ID of the asset.' example: et required: true schema: type: string /v1/certificates: get: summary: 'List certificates.' operationId: listCertificates description: " Retrieve all certificates for the current company. Look at the 'Retrieve a certificate' endpoint for more details on the certificate object.\n " parameters: - in: query name: 'filter[common_name]' description: '' example: test.nl required: false schema: type: 'Filter certificates by their common name.' description: '' example: test.nl nullable: false - in: query name: 'filter[organization]' description: '' example: 'Test B.V.' required: false schema: type: 'Filter certificates by their organization name.' description: '' example: 'Test B.V.' nullable: false - in: query name: sort description: '' example: not_valid_after required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before' description: '' example: not_valid_after nullable: false enum: - not_valid_after - in: query name: include description: '' example: applications required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: applications nullable: false enum: - certificates - applications - tags - scans responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-e0c3-4d51-bd74-ff6b2c3de31a company_id: '4822597' common_name: heathcote.net organization: 'Lehner, Beer and Deckow' organizational_unit: null locality: null state: Washington country: HT serial: RICZILLOJPTW8QIRFEGSZ8CYCYTACPPK not_valid_before: 20241008T043112Z not_valid_after: 20261104T195716Z value: "-----BEGIN CERTIFICATE-----\na7bmn7kWPQjUTNTnyLShVrYY1ts4aq4gBoB8/93PcR3w8JLiiMSAzzMLjX8h0QFl\nGtwXGczSbjrQkDAxIfuPQ8XlSj6x9XJAXhzlDHOzHVDqgqgThhjisuviSv61AZTY\nf873YoYzCS4O5ObFBVGcwjO6OpdoAGzIY6A/iTPoHZlck4b8OzpOVzVC++YQqIrd\nZAtIJsqnTSA1hnFSNQrxhL5LNE0+FFMEvRnCpWYozTLfEFiBT9yyPbfDkpja0QaP\nzmfx2bg/sxavRG5J17MMzY30S0lrfMjTMA8agBhljUlOpaYrGgO9YyJewePKgp3T\nUPCbtFQrw22JhJoN4ryUALaS3QW4OMjZybuAoMiLePtBd5kJ+WtQkHAQnQGjIol+\nC1xrnZQTOBlSkuat5lTMwC2h3A//Eite+URdTqezkquse38796MVA9C9P5xYtSsM\ne3yTI34GAt/mZHspBs6kXL6S38A0adBFpsZG4ZrgyJ/09xcGZRiY+Ob/1brafoGN\n1/e9JEAYfHAac2NMlbf/c524x5nosMFY72WmkmO4WDRu44plk00euH1I2zdA//bE\nzl/gXITCehaVMhXdNZnOs3WG/Dul54wl8LV59r8eJaIo0i1YAUo9w0JNC+7ZSh/9\ncwmZGNXlQkfyE8mu6A+ykYkL+27Sf1VBZPPhFxZO1ps9sHO9MskWMVucpzVpEaVk\nZqJP393JzgPhRGx/mC2MhB6YB47F8gE0r3SWTJ2QgoJjdeUr3RdklBwBD6CfMsSz\nImbTndHlwYI1/TlECJnR8hS6xwok0KL62rfnKxpnsx51vkmSVn8G0aEtR/nWzLXe\nt4BJT6ou+EHI+J23DfnSG1turESeG8KF4dgv/xnyiZzhD0r5YnJWtyA/h3mConPf\n9Ao/yYUpMjxl6yafvaqzTq7d+v51uSC2WUSE/p9aG0R1hERwAul6XYfjHnumYx5H\nMvbTBINc/pk74kVEegs657tciOWenPHiGE03YODk42vLP8rFVd6LBtOZMASMGycy\nLW1hzJxRClP2AnfYow6xFiE+mMrlanHAGifdbAk3eVKiSgW4jA06TEihbZhQjMHj\nyHZJi7ujwMYs5c+BUUnG1WELdrLk83i/AhTTBOP0/FQfIoDQXeUPUXV4zuAtJ3od\nsWM/Xto2OafyoBwWT5adifFfpmCmibdR8YwFxxQI6MOaY1WHSFkJsLkcalTj2hxI\nzH51TkOKNdeYaNtpqtl/ha9qza4cUbV1k4XsAKc0tx1XCuhuHUoxDL8WzL4jzkjV\niK48Ae3Dy+7XhbPwn5PbgcPCiACHtumHZAmOK4Vca5dGgQG4njtwbbQF6JuCHyzk\no4IMj/Uj4/8Ih5LZZOcBEA==\n\n-----END CERTIFICATE-----" first_seen: '2024-10-12T03:49:13.000000Z' last_seen: '2025-02-07T21:50:50.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-e3c2-4083-a49d-401f431b5f1e company_id: '9727666' common_name: rice.com organization: Pouros-Bergstrom organizational_unit: 'and Sons' locality: null state: 'West Virginia' country: MX serial: Q1KINT99ZG7DXU7Q3XNUNVTAIJZYLSU4 not_valid_before: 20240522T015313Z not_valid_after: 20261102T135410Z value: "-----BEGIN CERTIFICATE-----\nz39+9Dp61FWAzYv8m2OifMw2PjkKIWlBAL2LpII+owRJnEIwlHMrlVedJRuoND4r\nB7KKmPHF95MBoLLQrl7gvIO/pcr7GXFxdbq4P94DMLus1J0T11KceRdraPRaZDNr\nSzotUTmkuXHP2oC+f5bc+Yl6T78HNwILOoXE3zv9ijXVzKDBfIJhg9ulO/f2+V4e\neuPQaFerxrQz6lVZaFn/ZJ8Ohd9EPkOFiS5JpBggX6YkeqWmWoBM8ul6P9cxaXuk\ncXOZlBHUZkFy67x7Va+WVR7BupLlh6Vi+Cm+Ypcr1ZcI8XxnMrBhK0xAqz6Bs485\nnPXiXw6/5RjY8kbXql0eSfdNf83qh+PLLVkAfpENJg3FS8dztdogtQxm/z1UWHge\nXpIAKGwsF40M4uMxo06FCWxb/FQDou/0BGiYRvXBrxI4SISSx52z5vHCbRYW+FnH\nXiQ+6+uIS0EBydZkJF2SNRp1LiuzydST9tQbo3b63aC1QpxCm1KVvpeY+AVSoC4+\ncb3r2hwGgrdc1pjBCKTEDgEECIfWNX/SclxAk69WX9CbmEdHp1wCr2t/9g3IqCwG\nQuryIecfKf5WxyUmAiuUe+Cr5GBL7mFaHskbRMJcF7SWhbYnoOSn8r10uYk01EfG\nXnD9WgJ5AczeHPY3BZrq0GyD/0rYka4zyyH79ebA9ZqTxYOaCyXK96oFaSa3pknG\nDAgFNbplmFkMNJdXRZ/Mw+F8CNmdhIIVeOgDDd7B+tA/AtzmCoV2nWHZzCUdYOLM\nWP+C0WYmMSBxFb4pX3VhN5CwvX2lGebetAllF+r84lWddQmcce/iHfLfp77iB+Ju\nZFrTCHs17nq359E2iFusk2w/qLiDR3GMu7wwurINSkd2K+BUf/zJUYT7x2KNu2yM\njM9iTpUF06ZwnRTmmL4W3488uXcgjF2wJutX35w/M+4xrBWFpJY0IDNdnR+B/AYv\nWjcI3ZiZ7PepVaE9tcVIbGz34wl6VEj3JlG+BgzNl1ADs2VNwPUCeCPIA0yDJrNX\nOzwLgb3QvSkD8OlXjsH5lLiFpCmXRaEn9l8WlGgcVbdjhM7lIe30n88rVBv5/Z09\nKcFLpiBMIF5aJcNCDec9TUsD/7d3VkhNzxKpd3trqJ6QFfhaRKfcx/CRby0o/QfS\nMxpaOsMreErX4iaOhLQi/orPfVl8YQH6SZFKvpNfjVSVYrF6a0qKPtKEIVzRXYtP\nsa2dGznYQsBOTlJMze2MwQh7cn/DDZo7rE5CW1Vno+n0/gjkRRgzQRj4DImRQD5q\nAsYGn46N3Sl6uDGBrX5WlZ2D1omWlxVI6FnksMc+8RG/yXYd7OosveCut5G2f6qK\n3zZT5QC1o2jQJOwwChHLpA==\n\n-----END CERTIFICATE-----" first_seen: '2024-05-23T10:11:16.000000Z' last_seen: '2024-05-24T23:20:44.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d12-e0c3-4d51-bd74-ff6b2c3de31a company_id: '4822597' common_name: heathcote.net organization: 'Lehner, Beer and Deckow' organizational_unit: null locality: null state: Washington country: HT serial: RICZILLOJPTW8QIRFEGSZ8CYCYTACPPK not_valid_before: 20241008T043112Z not_valid_after: 20261104T195716Z value: "-----BEGIN CERTIFICATE-----\na7bmn7kWPQjUTNTnyLShVrYY1ts4aq4gBoB8/93PcR3w8JLiiMSAzzMLjX8h0QFl\nGtwXGczSbjrQkDAxIfuPQ8XlSj6x9XJAXhzlDHOzHVDqgqgThhjisuviSv61AZTY\nf873YoYzCS4O5ObFBVGcwjO6OpdoAGzIY6A/iTPoHZlck4b8OzpOVzVC++YQqIrd\nZAtIJsqnTSA1hnFSNQrxhL5LNE0+FFMEvRnCpWYozTLfEFiBT9yyPbfDkpja0QaP\nzmfx2bg/sxavRG5J17MMzY30S0lrfMjTMA8agBhljUlOpaYrGgO9YyJewePKgp3T\nUPCbtFQrw22JhJoN4ryUALaS3QW4OMjZybuAoMiLePtBd5kJ+WtQkHAQnQGjIol+\nC1xrnZQTOBlSkuat5lTMwC2h3A//Eite+URdTqezkquse38796MVA9C9P5xYtSsM\ne3yTI34GAt/mZHspBs6kXL6S38A0adBFpsZG4ZrgyJ/09xcGZRiY+Ob/1brafoGN\n1/e9JEAYfHAac2NMlbf/c524x5nosMFY72WmkmO4WDRu44plk00euH1I2zdA//bE\nzl/gXITCehaVMhXdNZnOs3WG/Dul54wl8LV59r8eJaIo0i1YAUo9w0JNC+7ZSh/9\ncwmZGNXlQkfyE8mu6A+ykYkL+27Sf1VBZPPhFxZO1ps9sHO9MskWMVucpzVpEaVk\nZqJP393JzgPhRGx/mC2MhB6YB47F8gE0r3SWTJ2QgoJjdeUr3RdklBwBD6CfMsSz\nImbTndHlwYI1/TlECJnR8hS6xwok0KL62rfnKxpnsx51vkmSVn8G0aEtR/nWzLXe\nt4BJT6ou+EHI+J23DfnSG1turESeG8KF4dgv/xnyiZzhD0r5YnJWtyA/h3mConPf\n9Ao/yYUpMjxl6yafvaqzTq7d+v51uSC2WUSE/p9aG0R1hERwAul6XYfjHnumYx5H\nMvbTBINc/pk74kVEegs657tciOWenPHiGE03YODk42vLP8rFVd6LBtOZMASMGycy\nLW1hzJxRClP2AnfYow6xFiE+mMrlanHAGifdbAk3eVKiSgW4jA06TEihbZhQjMHj\nyHZJi7ujwMYs5c+BUUnG1WELdrLk83i/AhTTBOP0/FQfIoDQXeUPUXV4zuAtJ3od\nsWM/Xto2OafyoBwWT5adifFfpmCmibdR8YwFxxQI6MOaY1WHSFkJsLkcalTj2hxI\nzH51TkOKNdeYaNtpqtl/ha9qza4cUbV1k4XsAKc0tx1XCuhuHUoxDL8WzL4jzkjV\niK48Ae3Dy+7XhbPwn5PbgcPCiACHtumHZAmOK4Vca5dGgQG4njtwbbQF6JuCHyzk\no4IMj/Uj4/8Ih5LZZOcBEA==\n\n-----END CERTIFICATE-----" first_seen: '2024-10-12T03:49:13.000000Z' last_seen: '2025-02-07T21:50:50.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-e3c2-4083-a49d-401f431b5f1e company_id: '9727666' common_name: rice.com organization: Pouros-Bergstrom organizational_unit: 'and Sons' locality: null state: 'West Virginia' country: MX serial: Q1KINT99ZG7DXU7Q3XNUNVTAIJZYLSU4 not_valid_before: 20240522T015313Z not_valid_after: 20261102T135410Z value: "-----BEGIN CERTIFICATE-----\nz39+9Dp61FWAzYv8m2OifMw2PjkKIWlBAL2LpII+owRJnEIwlHMrlVedJRuoND4r\nB7KKmPHF95MBoLLQrl7gvIO/pcr7GXFxdbq4P94DMLus1J0T11KceRdraPRaZDNr\nSzotUTmkuXHP2oC+f5bc+Yl6T78HNwILOoXE3zv9ijXVzKDBfIJhg9ulO/f2+V4e\neuPQaFerxrQz6lVZaFn/ZJ8Ohd9EPkOFiS5JpBggX6YkeqWmWoBM8ul6P9cxaXuk\ncXOZlBHUZkFy67x7Va+WVR7BupLlh6Vi+Cm+Ypcr1ZcI8XxnMrBhK0xAqz6Bs485\nnPXiXw6/5RjY8kbXql0eSfdNf83qh+PLLVkAfpENJg3FS8dztdogtQxm/z1UWHge\nXpIAKGwsF40M4uMxo06FCWxb/FQDou/0BGiYRvXBrxI4SISSx52z5vHCbRYW+FnH\nXiQ+6+uIS0EBydZkJF2SNRp1LiuzydST9tQbo3b63aC1QpxCm1KVvpeY+AVSoC4+\ncb3r2hwGgrdc1pjBCKTEDgEECIfWNX/SclxAk69WX9CbmEdHp1wCr2t/9g3IqCwG\nQuryIecfKf5WxyUmAiuUe+Cr5GBL7mFaHskbRMJcF7SWhbYnoOSn8r10uYk01EfG\nXnD9WgJ5AczeHPY3BZrq0GyD/0rYka4zyyH79ebA9ZqTxYOaCyXK96oFaSa3pknG\nDAgFNbplmFkMNJdXRZ/Mw+F8CNmdhIIVeOgDDd7B+tA/AtzmCoV2nWHZzCUdYOLM\nWP+C0WYmMSBxFb4pX3VhN5CwvX2lGebetAllF+r84lWddQmcce/iHfLfp77iB+Ju\nZFrTCHs17nq359E2iFusk2w/qLiDR3GMu7wwurINSkd2K+BUf/zJUYT7x2KNu2yM\njM9iTpUF06ZwnRTmmL4W3488uXcgjF2wJutX35w/M+4xrBWFpJY0IDNdnR+B/AYv\nWjcI3ZiZ7PepVaE9tcVIbGz34wl6VEj3JlG+BgzNl1ADs2VNwPUCeCPIA0yDJrNX\nOzwLgb3QvSkD8OlXjsH5lLiFpCmXRaEn9l8WlGgcVbdjhM7lIe30n88rVBv5/Z09\nKcFLpiBMIF5aJcNCDec9TUsD/7d3VkhNzxKpd3trqJ6QFfhaRKfcx/CRby0o/QfS\nMxpaOsMreErX4iaOhLQi/orPfVl8YQH6SZFKvpNfjVSVYrF6a0qKPtKEIVzRXYtP\nsa2dGznYQsBOTlJMze2MwQh7cn/DDZo7rE5CW1Vno+n0/gjkRRgzQRj4DImRQD5q\nAsYGn46N3Sl6uDGBrX5WlZ2D1omWlxVI6FnksMc+8RG/yXYd7OosveCut5G2f6qK\n3zZT5QC1o2jQJOwwChHLpA==\n\n-----END CERTIFICATE-----" first_seen: '2024-05-23T10:11:16.000000Z' last_seen: '2024-05-24T23:20:44.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' items: type: object properties: id: type: string example: 9fe86d12-e0c3-4d51-bd74-ff6b2c3de31a company_id: type: string example: '4822597' common_name: type: string example: heathcote.net organization: type: string example: 'Lehner, Beer and Deckow' organizational_unit: type: string example: null locality: type: string example: null state: type: string example: Washington country: type: string example: HT serial: type: string example: RICZILLOJPTW8QIRFEGSZ8CYCYTACPPK not_valid_before: type: string example: 20241008T043112Z not_valid_after: type: string example: 20261104T195716Z value: type: string example: "-----BEGIN CERTIFICATE-----\na7bmn7kWPQjUTNTnyLShVrYY1ts4aq4gBoB8/93PcR3w8JLiiMSAzzMLjX8h0QFl\nGtwXGczSbjrQkDAxIfuPQ8XlSj6x9XJAXhzlDHOzHVDqgqgThhjisuviSv61AZTY\nf873YoYzCS4O5ObFBVGcwjO6OpdoAGzIY6A/iTPoHZlck4b8OzpOVzVC++YQqIrd\nZAtIJsqnTSA1hnFSNQrxhL5LNE0+FFMEvRnCpWYozTLfEFiBT9yyPbfDkpja0QaP\nzmfx2bg/sxavRG5J17MMzY30S0lrfMjTMA8agBhljUlOpaYrGgO9YyJewePKgp3T\nUPCbtFQrw22JhJoN4ryUALaS3QW4OMjZybuAoMiLePtBd5kJ+WtQkHAQnQGjIol+\nC1xrnZQTOBlSkuat5lTMwC2h3A//Eite+URdTqezkquse38796MVA9C9P5xYtSsM\ne3yTI34GAt/mZHspBs6kXL6S38A0adBFpsZG4ZrgyJ/09xcGZRiY+Ob/1brafoGN\n1/e9JEAYfHAac2NMlbf/c524x5nosMFY72WmkmO4WDRu44plk00euH1I2zdA//bE\nzl/gXITCehaVMhXdNZnOs3WG/Dul54wl8LV59r8eJaIo0i1YAUo9w0JNC+7ZSh/9\ncwmZGNXlQkfyE8mu6A+ykYkL+27Sf1VBZPPhFxZO1ps9sHO9MskWMVucpzVpEaVk\nZqJP393JzgPhRGx/mC2MhB6YB47F8gE0r3SWTJ2QgoJjdeUr3RdklBwBD6CfMsSz\nImbTndHlwYI1/TlECJnR8hS6xwok0KL62rfnKxpnsx51vkmSVn8G0aEtR/nWzLXe\nt4BJT6ou+EHI+J23DfnSG1turESeG8KF4dgv/xnyiZzhD0r5YnJWtyA/h3mConPf\n9Ao/yYUpMjxl6yafvaqzTq7d+v51uSC2WUSE/p9aG0R1hERwAul6XYfjHnumYx5H\nMvbTBINc/pk74kVEegs657tciOWenPHiGE03YODk42vLP8rFVd6LBtOZMASMGycy\nLW1hzJxRClP2AnfYow6xFiE+mMrlanHAGifdbAk3eVKiSgW4jA06TEihbZhQjMHj\nyHZJi7ujwMYs5c+BUUnG1WELdrLk83i/AhTTBOP0/FQfIoDQXeUPUXV4zuAtJ3od\nsWM/Xto2OafyoBwWT5adifFfpmCmibdR8YwFxxQI6MOaY1WHSFkJsLkcalTj2hxI\nzH51TkOKNdeYaNtpqtl/ha9qza4cUbV1k4XsAKc0tx1XCuhuHUoxDL8WzL4jzkjV\niK48Ae3Dy+7XhbPwn5PbgcPCiACHtumHZAmOK4Vca5dGgQG4njtwbbQF6JuCHyzk\no4IMj/Uj4/8Ih5LZZOcBEA==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2024-10-12T03:49:13.000000Z' last_seen: type: string example: '2025-02-07T21:50:50.000000Z' created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Certificates /v1/certificates/export: get: summary: 'Export certificates.' operationId: exportCertificates description: " Export all certificates for the current company in CSV or XLSX format.\n " parameters: - in: query name: type description: '' example: csv required: true schema: type: 'The type of export to generate' description: '' example: csv nullable: false enum: - csv - xlsx - in: query name: 'filter[common_name]' description: '' example: test.nl required: false schema: type: 'Filter certificates by their common name.' description: '' example: test.nl nullable: false - in: query name: 'filter[organization]' description: '' example: 'Test B.V.' required: false schema: type: 'Filter certificates by their organization name.' description: '' example: 'Test B.V.' nullable: false - in: query name: sort description: '' example: not_valid_after required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before' description: '' example: not_valid_after nullable: false enum: - not_valid_after - in: query name: filter description: '' example: organization required: false schema: type: 'The column(s) to filter by. Eg filter=common_name:test.nl' description: '' example: organization nullable: false enum: - common_name - organization responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Certificates '/v1/certificates/{id}': get: summary: 'Retrieve a certificate.' operationId: retrieveACertificate description: " Retrieves an by its ID.\n " parameters: - in: query name: include description: '' example: applications required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: applications nullable: false enum: - certificates - applications - tags - scans responses: 200: description: 'Successfully retrieved certificate' content: application/json: schema: type: object example: data: id: 9fe86d12-eacf-4f76-9cc7-8cc3595ca9b5 company_id: '9058217' common_name: halvorson.com organization: null organizational_unit: LLC locality: Letitiafurt state: Delaware country: IO serial: 8AJG4X4OK4NCKHVTIF4RCEHOI7WQD2D8 not_valid_before: 20241126T012258Z not_valid_after: 20250708T072556Z value: "-----BEGIN CERTIFICATE-----\nCHHGaou6Tn+nZaA6PlrXyGZIte6K1qBT5fv1wZuS453qR1Gn5w8sc+FhKhe0RW2G\nQXsNYc/0Cxv3Jgl9GctqLcjSyhfAlhmlnQ1LVKbQWq+Ih9UtuaNaQoyVAVV32oy5\nRS4Rx5DVOq0OpPRcQoiqaqD028HC/SOYlIaU0Spt+1ywjlwsWT8XbfJQXNGy8wOU\nX2yAJ+Kv3wTtZd1IFkTo9ximrarLDiEcQkhyN2zPIHVbIX9TExIEkL0B9VXH0fr2\nPzjqjjC6aU498tasKPUbZpdOXqtQvpnh3v/qG+J0krI8qO+XfPssJi58Q4ZUl3c8\nfEcy4p0eT++2b/dHNsQ3u374DYxeQuyr9+eRn7lrBpZVSwqCQsPsoAC4lydApz+L\nnF9OPqe7taEuGU1uXrqxbb7m41BDlNKI5xkCFtYVw3KBOxBO0mpaEn5/ZJx0gS0h\nAZuQ4g4vcGSeOhYaqRcf0o4CwQR7RKbx0f81Vg2ZTYT1jQlfSdszwqSLvOS0GqGq\nDbdKo+s7+n8y2ElRvzXyPkaREJelsYBX+CF5nwD2fPp8Nxz3ZVhIuAhoTp68DIcT\nMv1fXx2ddzQjKnFjp9kp/VTd42wVpns11PwuGzrznPiMcidedH2TMTtQaxjimmmP\n4/iA2wt8qz/U9nKSk5hbV6JB5JeKrOq3qgnRiA4TwpuD+382LbVGZnbYsq/AoVOP\nxzPSp0lamSuNSV9HZoT+Zrsypwhf5k5SzSuJ68ds0MeEYcvWQp4Biix8gJt6smnC\n7RWHkgRQUDPPuw4kUhMav4fq8zBdi0ooaaBK5t7oR2xlrTHlcpYqLW7eE02sWbqe\nmPmrGKZL7w1f+RDQDmzgvUTP9rcSUl6Ty3UNCh+cbQMFsKNnMS8T6l8prwgG2gny\nsoDz9zzuXhtQU0YEdMGxWs0/k1KAEkPEBn2Q+42+5qPMEBgEqrhI3lom9Ar3D2W/\nXCWPQIHrzs9aEupevHoHgePQ1w8Y8DhtPT7fr2JrfL5PwU5AP3AoYcUGN5nqmzt4\nW96aby7AKJFe+YziYkhb+DudVa3fWAND+pBfGoBPU5lDjOeiVZGowsNmgeEjnqNB\nNvnDWMlbgZJhOMkxBtf21PKf0CMETdFwyTdDLMd2YZih+kpWwKKRYUbSp+QWYRSS\nvaObxuCQWCPfIUTd6aJ5oOz/kDV556mQ6PHE+SFcGfbVMO79QJEyU+NfTxY5HhcF\nw/9GdSDC69DE82/bZ9ptXbP+ytpE7V3QRV1QFTF/OvtovkFIkRcDePg5WScdUWKr\nlqfv7BZ2ob6vWG/ILM75YC9kQbu+VKU/9NWU+aCcmy671lYALTe9wAQc/9kNZS2S\n+cipDYQvIs6YKcfEgorVug==\n\n-----END CERTIFICATE-----" first_seen: '2025-02-04T19:12:17.000000Z' last_seen: '2025-09-03T15:26:19.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-eacf-4f76-9cc7-8cc3595ca9b5 company_id: type: string example: '9058217' common_name: type: string example: halvorson.com organization: type: string example: null organizational_unit: type: string example: LLC locality: type: string example: Letitiafurt state: type: string example: Delaware country: type: string example: IO serial: type: string example: 8AJG4X4OK4NCKHVTIF4RCEHOI7WQD2D8 not_valid_before: type: string example: 20241126T012258Z not_valid_after: type: string example: 20250708T072556Z value: type: string example: "-----BEGIN CERTIFICATE-----\nCHHGaou6Tn+nZaA6PlrXyGZIte6K1qBT5fv1wZuS453qR1Gn5w8sc+FhKhe0RW2G\nQXsNYc/0Cxv3Jgl9GctqLcjSyhfAlhmlnQ1LVKbQWq+Ih9UtuaNaQoyVAVV32oy5\nRS4Rx5DVOq0OpPRcQoiqaqD028HC/SOYlIaU0Spt+1ywjlwsWT8XbfJQXNGy8wOU\nX2yAJ+Kv3wTtZd1IFkTo9ximrarLDiEcQkhyN2zPIHVbIX9TExIEkL0B9VXH0fr2\nPzjqjjC6aU498tasKPUbZpdOXqtQvpnh3v/qG+J0krI8qO+XfPssJi58Q4ZUl3c8\nfEcy4p0eT++2b/dHNsQ3u374DYxeQuyr9+eRn7lrBpZVSwqCQsPsoAC4lydApz+L\nnF9OPqe7taEuGU1uXrqxbb7m41BDlNKI5xkCFtYVw3KBOxBO0mpaEn5/ZJx0gS0h\nAZuQ4g4vcGSeOhYaqRcf0o4CwQR7RKbx0f81Vg2ZTYT1jQlfSdszwqSLvOS0GqGq\nDbdKo+s7+n8y2ElRvzXyPkaREJelsYBX+CF5nwD2fPp8Nxz3ZVhIuAhoTp68DIcT\nMv1fXx2ddzQjKnFjp9kp/VTd42wVpns11PwuGzrznPiMcidedH2TMTtQaxjimmmP\n4/iA2wt8qz/U9nKSk5hbV6JB5JeKrOq3qgnRiA4TwpuD+382LbVGZnbYsq/AoVOP\nxzPSp0lamSuNSV9HZoT+Zrsypwhf5k5SzSuJ68ds0MeEYcvWQp4Biix8gJt6smnC\n7RWHkgRQUDPPuw4kUhMav4fq8zBdi0ooaaBK5t7oR2xlrTHlcpYqLW7eE02sWbqe\nmPmrGKZL7w1f+RDQDmzgvUTP9rcSUl6Ty3UNCh+cbQMFsKNnMS8T6l8prwgG2gny\nsoDz9zzuXhtQU0YEdMGxWs0/k1KAEkPEBn2Q+42+5qPMEBgEqrhI3lom9Ar3D2W/\nXCWPQIHrzs9aEupevHoHgePQ1w8Y8DhtPT7fr2JrfL5PwU5AP3AoYcUGN5nqmzt4\nW96aby7AKJFe+YziYkhb+DudVa3fWAND+pBfGoBPU5lDjOeiVZGowsNmgeEjnqNB\nNvnDWMlbgZJhOMkxBtf21PKf0CMETdFwyTdDLMd2YZih+kpWwKKRYUbSp+QWYRSS\nvaObxuCQWCPfIUTd6aJ5oOz/kDV556mQ6PHE+SFcGfbVMO79QJEyU+NfTxY5HhcF\nw/9GdSDC69DE82/bZ9ptXbP+ytpE7V3QRV1QFTF/OvtovkFIkRcDePg5WScdUWKr\nlqfv7BZ2ob6vWG/ILM75YC9kQbu+VKU/9NWU+aCcmy671lYALTe9wAQc/9kNZS2S\n+cipDYQvIs6YKcfEgorVug==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2025-02-04T19:12:17.000000Z' last_seen: type: string example: '2025-09-03T15:26:19.000000Z' created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' tags: - Certificates delete: summary: 'Delete certificate.' operationId: deleteCertificate description: " Will delete an existing certificate \n " parameters: [] responses: 204: description: 'certificate deleted successfully' content: application/json: schema: type: array items: type: object example: [] tags: - Certificates parameters: - in: path name: id description: 'The ID of the certificate.' example: voluptatem required: true schema: type: string '/v1/integrations/{integration_id}/logs': get: summary: 'List integration logs' operationId: listIntegrationLogs description: "Retrieves all logs for a specific integration.\n" parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints parameters: - in: path name: integration_id description: 'The ID of the integration.' example: ratione required: true schema: type: string /v1/integrations: get: summary: 'List Integrations' operationId: listIntegrations description: "Retrieve all enabled integrations for the current company.\n" parameters: [] responses: 200: description: success content: text/plain: schema: type: string example: '[{"autotask": {...}, "another_integration": {...}}]' tags: - Integrations '/v1/integrations/{integration}': post: summary: 'Enable Integration' operationId: enableIntegration description: "Enable a new integration for the current company.\n" parameters: [] responses: 201: description: 'integration enabled' content: application/json: schema: type: object example: message: 'Integration enabled successfully' properties: message: type: string example: 'Integration enabled successfully' 400: description: 'enable failed' content: application/json: schema: type: object example: error: 'Failed to enable integration' properties: error: type: string example: 'Failed to enable integration' 404: description: 'integration not found' content: application/json: schema: type: object example: error: 'Integration not found' properties: error: type: string example: 'Integration not found' 422: description: 'validation error' content: application/json: schema: type: object example: message: 'The given data was invalid.' properties: message: type: string example: 'The given data was invalid.' tags: - Integrations get: summary: 'Show Integration' operationId: showIntegration description: "Retrieve details of a specific enabled integration for the current company.\n" parameters: [] responses: 200: description: success content: text/plain: schema: type: string example: '{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}' 404: description: '' content: application/json: schema: oneOf: - description: 'integration not found' type: object example: error: 'Integration not found' properties: error: type: string example: 'Integration not found' - description: 'integration not enabled' type: object example: error: 'Integration not enabled' properties: error: type: string example: 'Integration not enabled' tags: - Integrations patch: summary: 'Update Integration' operationId: updateIntegration description: "Update the configuration of an enabled integration for the current company.\n" parameters: [] responses: 200: description: success content: application/json: schema: type: object example: message: 'Integration updated successfully' properties: message: type: string example: 'Integration updated successfully' 400: description: 'update failed' content: application/json: schema: type: object example: error: 'Failed to update integration' properties: error: type: string example: 'Failed to update integration' 404: description: 'integration not found' content: application/json: schema: type: object example: error: 'Integration not found' properties: error: type: string example: 'Integration not found' 422: description: 'validation error' content: application/json: schema: type: object example: message: 'The given data was invalid.' properties: message: type: string example: 'The given data was invalid.' tags: - Integrations delete: summary: 'Disable Integration' operationId: disableIntegration description: "Disable a specific integration for the current company.\n" parameters: [] responses: 204: description: 'disable successful' content: text/plain: schema: type: string example: '' 400: description: 'disable failed' content: application/json: schema: type: object example: error: 'Failed to disable integration' properties: error: type: string example: 'Failed to disable integration' tags: - Integrations parameters: - in: path name: integration description: 'The name of the integration to enable.' example: autotask required: true schema: type: string /v1/me: get: summary: 'Retrieve the authenticated user' operationId: retrieveTheAuthenticatedUser description: 'Retrieves the authenticated user and its metadata.' parameters: - in: query name: include description: 'Include additional relationships (comma separated).' example: managingCompany required: false schema: type: string description: 'Include additional relationships (comma separated).' example: managingCompany nullable: false enum: - company - company.type - company.partner - managingCompany - managingCompany.type - managingCompany.partner responses: 200: description: '' content: application/json: schema: type: object example: data: id: 5648424b-95a1-420b-80ce-d9cdc267cd18 company_id: '779675' managing_company_id: '779675' first_name: Anne last_name: Gutmann two_factor_enabled: false two_factor_configured: false email: uoreilly@schinner.net email_verified_at: '2025-09-18T14:35:11Z' phonenumber: 1-352-409-1899 phonenumber_verified_at: '2025-09-18T14:35:11Z' report_interval: weekly manageable_companies: - id: '779675' uuid: 171a628d-5219-4cae-aaaf-8a179b15665e name: Bechtelar-Towne role: name: norole title: 'No role assigned' abilities: [] need_to_configure_2fa: false terms_agreed_at: '2025-09-18T14:35:11Z' sso_provider: null created_at: '2025-09-18T14:35:11Z' updated_at: '2025-09-18T14:35:11Z' links: self: 'http://api.securityhive.io/v1/me' properties: data: type: object properties: id: type: string example: 5648424b-95a1-420b-80ce-d9cdc267cd18 company_id: type: string example: '779675' managing_company_id: type: string example: '779675' first_name: type: string example: Anne last_name: type: string example: Gutmann two_factor_enabled: type: boolean example: false two_factor_configured: type: boolean example: false email: type: string example: uoreilly@schinner.net email_verified_at: type: string example: '2025-09-18T14:35:11Z' phonenumber: type: string example: 1-352-409-1899 phonenumber_verified_at: type: string example: '2025-09-18T14:35:11Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '779675' uuid: 171a628d-5219-4cae-aaaf-8a179b15665e name: Bechtelar-Towne items: type: object properties: id: type: string example: '779675' uuid: type: string example: 171a628d-5219-4cae-aaaf-8a179b15665e name: type: string example: Bechtelar-Towne role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' abilities: type: array example: [] need_to_configure_2fa: type: boolean example: false terms_agreed_at: type: string example: '2025-09-18T14:35:11Z' sso_provider: type: string example: null created_at: type: string example: '2025-09-18T14:35:11Z' updated_at: type: string example: '2025-09-18T14:35:11Z' links: type: object properties: self: type: string example: 'http://api.securityhive.io/v1/me' tags: - Me patch: summary: 'Update the authenticated user' operationId: updateTheAuthenticatedUser description: 'Updates the authenticated user' parameters: [] responses: 204: description: 'update successful' content: text/plain: schema: type: string example: '' 422: description: 'validation error' content: application/json: schema: type: object example: message: 'phonenumber field contains invalid characters' properties: message: type: string example: 'phonenumber field contains invalid characters' tags: - Me requestBody: required: true content: application/json: schema: type: object properties: first_name: type: string description: 'Must not be greater than 100 characters.' example: John nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: Doe nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true managing_company_id: type: string description: 'Must be a valid company id the user has access to.' example: '1' nullable: false report_interval: type: string description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.' example: weekly nullable: false terms_agreed_at: type: string description: 'Must be a valid date.' example: '2025-09-18T14:35:11' nullable: false role: type: string description: 'Must be a valid role name.' example: admin nullable: false required: - terms_agreed_at /v1/tags: get: summary: 'List tags.' operationId: listTags description: " Retrieve all tags for the current company. Look at the 'Retrieve a tag' endpoint for more details on the tag object.\n " parameters: - in: query name: 'filter[name]' description: '' example: veritatis required: false schema: type: 'Filter by tag name.' description: '' example: veritatis nullable: false - in: query name: 'filter[business_impact]' description: '' example: high required: false schema: type: 'Filter by business impact.' description: '' example: high nullable: false - in: query name: 'filter[system_tag]' description: '' example: true required: false schema: type: 'Filter tags that are default.' description: '' example: true nullable: false - in: query name: sort description: '' example: business_impact required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=business_impact' description: '' example: business_impact nullable: false enum: - business_impact - name - created_at - in: query name: include description: '' example: assets required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: assets nullable: false enum: - assets responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-f30c-4b88-bd81-64e048aaff14 company_id: '1587273' name: 1620817a-d916-36de-81da-3bb333c6a1da description: 'Quis vel vitae eum asperiores. Iure doloribus nihil ut eaque quia esse labore. Et excepturi est eos beatae.' business_impact: low system_tag: true asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-f5b7-494b-b6b7-23aed2b4c935 company_id: '9640736' name: a40a7a8d-4881-3ba9-a413-022707052002 description: 'Aut non qui eveniet illo pariatur quidem sint. Illum expedita hic dolores excepturi commodi aut odit. Qui assumenda est iste.' business_impact: critical system_tag: false asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d12-f30c-4b88-bd81-64e048aaff14 company_id: '1587273' name: 1620817a-d916-36de-81da-3bb333c6a1da description: 'Quis vel vitae eum asperiores. Iure doloribus nihil ut eaque quia esse labore. Et excepturi est eos beatae.' business_impact: low system_tag: true asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-f5b7-494b-b6b7-23aed2b4c935 company_id: '9640736' name: a40a7a8d-4881-3ba9-a413-022707052002 description: 'Aut non qui eveniet illo pariatur quidem sint. Illum expedita hic dolores excepturi commodi aut odit. Qui assumenda est iste.' business_impact: critical system_tag: false asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' items: type: object properties: id: type: string example: 9fe86d12-f30c-4b88-bd81-64e048aaff14 company_id: type: string example: '1587273' name: type: string example: 1620817a-d916-36de-81da-3bb333c6a1da description: type: string example: 'Quis vel vitae eum asperiores. Iure doloribus nihil ut eaque quia esse labore. Et excepturi est eos beatae.' business_impact: type: string example: low system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Tags post: summary: 'Create tag.' operationId: createTag description: "Will create a new tag for the current company. \n " parameters: [] responses: 201: description: 'Successfully created tag' content: application/json: schema: type: object example: data: id: 9fe86d12-fb0f-4dd7-a27a-ad10d4fca159 company_id: '5402570' name: a3aedb1f-e73c-3b64-8e72-e62a521f5823 description: 'Repellat ducimus magnam et aut dignissimos quisquam nostrum. Suscipit consequuntur explicabo aut nihil. Nulla sequi enim dignissimos dicta aut natus. Cumque eligendi aut repudiandae velit.' business_impact: medium system_tag: true asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-fb0f-4dd7-a27a-ad10d4fca159 company_id: type: string example: '5402570' name: type: string example: a3aedb1f-e73c-3b64-8e72-e62a521f5823 description: type: string example: 'Repellat ducimus magnam et aut dignissimos quisquam nostrum. Suscipit consequuntur explicabo aut nihil. Nulla sequi enim dignissimos dicta aut natus. Cumque eligendi aut repudiandae velit.' business_impact: type: string example: medium system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' 422: description: 'name field is empty' content: application/json: schema: type: object example: message: 'name is required' properties: message: type: string example: 'name is required' tags: - Tags requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: athsnwpyzbnpyl nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Iusto enim quasi cumque voluptas dolorem saepe optio.' nullable: false business_impact: type: string description: '' example: medium nullable: false enum: - low - medium - high - critical required: - name - description - business_impact '/v1/tags/{id}': get: summary: 'Retrieve a tag.' operationId: retrieveATag description: " Retrieves an tag by its ID.\n " parameters: - in: query name: include description: '' example: assets required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: assets nullable: false enum: - assets responses: 200: description: 'Successfully retrieved tag' content: application/json: schema: type: object example: data: id: 9fe86d12-ff14-4214-a4e5-9a0ec6d27b53 company_id: '5864336' name: d4c4001f-1852-3c6c-b459-68899d4fd38c description: 'Temporibus nulla molestias minima in. Voluptatum voluptatem accusantium fuga tempore facere nemo. Qui non cumque totam. Accusantium quos eos commodi deserunt assumenda a inventore.' business_impact: critical system_tag: false asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-ff14-4214-a4e5-9a0ec6d27b53 company_id: type: string example: '5864336' name: type: string example: d4c4001f-1852-3c6c-b459-68899d4fd38c description: type: string example: 'Temporibus nulla molestias minima in. Voluptatum voluptatem accusantium fuga tempore facere nemo. Qui non cumque totam. Accusantium quos eos commodi deserunt assumenda a inventore.' business_impact: type: string example: critical system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' tags: - Tags patch: summary: 'Update tag.' operationId: updateTag description: "Will update an existing tag \n " parameters: [] responses: 200: description: 'Successfully updated tag' content: application/json: schema: type: object example: data: id: 9fe86d13-03be-4e3b-a28c-f765671827d3 company_id: '9747659' name: ae3d9859-590c-3758-a1e8-78beaabc1fc9 description: 'Ea vero omnis minus aliquam eum libero. Velit ea dolores occaecati ut impedit sequi. In cupiditate consequatur aut nisi autem.' business_impact: critical system_tag: false asset_count: 0 created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d13-03be-4e3b-a28c-f765671827d3 company_id: type: string example: '9747659' name: type: string example: ae3d9859-590c-3758-a1e8-78beaabc1fc9 description: type: string example: 'Ea vero omnis minus aliquam eum libero. Velit ea dolores occaecati ut impedit sequi. In cupiditate consequatur aut nisi autem.' business_impact: type: string example: critical system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' 422: description: 'name field is empty' content: application/json: schema: type: object example: message: 'name is required' properties: message: type: string example: 'name is required' tags: - Tags requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: dmntvjkqvphtx nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Asperiores natus et consequatur.' nullable: false business_impact: type: string description: '' example: critical nullable: false enum: - low - medium - high - critical required: - name - description - business_impact delete: summary: 'Delete tag.' operationId: deleteTag description: "Will delete an existing tag \n " parameters: [] responses: 204: description: 'tag deleted successfully' content: application/json: schema: type: array items: type: object example: [] tags: - Tags parameters: - in: path name: id description: 'The ID of the tag.' example: iusto required: true schema: type: string /v1/users: get: summary: 'List Users' operationId: listUsers description: "Retrieve all users for the current company.\n" parameters: - in: query name: include description: 'Include additional relationships (comma separated).' example: managingCompany.type required: false schema: type: string description: 'Include additional relationships (comma separated).' example: managingCompany.type nullable: false enum: - company - company.type - company.partner - managingCompany - managingCompany.type - managingCompany.partner - in: query name: sort description: 'Sort the results by column(s) (comma separated).' example: 'first_name,-last_name' required: false schema: type: string description: 'Sort the results by column(s) (comma separated).' example: 'first_name,-last_name' nullable: false enum: - first_name - last_name - email - phonenumber - report_interval - created_at - two_factor_enabled - role.title - in: query name: filter description: 'Filter the results by column(s) (comma separated).' example: 'first_name:John,last_name:Doe' required: false schema: type: string description: 'Filter the results by column(s) (comma separated).' example: 'first_name:John,last_name:Doe' nullable: false enum: - first_name - last_name - email - phonenumber - report_interval responses: 200: description: '' content: application/json: schema: type: object example: data: - id: ea0186c0-a88b-4e98-9984-a82a1a08e142 company_id: '4992579' managing_company_id: '4992579' first_name: Tanner last_name: McDermott two_factor_enabled: false email: bbartoletti@goyette.net email_verified_at: '2025-09-18T14:35:11.000000Z' phonenumber: 254.871.2182 phonenumber_verified_at: '2025-09-18T14:35:11.000000Z' report_interval: weekly manageable_companies: - id: '4992579' uuid: 6259aaab-2d9a-4365-abf4-a394ec8d8d11 name: Zboncak-Kirlin role: name: norole title: 'No role assigned' terms_agreed_at: '2025-09-18T14:35:11.000000Z' sso_provider: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:12.000000Z' - id: 47fa7464-da25-4bad-a304-6a4b0ad2d799 company_id: '7258487' managing_company_id: '7258487' first_name: Scottie last_name: "O'Keefe" two_factor_enabled: false email: gleichner.verna@eichmann.com email_verified_at: '2025-09-18T14:35:12.000000Z' phonenumber: 262.679.2468 phonenumber_verified_at: '2025-09-18T14:35:12.000000Z' report_interval: weekly manageable_companies: - id: '7258487' uuid: 2cb168cd-5876-432e-9b03-1edccb3eaf88 name: 'Willms Inc' role: name: norole title: 'No role assigned' terms_agreed_at: '2025-09-18T14:35:12.000000Z' sso_provider: null created_at: '2025-09-18T14:35:12.000000Z' updated_at: '2025-09-18T14:35:12.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: ea0186c0-a88b-4e98-9984-a82a1a08e142 company_id: '4992579' managing_company_id: '4992579' first_name: Tanner last_name: McDermott two_factor_enabled: false email: bbartoletti@goyette.net email_verified_at: '2025-09-18T14:35:11.000000Z' phonenumber: 254.871.2182 phonenumber_verified_at: '2025-09-18T14:35:11.000000Z' report_interval: weekly manageable_companies: - id: '4992579' uuid: 6259aaab-2d9a-4365-abf4-a394ec8d8d11 name: Zboncak-Kirlin role: name: norole title: 'No role assigned' terms_agreed_at: '2025-09-18T14:35:11.000000Z' sso_provider: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:12.000000Z' - id: 47fa7464-da25-4bad-a304-6a4b0ad2d799 company_id: '7258487' managing_company_id: '7258487' first_name: Scottie last_name: "O'Keefe" two_factor_enabled: false email: gleichner.verna@eichmann.com email_verified_at: '2025-09-18T14:35:12.000000Z' phonenumber: 262.679.2468 phonenumber_verified_at: '2025-09-18T14:35:12.000000Z' report_interval: weekly manageable_companies: - id: '7258487' uuid: 2cb168cd-5876-432e-9b03-1edccb3eaf88 name: 'Willms Inc' role: name: norole title: 'No role assigned' terms_agreed_at: '2025-09-18T14:35:12.000000Z' sso_provider: null created_at: '2025-09-18T14:35:12.000000Z' updated_at: '2025-09-18T14:35:12.000000Z' items: type: object properties: id: type: string example: ea0186c0-a88b-4e98-9984-a82a1a08e142 company_id: type: string example: '4992579' managing_company_id: type: string example: '4992579' first_name: type: string example: Tanner last_name: type: string example: McDermott two_factor_enabled: type: boolean example: false email: type: string example: bbartoletti@goyette.net email_verified_at: type: string example: '2025-09-18T14:35:11.000000Z' phonenumber: type: string example: 254.871.2182 phonenumber_verified_at: type: string example: '2025-09-18T14:35:11.000000Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '4992579' uuid: 6259aaab-2d9a-4365-abf4-a394ec8d8d11 name: Zboncak-Kirlin items: type: object properties: id: type: string example: '4992579' uuid: type: string example: 6259aaab-2d9a-4365-abf4-a394ec8d8d11 name: type: string example: Zboncak-Kirlin role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' terms_agreed_at: type: string example: '2025-09-18T14:35:11.000000Z' sso_provider: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:12.000000Z' links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Users post: summary: 'Create User' operationId: createUser description: "Create a new user for the current company.\n" parameters: [] responses: 201: description: 'user created' content: application/json: schema: type: object example: data: id: 1 uuid: 00000000-0000-0000-0000-000000000000 properties: data: type: object properties: id: type: integer example: 1 uuid: type: string example: 00000000-0000-0000-0000-000000000000 404: description: 'role not found' content: application/json: schema: type: object example: message: 'role not found' properties: message: type: string example: 'role not found' 422: description: 'validation error' content: application/json: schema: type: object example: message: 'phonenumber field contains invalid characters' properties: message: type: string example: 'phonenumber field contains invalid characters' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: first_name: type: string description: 'Must not be greater than 100 characters.' example: wtcdaihzaqw nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: gtnmhqxoe nullable: false email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: howell.trinity@example.com nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true report_interval: type: string description: '' example: quarterly nullable: false enum: - disabled - weekly - monthly - quarterly role: type: required description: 'string Must be a valid role name.' example: admin nullable: false required: - first_name - last_name - email - report_interval '/v1/users/{user_uuid}': get: summary: 'Retrieve an user' operationId: retrieveAnUser description: "Retrieves an user for the current company.\n" parameters: - in: query name: include description: 'Include additional relationships (comma separated).' example: managingCompany required: false schema: type: string description: 'Include additional relationships (comma separated).' example: managingCompany nullable: false enum: - company - company.type - company.partner - managingCompany - managingCompany.type - managingCompany.partner responses: 200: description: '' content: application/json: schema: type: object example: data: id: dc0bf0c1-353c-4f4b-aad0-b62f1f31d27b company_id: '5498148' managing_company_id: '5498148' first_name: Mohammad last_name: Shanahan two_factor_enabled: false email: xjohnston@ankunding.com email_verified_at: '2025-09-18T14:35:12.000000Z' phonenumber: 361-400-3068 phonenumber_verified_at: '2025-09-18T14:35:12.000000Z' report_interval: weekly manageable_companies: - id: '5498148' uuid: b2025cba-1109-48fc-b9e7-07bf283967c9 name: Gislason-Franecki role: name: norole title: 'No role assigned' terms_agreed_at: '2025-09-18T14:35:12.000000Z' sso_provider: null created_at: '2025-09-18T14:35:12.000000Z' updated_at: '2025-09-18T14:35:12.000000Z' properties: data: type: object properties: id: type: string example: dc0bf0c1-353c-4f4b-aad0-b62f1f31d27b company_id: type: string example: '5498148' managing_company_id: type: string example: '5498148' first_name: type: string example: Mohammad last_name: type: string example: Shanahan two_factor_enabled: type: boolean example: false email: type: string example: xjohnston@ankunding.com email_verified_at: type: string example: '2025-09-18T14:35:12.000000Z' phonenumber: type: string example: 361-400-3068 phonenumber_verified_at: type: string example: '2025-09-18T14:35:12.000000Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '5498148' uuid: b2025cba-1109-48fc-b9e7-07bf283967c9 name: Gislason-Franecki items: type: object properties: id: type: string example: '5498148' uuid: type: string example: b2025cba-1109-48fc-b9e7-07bf283967c9 name: type: string example: Gislason-Franecki role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' terms_agreed_at: type: string example: '2025-09-18T14:35:12.000000Z' sso_provider: type: string example: null created_at: type: string example: '2025-09-18T14:35:12.000000Z' updated_at: type: string example: '2025-09-18T14:35:12.000000Z' 404: description: 'user not found' content: application/json: schema: type: object example: message: 'user not found' properties: message: type: string example: 'user not found' tags: - Users patch: summary: 'Update an user' operationId: updateAnUser description: "Updates an user for the current company.\n" parameters: [] responses: 204: description: 'update successful' content: text/plain: schema: type: string example: '' 403: description: '' content: application/json: schema: oneOf: - description: 'invalid password' type: object example: message: 'The old password is incorrect.' properties: message: type: string example: 'The old password is incorrect.' - description: 'change password of other user' type: object example: message: 'You are not allowed to change the password of another user.' properties: message: type: string example: 'You are not allowed to change the password of another user.' 404: description: 'user not found' content: application/json: schema: type: object example: message: 'user not found' properties: message: type: string example: 'user not found' 422: description: 'validation error' content: application/json: schema: type: object example: message: 'phonenumber field contains invalid characters' properties: message: type: string example: 'phonenumber field contains invalid characters' tags: - Users requestBody: required: false content: application/json: schema: type: object properties: first_name: type: string description: 'Must not be greater than 100 characters.' example: John nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: Doe nullable: false email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: john@doe.com nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true report_interval: type: string description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.' example: weekly nullable: false role: type: string description: 'Must be a valid role name.' example: admin nullable: false delete: summary: 'Delete an user' operationId: deleteAnUser description: "Deletes an user for the current company.\n" parameters: [] responses: 204: description: 'delete successful' content: text/plain: schema: type: string example: '' 404: description: 'user not found' content: application/json: schema: type: object example: message: 'user not found' properties: message: type: string example: 'user not found' tags: - Users parameters: - in: path name: user_uuid description: 'string The id of the user' example: bc34b6b6-09d7-36da-a88e-eff645750565 required: true schema: type: string /v1/vulnerabilities: get: summary: 'List vulnerabilities.' operationId: listVulnerabilities description: " Retrieve all vulnerabilities for the current company. Look at the 'Retrieve a vulnerability' endpoint for more details on the vulnerability object.\n " parameters: - in: query name: 'filter[name]' description: '' example: SQL required: false schema: type: 'Filter vulnerabilities by their name' description: '' example: SQL nullable: false - in: query name: 'filter[host]' description: '' example: 192.168.1.1 required: false schema: type: 'Filter vulnerabilities found on host' description: '' example: 192.168.1.1 nullable: false - in: query name: 'filter[hostname]' description: '' example: laptop-1.local required: false schema: type: 'Filter vulnerabilities found on hostname' description: '' example: laptop-1.local nullable: false - in: query name: 'filter[status]' description: '' example: Unresolved required: false schema: type: 'Filter vulnerabilities by their status' description: '' example: Unresolved nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired - in: query name: 'filter[threat]' description: '' example: Medium required: false schema: type: 'Filter vulnerabilities by their threat level' description: '' example: Medium nullable: false enum: - Log - Low - Medium - High - Critical - in: query name: 'filter[scan_id]' description: '' example: '123' required: false schema: type: 'Filter vulnerabilities found by given scan_id' description: '' example: '123' nullable: false - in: query name: 'filter[family]' description: '' example: 'SQL Injection' required: false schema: type: 'Filter vulnerabilities by their family' description: '' example: 'SQL Injection' nullable: false - in: query name: sort description: '' example: cvss_base_score required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: cvss_base_score nullable: false enum: - name - port - cvss_base_score - epss_score - qod_type - last_seen responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-9f27-46b1-993f-c6d2cb3d2ce7 asset_id: 9fe86d12-9802-41b3-910f-b1af39ee6c9c company_id: '540672' vulnerability_definition_id: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed vulnerability_definition: id: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed name: '6 exploitable through vel manipulation' description: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' solution: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' category: '6' threat_level: Critical definition_type: openvas definition: id: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: '6 exploitable through vel manipulation' family: '6' reference_urls: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: 'CVE-2018-1063, CVE-2021-6721' solution_type: Mitigation solution_description: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: Log qod_type: remote_active qod_value: 75 cvss_base_score: 3.1 cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' epss: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' host: 230.237.173.10 hostname: turner.com port: 2396/tcp details: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' status: Accepted first_seen: '2025-08-02T15:21:55.000000Z' last_seen: '2025-09-13T09:12:25.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' name: '6 exploitable through vel manipulation' description: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' cvss_base_score: 3.1 cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' qod_type: remote_active qod_value: 75 threat: Critical scanner_id: null scanner_hostname: null plugin: id: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: '6 exploitable through vel manipulation' family: '6' reference_urls: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: 'CVE-2018-1063, CVE-2021-6721' solution_type: Mitigation solution_description: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: Log qod_type: remote_active qod_value: 75 - id: 9fe86d12-a793-49fc-ac10-ec1475e42927 asset_id: 9fe86d12-a321-47d4-a34c-88f245e93125 company_id: '9101626' vulnerability_definition_id: 9fe86d12-a711-4393-a18a-10a373b96b5a vulnerability_definition: id: 9fe86d12-a711-4393-a18a-10a373b96b5a name: '10 due to improper optio handling' description: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' solution: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' category: '10' threat_level: Low definition_type: openvas definition: id: 9fe86d12-a5e1-472f-adea-86a60f2c9d4c o_id: a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e name: '10 due to improper optio handling' family: '10' reference_urls: 'http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis' reference_cves: 'CVE-2022-7508, CVE-2018-1313' solution_type: WorkAround solution_description: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' summary: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' insight: 'Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.' affected: 'Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.' impact: 'Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.' vuldetect: 'Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.' priority: High qod_type: package qod_value: 60 cvss_base_score: 2.5 cvss_base_vector: 'AV:N/AC:H/Au:S/C:P/I:C/A:P' epss: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' host: 233.149.132.167 hostname: dare.com port: 1433/tcp details: 'Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.' status: Detected first_seen: '2025-07-10T00:59:16.000000Z' last_seen: '2025-08-20T12:11:17.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' name: '10 due to improper optio handling' description: 'Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.' cvss_base_score: 2.5 cvss_base_vector: 'AV:N/AC:H/Au:S/C:P/I:C/A:P' qod_type: package qod_value: 60 threat: Low scanner_id: null scanner_hostname: null plugin: id: 9fe86d12-a5e1-472f-adea-86a60f2c9d4c o_id: a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e name: '10 due to improper optio handling' family: '10' reference_urls: 'http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis' reference_cves: 'CVE-2022-7508, CVE-2018-1313' solution_type: WorkAround solution_description: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' summary: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' insight: 'Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.' affected: 'Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.' impact: 'Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.' vuldetect: 'Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.' priority: High qod_type: package qod_value: 60 links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d12-9f27-46b1-993f-c6d2cb3d2ce7 asset_id: 9fe86d12-9802-41b3-910f-b1af39ee6c9c company_id: '540672' vulnerability_definition_id: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed vulnerability_definition: id: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed name: '6 exploitable through vel manipulation' description: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' solution: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' category: '6' threat_level: Critical definition_type: openvas definition: id: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: '6 exploitable through vel manipulation' family: '6' reference_urls: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: 'CVE-2018-1063, CVE-2021-6721' solution_type: Mitigation solution_description: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: Log qod_type: remote_active qod_value: 75 cvss_base_score: 3.1 cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' epss: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' host: 230.237.173.10 hostname: turner.com port: 2396/tcp details: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' status: Accepted first_seen: '2025-08-02T15:21:55.000000Z' last_seen: '2025-09-13T09:12:25.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' name: '6 exploitable through vel manipulation' description: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' cvss_base_score: 3.1 cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' qod_type: remote_active qod_value: 75 threat: Critical scanner_id: null scanner_hostname: null plugin: id: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: '6 exploitable through vel manipulation' family: '6' reference_urls: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: 'CVE-2018-1063, CVE-2021-6721' solution_type: Mitigation solution_description: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: Log qod_type: remote_active qod_value: 75 - id: 9fe86d12-a793-49fc-ac10-ec1475e42927 asset_id: 9fe86d12-a321-47d4-a34c-88f245e93125 company_id: '9101626' vulnerability_definition_id: 9fe86d12-a711-4393-a18a-10a373b96b5a vulnerability_definition: id: 9fe86d12-a711-4393-a18a-10a373b96b5a name: '10 due to improper optio handling' description: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' solution: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' category: '10' threat_level: Low definition_type: openvas definition: id: 9fe86d12-a5e1-472f-adea-86a60f2c9d4c o_id: a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e name: '10 due to improper optio handling' family: '10' reference_urls: 'http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis' reference_cves: 'CVE-2022-7508, CVE-2018-1313' solution_type: WorkAround solution_description: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' summary: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' insight: 'Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.' affected: 'Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.' impact: 'Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.' vuldetect: 'Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.' priority: High qod_type: package qod_value: 60 cvss_base_score: 2.5 cvss_base_vector: 'AV:N/AC:H/Au:S/C:P/I:C/A:P' epss: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' host: 233.149.132.167 hostname: dare.com port: 1433/tcp details: 'Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.' status: Detected first_seen: '2025-07-10T00:59:16.000000Z' last_seen: '2025-08-20T12:11:17.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' name: '10 due to improper optio handling' description: 'Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.' cvss_base_score: 2.5 cvss_base_vector: 'AV:N/AC:H/Au:S/C:P/I:C/A:P' qod_type: package qod_value: 60 threat: Low scanner_id: null scanner_hostname: null plugin: id: 9fe86d12-a5e1-472f-adea-86a60f2c9d4c o_id: a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e name: '10 due to improper optio handling' family: '10' reference_urls: 'http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis' reference_cves: 'CVE-2022-7508, CVE-2018-1313' solution_type: WorkAround solution_description: 'Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.' summary: 'Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.' insight: 'Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.' affected: 'Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.' impact: 'Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.' vuldetect: 'Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.' priority: High qod_type: package qod_value: 60 items: type: object properties: id: type: string example: 9fe86d12-9f27-46b1-993f-c6d2cb3d2ce7 asset_id: type: string example: 9fe86d12-9802-41b3-910f-b1af39ee6c9c company_id: type: string example: '540672' vulnerability_definition_id: type: string example: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed vulnerability_definition: type: object properties: id: type: string example: 9fe86d12-9e5b-4a19-8631-edfcdcbb15ed name: type: string example: '6 exploitable through vel manipulation' description: type: string example: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' solution: type: string example: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' category: type: string example: '6' threat_level: type: string example: Critical definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: type: string example: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: type: string example: '6 exploitable through vel manipulation' family: type: string example: '6' reference_urls: type: string example: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: type: string example: 'CVE-2018-1063, CVE-2021-6721' solution_type: type: string example: Mitigation solution_description: type: string example: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: type: string example: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: type: string example: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: type: string example: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: type: string example: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: type: string example: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: type: string example: Log qod_type: type: string example: remote_active qod_value: type: integer example: 75 cvss_base_score: type: number example: 3.1 cvss_base_vector: type: string example: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' epss: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' host: type: string example: 230.237.173.10 hostname: type: string example: turner.com port: type: string example: 2396/tcp details: type: string example: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' status: type: string example: Accepted first_seen: type: string example: '2025-08-02T15:21:55.000000Z' last_seen: type: string example: '2025-09-13T09:12:25.000000Z' created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' name: type: string example: '6 exploitable through vel manipulation' description: type: string example: 'Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.' cvss_base_score: type: number example: 3.1 cvss_base_vector: type: string example: 'AV:L/AC:H/Au:N/C:C/I:P/A:P' qod_type: type: string example: remote_active qod_value: type: integer example: 75 threat: type: string example: Critical scanner_id: type: string example: null scanner_hostname: type: string example: null plugin: type: object properties: id: type: string example: 9fe86d12-9c15-476c-becf-132c50e5ce67 o_id: type: string example: f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c name: type: string example: '6 exploitable through vel manipulation' family: type: string example: '6' reference_urls: type: string example: 'http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam' reference_cves: type: string example: 'CVE-2018-1063, CVE-2021-6721' solution_type: type: string example: Mitigation solution_description: type: string example: 'Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.' summary: type: string example: 'Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.' insight: type: string example: 'Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.' affected: type: string example: 'Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.' impact: type: string example: 'Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.' vuldetect: type: string example: 'Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.' priority: type: string example: Log qod_type: type: string example: remote_active qod_value: type: integer example: 75 links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - Vulnerabilities requestBody: required: false content: application/json: schema: type: object properties: filter: type: object description: '' example: [] nullable: false properties: name: type: string description: 'Must not be greater than 255 characters.' example: bmshnnfyvwbpukcrmx nullable: false threat_level: type: string description: '' example: Medium nullable: false enum: - Log - Low - Medium - High - Critical host: type: string description: 'Must not be greater than 255 characters.' example: nyuvwhwmndai nullable: false hostname: type: string description: 'Must not be greater than 255 characters.' example: apcrgmzlncfthdpsfsj nullable: false status: type: string description: '' example: Unresolved nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired scan_id: type: string description: 'Must be a valid UUID.' example: a5130d2f-857b-3ee2-aa3d-a6ccd1db3990 nullable: false per_page: type: integer description: 'Must be at least 1. Must not be greater than 200.' example: 1 nullable: false '/v1/vulnerabilities/{id}': get: summary: 'Retrieve a vulnerability.' operationId: retrieveAVulnerability description: " Retrieves a vulnerability by its ID.\n " parameters: [] responses: 200: description: 'Successfully retrieved vulnerability' content: application/json: schema: type: object example: data: id: 9fe86d12-b589-46df-8604-335d4783e6f4 asset_id: 9fe86d12-b137-4a5a-85cb-a3099f4cb962 company_id: '7512227' vulnerability_definition_id: 9fe86d12-b510-4934-85ba-efaeede2840d vulnerability_definition: id: 9fe86d12-b510-4934-85ba-efaeede2840d name: 'Clear-text Transmission affecting veniam functionality' description: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' solution: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' category: 'Clear-text Transmission' threat_level: High definition_type: openvas definition: id: 9fe86d12-b3e1-4433-b120-6d5c34a0a724 o_id: ea947967-302b-346e-8f47-2eeffb9a3d5e name: 'Clear-text Transmission affecting veniam functionality' family: 'Clear-text Transmission' reference_urls: 'http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/' reference_cves: 'CVE-2016-4777, CVE-2022-6060' solution_type: WorkAround solution_description: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' summary: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' insight: 'Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.' affected: 'Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.' impact: 'Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.' vuldetect: 'Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.' priority: Low qod_type: exploit qod_value: 27 cvss_base_score: 3.5 cvss_base_vector: 'AV:N/AC:L/Au:N/C:N/I:C/A:P' epss: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' host: 102.254.13.186 hostname: veum.com port: 80/tcp details: 'Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.' status: Resolved first_seen: '2025-01-05T22:19:37.000000Z' last_seen: '2025-08-20T00:02:33.000000Z' created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' name: 'Clear-text Transmission affecting veniam functionality' description: 'Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.' cvss_base_score: 3.5 cvss_base_vector: 'AV:N/AC:L/Au:N/C:N/I:C/A:P' qod_type: exploit qod_value: 27 threat: High scanner_id: null scanner_hostname: null plugin: id: 9fe86d12-b3e1-4433-b120-6d5c34a0a724 o_id: ea947967-302b-346e-8f47-2eeffb9a3d5e name: 'Clear-text Transmission affecting veniam functionality' family: 'Clear-text Transmission' reference_urls: 'http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/' reference_cves: 'CVE-2016-4777, CVE-2022-6060' solution_type: WorkAround solution_description: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' summary: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' insight: 'Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.' affected: 'Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.' impact: 'Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.' vuldetect: 'Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.' priority: Low qod_type: exploit qod_value: 27 properties: data: type: object properties: id: type: string example: 9fe86d12-b589-46df-8604-335d4783e6f4 asset_id: type: string example: 9fe86d12-b137-4a5a-85cb-a3099f4cb962 company_id: type: string example: '7512227' vulnerability_definition_id: type: string example: 9fe86d12-b510-4934-85ba-efaeede2840d vulnerability_definition: type: object properties: id: type: string example: 9fe86d12-b510-4934-85ba-efaeede2840d name: type: string example: 'Clear-text Transmission affecting veniam functionality' description: type: string example: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' solution: type: string example: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' category: type: string example: 'Clear-text Transmission' threat_level: type: string example: High definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9fe86d12-b3e1-4433-b120-6d5c34a0a724 o_id: type: string example: ea947967-302b-346e-8f47-2eeffb9a3d5e name: type: string example: 'Clear-text Transmission affecting veniam functionality' family: type: string example: 'Clear-text Transmission' reference_urls: type: string example: 'http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/' reference_cves: type: string example: 'CVE-2016-4777, CVE-2022-6060' solution_type: type: string example: WorkAround solution_description: type: string example: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' summary: type: string example: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' insight: type: string example: 'Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.' affected: type: string example: 'Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.' impact: type: string example: 'Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.' vuldetect: type: string example: 'Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.' priority: type: string example: Low qod_type: type: string example: exploit qod_value: type: integer example: 27 cvss_base_score: type: number example: 3.5 cvss_base_vector: type: string example: 'AV:N/AC:L/Au:N/C:N/I:C/A:P' epss: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' host: type: string example: 102.254.13.186 hostname: type: string example: veum.com port: type: string example: 80/tcp details: type: string example: 'Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.' status: type: string example: Resolved first_seen: type: string example: '2025-01-05T22:19:37.000000Z' last_seen: type: string example: '2025-08-20T00:02:33.000000Z' created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' name: type: string example: 'Clear-text Transmission affecting veniam functionality' description: type: string example: 'Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.' cvss_base_score: type: number example: 3.5 cvss_base_vector: type: string example: 'AV:N/AC:L/Au:N/C:N/I:C/A:P' qod_type: type: string example: exploit qod_value: type: integer example: 27 threat: type: string example: High scanner_id: type: string example: null scanner_hostname: type: string example: null plugin: type: object properties: id: type: string example: 9fe86d12-b3e1-4433-b120-6d5c34a0a724 o_id: type: string example: ea947967-302b-346e-8f47-2eeffb9a3d5e name: type: string example: 'Clear-text Transmission affecting veniam functionality' family: type: string example: 'Clear-text Transmission' reference_urls: type: string example: 'http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/' reference_cves: type: string example: 'CVE-2016-4777, CVE-2022-6060' solution_type: type: string example: WorkAround solution_description: type: string example: 'Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.' summary: type: string example: 'Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.' insight: type: string example: 'Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.' affected: type: string example: 'Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.' impact: type: string example: 'Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.' vuldetect: type: string example: 'Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.' priority: type: string example: Low qod_type: type: string example: exploit qod_value: type: integer example: 27 tags: - Vulnerabilities parameters: - in: path name: id description: 'The ID of the vulnerability.' example: sunt required: true schema: type: string /v1/webhook-events: get: summary: 'List all webhook events' operationId: listAllWebhookEvents description: "Lists all webhook events for the authenticated user's company.\n" parameters: - in: query name: sort description: 'Sort the results by column(s) (comma separated).' example: event required: false schema: type: string description: 'Sort the results by column(s) (comma separated).' example: event nullable: false enum: - webhook_id - event - status - next_retry_at - in: query name: filter description: 'Filter the results by column(s) (comma separated).' example: event required: false schema: type: string description: 'Filter the results by column(s) (comma separated).' example: event nullable: false enum: - webhook_id - event - status responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-7649-42ee-a782-3e20e467aed9 webhook_id: 9fe86d12-756d-4e4f-8a9f-440d5da786ed event: occaecati payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-79f3-47ba-83e0-0db66f7baf58 webhook_id: 9fe86d12-7934-4bdc-a32b-162b721084f5 event: aut payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' links: first: '/?page=1' last: '/?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9fe86d12-7649-42ee-a782-3e20e467aed9 webhook_id: 9fe86d12-756d-4e4f-8a9f-440d5da786ed event: occaecati payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-79f3-47ba-83e0-0db66f7baf58 webhook_id: 9fe86d12-7934-4bdc-a32b-162b721084f5 event: aut payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' items: type: object properties: id: type: string example: 9fe86d12-7649-42ee-a782-3e20e467aed9 webhook_id: type: string example: 9fe86d12-756d-4e4f-8a9f-440d5da786ed event: type: string example: occaecati payload: type: object properties: key: type: string example: value status: type: string example: pending retries: type: integer example: 0 next_retry_at: type: string example: null last_sent_at: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' links: type: object properties: first: type: string example: '/?page=1' last: type: string example: '/?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' page: null active: false - url: '/?page=1' label: '1' page: 1 active: true - url: null label: 'Next »' page: null active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' page: type: string example: null active: type: boolean example: false path: type: string example: / per_page: type: integer example: 10 to: type: integer example: 2 total: type: integer example: 2 tags: - 'Webhook Events' /v1/webhook-events/types: get: summary: 'List all available webhook event types' operationId: listAllAvailableWebhookEventTypes description: "Lists all webhook event types that can be used.\n" parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Webhook Events' '/v1/webhook-events/{webhookEvent_id}': get: summary: 'Retrieve an webhook event' operationId: retrieveAnWebhookEvent description: "Retrieves an webhook event for the current company.\n" parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 9fe86d12-8566-4f81-aba4-8730fe586497 webhook_id: 9fe86d12-84ad-46ba-99fb-26b3958d19ce event: omnis payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-8566-4f81-aba4-8730fe586497 webhook_id: type: string example: 9fe86d12-84ad-46ba-99fb-26b3958d19ce event: type: string example: omnis payload: type: object properties: key: type: string example: value status: type: string example: pending retries: type: integer example: 0 next_retry_at: type: string example: null last_sent_at: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' 404: description: 'webhook event not found' content: application/json: schema: type: object example: message: 'webhook event not found' properties: message: type: string example: 'webhook event not found' tags: - 'Webhook Events' parameters: - in: path name: webhookEvent_id description: 'The ID of the webhookEvent.' example: 9fe86d12-7649-42ee-a782-3e20e467aed9 required: true schema: type: string /v1/webhooks: get: summary: 'List all webhooks' operationId: listAllWebhooks description: "Lists all webhooks for the authenticated user's company.\n" parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9fe86d12-5782-4ea7-ac8b-7324884f002b company_id: bee1358d-7f15-480b-90ac-a2e22fdbf5d8 url: 'https://ondricka.biz' description: null events: [] secret: 4ef3673691fdc33cb4f0b9615a0e92cb63486751eab78eed3b6a6e1b9840e40b last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-5cfb-414b-8f3f-d6f1432736bc company_id: 716405dc-e1ff-43a9-a7b2-4d1bc95a5125 url: 'https://klocko.com' description: null events: [] secret: 2a757e533a6c3c68b3997912dd1a7bca3caa15a80c9574e2dcf319d14112a3bd last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: array example: - id: 9fe86d12-5782-4ea7-ac8b-7324884f002b company_id: bee1358d-7f15-480b-90ac-a2e22fdbf5d8 url: 'https://ondricka.biz' description: null events: [] secret: 4ef3673691fdc33cb4f0b9615a0e92cb63486751eab78eed3b6a6e1b9840e40b last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' - id: 9fe86d12-5cfb-414b-8f3f-d6f1432736bc company_id: 716405dc-e1ff-43a9-a7b2-4d1bc95a5125 url: 'https://klocko.com' description: null events: [] secret: 2a757e533a6c3c68b3997912dd1a7bca3caa15a80c9574e2dcf319d14112a3bd last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' items: type: object properties: id: type: string example: 9fe86d12-5782-4ea7-ac8b-7324884f002b company_id: type: string example: bee1358d-7f15-480b-90ac-a2e22fdbf5d8 url: type: string example: 'https://ondricka.biz' description: type: string example: null events: type: array example: [] secret: type: string example: 4ef3673691fdc33cb4f0b9615a0e92cb63486751eab78eed3b6a6e1b9840e40b last_sent_at: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' tags: - Webhooks post: summary: 'Create Webhook' operationId: createWebhook description: "Create a new webhook for the current company.\n" parameters: [] responses: 201: description: 'webhook created' content: application/json: schema: type: object example: data: id: 00000000-0000-0000-0000-000000000000 properties: data: type: object properties: id: type: string example: 00000000-0000-0000-0000-000000000000 422: description: '' content: application/json: schema: oneOf: - description: 'url is already used by company' type: object example: message: 'The url has already been taken.' properties: message: type: string example: 'The url has already been taken.' - description: 'validation error' type: object example: message: 'invalid url' properties: message: type: string example: 'invalid url' tags: - Webhooks requestBody: required: true content: application/json: schema: type: object properties: url: type: string description: 'Must be a valid URL. Must not be greater than 2048 characters.' example: 'http://kris.biz/harum-voluptas-natus-qui-voluptatum-laboriosam' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Earum enim omnis beatae consectetur facere omnis fuga.' nullable: true events: type: array description: '' example: null items: type: string required: - url '/v1/webhooks/{webhook_id}': get: summary: 'Retrieve a webhook' operationId: retrieveAWebhook description: "Retrieves a webhook for the current company.\n" parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 9fe86d12-666d-49ea-bc0c-3ede77d4133e company_id: e0a47e25-55d0-42fb-be83-bb792f853b4f url: 'https://kunze.com' description: null events: [] secret: db51db8dfc56ca7fec4f37147dbb768fddf5e47041e3e80ba3f3ac7ce71eb004 last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-666d-49ea-bc0c-3ede77d4133e company_id: type: string example: e0a47e25-55d0-42fb-be83-bb792f853b4f url: type: string example: 'https://kunze.com' description: type: string example: null events: type: array example: [] secret: type: string example: db51db8dfc56ca7fec4f37147dbb768fddf5e47041e3e80ba3f3ac7ce71eb004 last_sent_at: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' 404: description: 'webhook not found' content: application/json: schema: type: object example: message: 'webhook not found' properties: message: type: string example: 'webhook not found' tags: - Webhooks patch: summary: 'Update a webhook' operationId: updateAWebhook description: "Updates a webhook for the current company.\n" parameters: [] responses: 200: description: 'update successful' content: text/plain: schema: type: string example: '' 404: description: 'webhook not found' content: application/json: schema: type: object example: message: 'webhook not found' properties: message: type: string example: 'webhook not found' 422: description: '' content: application/json: schema: oneOf: - description: 'url is already used by company' type: object example: message: 'The url has already been taken.' properties: message: type: string example: 'The url has already been taken.' - description: 'validation error' type: object example: message: 'invalid url' properties: message: type: string example: 'invalid url' tags: - Webhooks requestBody: required: true content: application/json: schema: type: object properties: url: type: string description: 'Must be a valid URL.' example: 'http://collins.com/non-voluptatem-similique-eaque-eaque-eius-necessitatibus' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Veniam placeat et aut.' nullable: true events: type: array description: '' example: null items: type: string required: - url delete: summary: 'Delete an webhook' operationId: deleteAnWebhook description: "Deletes an webhook for the current company.\n" parameters: [] responses: 204: description: 'delete successful' content: text/plain: schema: type: string example: '' 404: description: 'webhook not found' content: application/json: schema: type: object example: message: 'webhook not found' properties: message: type: string example: 'webhook not found' tags: - Webhooks parameters: - in: path name: webhook_id description: 'The ID of the webhook.' example: 9fe86d12-5782-4ea7-ac8b-7324884f002b required: true schema: type: string '/v1/webhooks/{webhook_id}/rotate-secret': post: summary: 'Rotate webhook secret' operationId: rotateWebhookSecret description: "Rotates the secret for the webhook.\n" parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 9fe86d12-6acb-4715-ae43-91e2067d8d2a company_id: 7639e2cb-1e6c-4204-bd22-1b01bc77a155 url: 'https://marks.com' description: null events: [] secret: f520db49ef42f942fc8e7ec1d448f95abf7bd2e27471b607979df526067064da last_sent_at: null created_at: '2025-09-18T14:35:11.000000Z' updated_at: '2025-09-18T14:35:11.000000Z' properties: data: type: object properties: id: type: string example: 9fe86d12-6acb-4715-ae43-91e2067d8d2a company_id: type: string example: 7639e2cb-1e6c-4204-bd22-1b01bc77a155 url: type: string example: 'https://marks.com' description: type: string example: null events: type: array example: [] secret: type: string example: f520db49ef42f942fc8e7ec1d448f95abf7bd2e27471b607979df526067064da last_sent_at: type: string example: null created_at: type: string example: '2025-09-18T14:35:11.000000Z' updated_at: type: string example: '2025-09-18T14:35:11.000000Z' 404: description: 'webhook not found' content: application/json: schema: type: object example: message: 'webhook not found' properties: message: type: string example: 'webhook not found' tags: - Webhooks parameters: - in: path name: webhook_id description: 'The ID of the webhook.' example: 9fe86d12-5782-4ea7-ac8b-7324884f002b required: true schema: type: string '/v1/webhooks/{webhook_id}/test': post: summary: 'Test a webhook' operationId: testAWebhook description: "Tests the webhook by sending a test event.\n" parameters: [] responses: 204: description: 'dispatched test event' content: text/plain: schema: type: string example: '' 404: description: 'webhook not found' content: application/json: schema: type: object example: message: 'webhook not found' properties: message: type: string example: 'webhook not found' tags: - Webhooks parameters: - in: path name: webhook_id description: 'The ID of the webhook.' example: 9fe86d12-5782-4ea7-ac8b-7324884f002b required: true schema: type: string