openapi: 3.0.3 info: title: 'SecurityHive API Documentation' description: '' version: 1.0.0 servers: - url: 'https://api.securityhive.io' 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: 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 - 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: 9d7080f9-da58-446c-9fba-28f7ea4f7d4f cpe: 'cpe:2.3:a:ibm:websphere:*:*:*:*:*:*:*:*' vendor: IBM product: WebSphere version: 6.74.7832 update: patch1 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-dc92-47ff-b5e6-209b15ec6316 cpe: 'cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*' vendor: Mozilla product: Bugzilla version: 2.92.9991 update: hotfix1 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f9-da58-446c-9fba-28f7ea4f7d4f cpe: 'cpe:2.3:a:ibm:websphere:*:*:*:*:*:*:*:*' vendor: IBM product: WebSphere version: 6.74.7832 update: patch1 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-dc92-47ff-b5e6-209b15ec6316 cpe: 'cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*' vendor: Mozilla product: Bugzilla version: 2.92.9991 update: hotfix1 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' items: type: object properties: id: type: string example: 9d7080f9-da58-446c-9fba-28f7ea4f7d4f cpe: type: string example: 'cpe:2.3:a:ibm:websphere:*:*:*:*:*:*:*:*' vendor: type: string example: IBM product: type: string example: WebSphere version: type: string example: 6.74.7832 update: type: string example: patch1 created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: cpe required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor' description: '' example: cpe 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: 9d7080f9-e36d-401c-aa45-d925f9060ef6 cpe: 'cpe:2.3:a:google:cloud_platform:*:*:*:*:*:*:*:*' vendor: Google product: 'Cloud Platform' version: 16.12.2277 update: '' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f9-e36d-401c-aa45-d925f9060ef6 cpe: type: string example: 'cpe:2.3:a:google:cloud_platform:*:*:*:*:*:*:*:*' vendor: type: string example: Google product: type: string example: 'Cloud Platform' version: type: string example: 16.12.2277 update: type: string example: '' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' tags: - Applications parameters: - in: path name: id description: 'The ID of the application.' example: quis 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: sort description: '' example: last_seen required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: last_seen nullable: false enum: - name - host - last_seen - in: query name: include description: '' example: scans required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: scans nullable: false enum: - certificates - applications - tags - scans responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9d7080f9-6303-48da-997f-49fad3df250c company_id: '15' name: 'Neal Lehner' identifier: '4F:0E:E4:93:50:F7' host: 246.60.17.3 mac_address: '4F:0E:E4:93:50:F7' hostname: emmerich.com operating_system: reprehenderit operating_system_name: ea first_seen: '2023-05-16T16:48:17.000000Z' last_seen: '1978-09-22T03:33:31.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] - id: 9d7080f9-659e-46cf-82fd-8fa97b3d3ab5 company_id: '16' name: 'Chandler Fisher' identifier: 'CF:84:E4:D8:41:B5' host: 198.232.36.67 mac_address: 'CF:84:E4:D8:41:B5' hostname: hermiston.com operating_system: ut operating_system_name: sapiente first_seen: '2002-05-28T04:26:36.000000Z' last_seen: '2011-09-11T14:44:10.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] 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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f9-6303-48da-997f-49fad3df250c company_id: '15' name: 'Neal Lehner' identifier: '4F:0E:E4:93:50:F7' host: 246.60.17.3 mac_address: '4F:0E:E4:93:50:F7' hostname: emmerich.com operating_system: reprehenderit operating_system_name: ea first_seen: '2023-05-16T16:48:17.000000Z' last_seen: '1978-09-22T03:33:31.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] - id: 9d7080f9-659e-46cf-82fd-8fa97b3d3ab5 company_id: '16' name: 'Chandler Fisher' identifier: 'CF:84:E4:D8:41:B5' host: 198.232.36.67 mac_address: 'CF:84:E4:D8:41:B5' hostname: hermiston.com operating_system: ut operating_system_name: sapiente first_seen: '2002-05-28T04:26:36.000000Z' last_seen: '2011-09-11T14:44:10.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] items: type: object properties: id: type: string example: 9d7080f9-6303-48da-997f-49fad3df250c company_id: type: string example: '15' name: type: string example: 'Neal Lehner' identifier: type: string example: '4F:0E:E4:93:50:F7' host: type: string example: 246.60.17.3 mac_address: type: string example: '4F:0E:E4:93:50:F7' hostname: type: string example: emmerich.com operating_system: type: string example: reprehenderit operating_system_name: type: string example: ea first_seen: type: string example: '2023-05-16T16:48:17.000000Z' last_seen: type: string example: '1978-09-22T03:33:31.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: - '' items: type: string ssh_key: type: string example: null average_scan_duration: type: integer example: 0 scans: type: array example: [] 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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: 9d7080f9-6f34-4d9d-a3fc-0151cb50bb87 company_id: '17' name: 'Mr. Blaze Bergstrom' identifier: 'B5:EC:6B:B1:0C:B4' host: 128.90.15.56 mac_address: 'B5:EC:6B:B1:0C:B4' hostname: powlowski.biz operating_system: quaerat operating_system_name: quia first_seen: '1971-12-09T11:43:43.000000Z' last_seen: '1993-08-02T19:50:41.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] properties: data: type: object properties: id: type: string example: 9d7080f9-6f34-4d9d-a3fc-0151cb50bb87 company_id: type: string example: '17' name: type: string example: 'Mr. Blaze Bergstrom' identifier: type: string example: 'B5:EC:6B:B1:0C:B4' host: type: string example: 128.90.15.56 mac_address: type: string example: 'B5:EC:6B:B1:0C:B4' hostname: type: string example: powlowski.biz operating_system: type: string example: quaerat operating_system_name: type: string example: quia first_seen: type: string example: '1971-12-09T11:43:43.000000Z' last_seen: type: string example: '1993-08-02T19:50:41.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: - '' items: type: string ssh_key: type: string example: null average_scan_duration: type: integer example: 0 scans: type: array example: [] 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: aboahxeok nullable: false host: type: string description: 'A valid IPv4 or IPv6 address. Must be unique' example: placeat nullable: false required: - name - host /v1/assets/export: get: summary: 'Export assets.' operationId: exportAssets description: " Export all assets for the current company in CSV or XLSX format.\n " parameters: - in: query name: type description: '' example: xlsx required: true schema: type: 'The type of export to generate' description: '' example: xlsx nullable: false enum: - csv - xlsx - 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 with these tags.' description: '' example: 'New,Old' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Assets /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' tags: - Assets requestBody: required: false content: application/json: schema: type: object properties: data: type: array description: '' example: - [] items: type: object properties: action: type: string description: '' example: addTags nullable: false enum: - addTags - removeTags - delete id: type: string description: '' example: molestias nullable: false data: type: object description: '' example: [] nullable: false properties: tags: type: object description: '' example: [] nullable: false properties: { } required: - action - id '/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: scans required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: scans nullable: false enum: - certificates - applications - tags - scans responses: 200: description: 'Successfully retrieved asset' content: application/json: schema: type: object example: data: id: 9d7080f9-7456-49bc-b1b2-df44c1dc68ba company_id: '18' name: 'Ms. Daphne Yost MD' identifier: 'F7:64:7E:BE:6E:FD' host: 65.120.10.18 mac_address: 'F7:64:7E:BE:6E:FD' hostname: murray.com operating_system: voluptate operating_system_name: dolores first_seen: '1985-07-05T06:15:11.000000Z' last_seen: '2000-03-10T20:56:49.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] properties: data: type: object properties: id: type: string example: 9d7080f9-7456-49bc-b1b2-df44c1dc68ba company_id: type: string example: '18' name: type: string example: 'Ms. Daphne Yost MD' identifier: type: string example: 'F7:64:7E:BE:6E:FD' host: type: string example: 65.120.10.18 mac_address: type: string example: 'F7:64:7E:BE:6E:FD' hostname: type: string example: murray.com operating_system: type: string example: voluptate operating_system_name: type: string example: dolores first_seen: type: string example: '1985-07-05T06:15:11.000000Z' last_seen: type: string example: '2000-03-10T20:56:49.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: - '' items: type: string ssh_key: type: string example: null average_scan_duration: type: integer example: 0 scans: type: array example: [] 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: 9d7080f9-7bd2-4220-b5ed-af86681ac224 company_id: '19' name: 'Aliyah Rempel' identifier: 'B9:54:25:26:12:C6' host: 160.181.228.185 mac_address: 'B9:54:25:26:12:C6' hostname: schroeder.com operating_system: nisi operating_system_name: quia first_seen: '1986-07-22T18:02:35.000000Z' last_seen: '2024-01-07T22:33:21.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] properties: data: type: object properties: id: type: string example: 9d7080f9-7bd2-4220-b5ed-af86681ac224 company_id: type: string example: '19' name: type: string example: 'Aliyah Rempel' identifier: type: string example: 'B9:54:25:26:12:C6' host: type: string example: 160.181.228.185 mac_address: type: string example: 'B9:54:25:26:12:C6' hostname: type: string example: schroeder.com operating_system: type: string example: nisi operating_system_name: type: string example: quia first_seen: type: string example: '1986-07-22T18:02:35.000000Z' last_seen: type: string example: '2024-01-07T22:33:21.000000Z' open_tcp_ports: type: string example: '80,443' open_udp_ports: type: string example: '53,123' traceroute: type: array example: - '' items: type: string ssh_key: type: string example: null average_scan_duration: type: integer example: 0 scans: type: array example: [] 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: eddgmtuwxuwjgpc nullable: false required: - name delete: summary: 'Delete asset.' operationId: deleteAsset description: "Will delete an existing asset \n " parameters: [] responses: 204: description: 'asset deleted successfully' tags: - Assets parameters: - in: path name: id description: 'The ID of the asset.' example: voluptatem 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: tags required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: tags nullable: false enum: - certificates - applications - tags - scans responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9d7080f9-9777-4f89-b1b2-72b724a18f0d company_id: '20' common_name: damore.org organization: 'Bruen Group' organizational_unit: Group locality: 'Port Darrylview' state: Iowa country: FK serial: YTT9GQOIPF613XLJJ81ZNPBKUKPGSGAI not_valid_before: 20240722T062738Z not_valid_after: 20250406T051042Z value: "-----BEGIN CERTIFICATE-----\nPestVSQOZ2Z9kjJBmIvlHYP6clbCJ2YMqBI+Vf4P5doHfd3FgPFZLX2HWgOSkA+2\n3VyuqExpcwnE1qKwoztey6xs7A1RhP+pKHr3ZjTjnJ59kFUluT844pdj2d3vKMYB\nKDnIqLCUN8tQFk+wIca5yI0gH3nimIRbb3h2pZbc7EsI9IN+Csv8mL7e/wf2H4sv\ngySePiFUM1or/Xf/bn63+i4/1lAYyrBdwfdfqLDPUr5Xl8iyLYWy0nPD2499Q6GG\nXQXDpC4rC5Kn2xBYbK0jBzVMQ3qiFPCrCdUW5flawRv1RIswxELz8Ali4SKZoFGC\naAjmu7i9TT4hzqekjRoPUffHjjtj91WxxnT5mDB5tdo7/XgbT7Eqr8pMivX1RP/a\n+N4GW89hmavI17Fy9mH97KaXhmAyPpoJUa4uvPRpr2w3V1P1G1h9Wd8bN88jE6p5\nhOrs4snHw+Y2ugP5mZEnWmh4vU2lUV6zBqYDHH10UYEqbqZCqqDbV+S360woIKvi\n6V4QQW3JXPbkmY/UygKmRoN/HuIwkphYhfh30C5rHesZLtiLY+qOle3N4Uw8IUIw\nJ+F6Sul7Q6wr6iFQSJZCW48pjaRbbx8+qthaP4yUbFFIbsz43MgbyDlYt0AdldFZ\nOmFGXjXpVhaUnaRpSDDoSBK0puz1hWryO3TpF8JuVKieE+ndeRRIelurTeIB1Nan\nooAKknY0uW+WI+rK9AEhNvtUGd10x8TLqDuwvEBqVJJXoS7LZtfSa73Wd1QQeit1\n3P6/HXk4ORfMoi1tY0OPiee33Sf+h7ENN91XxWXN61kE7wKxdyhX/TAlCF+/ajdz\nHrWDzJrwF9UX7wJQ/rq986jF+MvB1+sxFu8ERpyUWlH0A3FJW70DPOsQTXIOpcMK\nvM8pknyCrnUjvbFvgxzOQfA30xgAi6k5qEn9PVt9h9B7iypfheMtSygWsWFZbwzY\nkDKiAl1iw1g0CIBpdzjYOShBflpZa2EEMMcT/SHYW6nBlyqQqDi5g28UoJQxGwYx\nI+jtTZAEAfpVTyb/fqkbvaa6FDTbn0mxsYWimOSNACwh/Unb+vtuiMNVogGpE1F8\nGnh1ai6JxEIMM9cbQGx/9ry0NaEC4mIOkAbOa82aN7a2m9eTAj+MvTEymJyPYh1d\nCKEocHEUPFf/RfHM3nkuhpWJ5S4GFu0M7fhdVDkJqnJ3AKw5oIS5UQyaSqNnN5HL\nODUffj1LOOh+wQLMO0QHhkxn6a1nuB77SjmeBT4oqqeYKcgFsDNj/ZV4Z7oXy6LU\n6O8RwhypnQss3FJk4gCizRXh+hCWBEYYap4NLC0gHp/XKTM/kM3uRH8Oi4m8dXm0\n6b3Roii3RbVH3kZ59LEQXQ==\n\n-----END CERTIFICATE-----" first_seen: '2024-07-25T03:29:22.000000Z' last_seen: '2024-08-08T07:25:26.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-9b93-4beb-aa18-0d310f16939f company_id: '21' common_name: hagenes.com organization: 'Fay, Kuphal and Weber' organizational_unit: null locality: 'New Mozellfurt' state: null country: BH serial: 01QKNX8XD1SHEXFBQYRRX5B4GQVREJNX not_valid_before: 20230119T200411Z not_valid_after: 20250903T190154Z value: "-----BEGIN CERTIFICATE-----\nxZD8vzbpQbLi5s6y/x110gpDNA4JucePEmgpjTFPJcMUj3Q7Gq8aEqC7FfB5HEDd\n0Vs8Zt0M3O5kFYwO21qMCQ+bG8Fge9hKpNqkPY0Hm0A7hIXa3gG7JqmdhyWJbhUs\nNLbIy8/up8/MZjWLgL2rw5WMQBTDTbd4E6VorpXfhi5QfCdcUcjnY32EVXd3D6Es\nftxHDjSA+d+0tqUx3PiBrmXMLcoOw8hJ3IHZSkxHQy2CCrvBkH8pjgBdvqol5fyq\n5yR7dUaGYxoBHl29cYkxpVayizXZO0fGt0EN0uR/re8pl52eS1kKtIiujYsgdt/r\njC6odHQ+dfxyf4V2IMk6NM5aKDFwpZTrvNy8hlnoUbvAnEcEZs7b3LtRCPWWAsjS\n+Mj/0ooAq097nG1Y9ZBkYbJdEfxoryZol/yejsaxgYvDsKGT+ZFg3ijKn3j123u+\nZeBuvDmTlR3wJobg5o3rrZpZjbllFMWNsNn1bpxoTh+/jbWQhBnzudrAtvZfpmH+\nX2Htk0CRC/xbW76x+TesTHPt97vtuoSDPkwTP7lZak8Yze2Oewx2O3Nn78J9JrYN\nH1/mJkJBgsn72hgtRGWRUtiyGJBXx3RcyUZb1sKalVg9O2jXCtX1CQdn4RFqctvY\nywWjOwInY9xDGj2DkOTbuXw84Y/sNccqo70+O4sTMtPkwwKA8/dtsRdGDi1AKlpo\nBMXnz4lL+T0egiR8kZZdOKaZBJA50CNvjGlNAEQ3evnBxGZaRdxe8EF4690gKbzP\nOb9cmYsVFI/Ye3evhHsBtoPmjYNHmayqef8lRt5lo8Ps4x+vTLx8tIOQlYdI1T5U\nopE6nV5XARBlURLTxPZZh+LiXh2FUddrnXLKpAwPpOTfV0aftF2ERbijt9VClpvp\nmF3c19vd6zmPAcWJift+xIHx9dAssgLbl9WUTwvPROvQxXfXJxut43M1PS5dmc3v\n8Aw8hjruevIP0hF/ztK+AFfuxh8GtHjalhKBs4cNUzhvH09YUd2Jngz/4ClTJRGq\ntD7yOhFVi25ed5dKoDqkfM0NnQbUTAvv80bBq534qgnFSSDZiKkpy9aPcjjAYpxu\nogn00Nj0N40tFkOu2CMS9dLDoqZScGSWKZHb+ASU4EmJjMkTa9bLVPcXGvxHytLp\nW96HIIRhJXLiu6wOy80xG/0+mglvUTEzio3GKmCSM3pF67/WnokUXd5/KrGe78tG\nPMKMns5E/i2LB4qYMdA0bt+IokFlZrcg3iGfMs+WZxSvHzDcItomgzh/kR4z2zUn\n4wdzHP5XVDjBmcQCgDExyyb7ccAX4ysWC8C8P1qmnp5Eqe8oZ/MByVigkZEvZSZZ\nKUE53EXYWs+rj3NBrAcEag==\n\n-----END CERTIFICATE-----" first_seen: '2023-08-05T18:52:26.000000Z' last_seen: '2024-08-29T13:03:26.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f9-9777-4f89-b1b2-72b724a18f0d company_id: '20' common_name: damore.org organization: 'Bruen Group' organizational_unit: Group locality: 'Port Darrylview' state: Iowa country: FK serial: YTT9GQOIPF613XLJJ81ZNPBKUKPGSGAI not_valid_before: 20240722T062738Z not_valid_after: 20250406T051042Z value: "-----BEGIN CERTIFICATE-----\nPestVSQOZ2Z9kjJBmIvlHYP6clbCJ2YMqBI+Vf4P5doHfd3FgPFZLX2HWgOSkA+2\n3VyuqExpcwnE1qKwoztey6xs7A1RhP+pKHr3ZjTjnJ59kFUluT844pdj2d3vKMYB\nKDnIqLCUN8tQFk+wIca5yI0gH3nimIRbb3h2pZbc7EsI9IN+Csv8mL7e/wf2H4sv\ngySePiFUM1or/Xf/bn63+i4/1lAYyrBdwfdfqLDPUr5Xl8iyLYWy0nPD2499Q6GG\nXQXDpC4rC5Kn2xBYbK0jBzVMQ3qiFPCrCdUW5flawRv1RIswxELz8Ali4SKZoFGC\naAjmu7i9TT4hzqekjRoPUffHjjtj91WxxnT5mDB5tdo7/XgbT7Eqr8pMivX1RP/a\n+N4GW89hmavI17Fy9mH97KaXhmAyPpoJUa4uvPRpr2w3V1P1G1h9Wd8bN88jE6p5\nhOrs4snHw+Y2ugP5mZEnWmh4vU2lUV6zBqYDHH10UYEqbqZCqqDbV+S360woIKvi\n6V4QQW3JXPbkmY/UygKmRoN/HuIwkphYhfh30C5rHesZLtiLY+qOle3N4Uw8IUIw\nJ+F6Sul7Q6wr6iFQSJZCW48pjaRbbx8+qthaP4yUbFFIbsz43MgbyDlYt0AdldFZ\nOmFGXjXpVhaUnaRpSDDoSBK0puz1hWryO3TpF8JuVKieE+ndeRRIelurTeIB1Nan\nooAKknY0uW+WI+rK9AEhNvtUGd10x8TLqDuwvEBqVJJXoS7LZtfSa73Wd1QQeit1\n3P6/HXk4ORfMoi1tY0OPiee33Sf+h7ENN91XxWXN61kE7wKxdyhX/TAlCF+/ajdz\nHrWDzJrwF9UX7wJQ/rq986jF+MvB1+sxFu8ERpyUWlH0A3FJW70DPOsQTXIOpcMK\nvM8pknyCrnUjvbFvgxzOQfA30xgAi6k5qEn9PVt9h9B7iypfheMtSygWsWFZbwzY\nkDKiAl1iw1g0CIBpdzjYOShBflpZa2EEMMcT/SHYW6nBlyqQqDi5g28UoJQxGwYx\nI+jtTZAEAfpVTyb/fqkbvaa6FDTbn0mxsYWimOSNACwh/Unb+vtuiMNVogGpE1F8\nGnh1ai6JxEIMM9cbQGx/9ry0NaEC4mIOkAbOa82aN7a2m9eTAj+MvTEymJyPYh1d\nCKEocHEUPFf/RfHM3nkuhpWJ5S4GFu0M7fhdVDkJqnJ3AKw5oIS5UQyaSqNnN5HL\nODUffj1LOOh+wQLMO0QHhkxn6a1nuB77SjmeBT4oqqeYKcgFsDNj/ZV4Z7oXy6LU\n6O8RwhypnQss3FJk4gCizRXh+hCWBEYYap4NLC0gHp/XKTM/kM3uRH8Oi4m8dXm0\n6b3Roii3RbVH3kZ59LEQXQ==\n\n-----END CERTIFICATE-----" first_seen: '2024-07-25T03:29:22.000000Z' last_seen: '2024-08-08T07:25:26.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-9b93-4beb-aa18-0d310f16939f company_id: '21' common_name: hagenes.com organization: 'Fay, Kuphal and Weber' organizational_unit: null locality: 'New Mozellfurt' state: null country: BH serial: 01QKNX8XD1SHEXFBQYRRX5B4GQVREJNX not_valid_before: 20230119T200411Z not_valid_after: 20250903T190154Z value: "-----BEGIN CERTIFICATE-----\nxZD8vzbpQbLi5s6y/x110gpDNA4JucePEmgpjTFPJcMUj3Q7Gq8aEqC7FfB5HEDd\n0Vs8Zt0M3O5kFYwO21qMCQ+bG8Fge9hKpNqkPY0Hm0A7hIXa3gG7JqmdhyWJbhUs\nNLbIy8/up8/MZjWLgL2rw5WMQBTDTbd4E6VorpXfhi5QfCdcUcjnY32EVXd3D6Es\nftxHDjSA+d+0tqUx3PiBrmXMLcoOw8hJ3IHZSkxHQy2CCrvBkH8pjgBdvqol5fyq\n5yR7dUaGYxoBHl29cYkxpVayizXZO0fGt0EN0uR/re8pl52eS1kKtIiujYsgdt/r\njC6odHQ+dfxyf4V2IMk6NM5aKDFwpZTrvNy8hlnoUbvAnEcEZs7b3LtRCPWWAsjS\n+Mj/0ooAq097nG1Y9ZBkYbJdEfxoryZol/yejsaxgYvDsKGT+ZFg3ijKn3j123u+\nZeBuvDmTlR3wJobg5o3rrZpZjbllFMWNsNn1bpxoTh+/jbWQhBnzudrAtvZfpmH+\nX2Htk0CRC/xbW76x+TesTHPt97vtuoSDPkwTP7lZak8Yze2Oewx2O3Nn78J9JrYN\nH1/mJkJBgsn72hgtRGWRUtiyGJBXx3RcyUZb1sKalVg9O2jXCtX1CQdn4RFqctvY\nywWjOwInY9xDGj2DkOTbuXw84Y/sNccqo70+O4sTMtPkwwKA8/dtsRdGDi1AKlpo\nBMXnz4lL+T0egiR8kZZdOKaZBJA50CNvjGlNAEQ3evnBxGZaRdxe8EF4690gKbzP\nOb9cmYsVFI/Ye3evhHsBtoPmjYNHmayqef8lRt5lo8Ps4x+vTLx8tIOQlYdI1T5U\nopE6nV5XARBlURLTxPZZh+LiXh2FUddrnXLKpAwPpOTfV0aftF2ERbijt9VClpvp\nmF3c19vd6zmPAcWJift+xIHx9dAssgLbl9WUTwvPROvQxXfXJxut43M1PS5dmc3v\n8Aw8hjruevIP0hF/ztK+AFfuxh8GtHjalhKBs4cNUzhvH09YUd2Jngz/4ClTJRGq\ntD7yOhFVi25ed5dKoDqkfM0NnQbUTAvv80bBq534qgnFSSDZiKkpy9aPcjjAYpxu\nogn00Nj0N40tFkOu2CMS9dLDoqZScGSWKZHb+ASU4EmJjMkTa9bLVPcXGvxHytLp\nW96HIIRhJXLiu6wOy80xG/0+mglvUTEzio3GKmCSM3pF67/WnokUXd5/KrGe78tG\nPMKMns5E/i2LB4qYMdA0bt+IokFlZrcg3iGfMs+WZxSvHzDcItomgzh/kR4z2zUn\n4wdzHP5XVDjBmcQCgDExyyb7ccAX4ysWC8C8P1qmnp5Eqe8oZ/MByVigkZEvZSZZ\nKUE53EXYWs+rj3NBrAcEag==\n\n-----END CERTIFICATE-----" first_seen: '2023-08-05T18:52:26.000000Z' last_seen: '2024-08-29T13:03:26.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' items: type: object properties: id: type: string example: 9d7080f9-9777-4f89-b1b2-72b724a18f0d company_id: type: string example: '20' common_name: type: string example: damore.org organization: type: string example: 'Bruen Group' organizational_unit: type: string example: Group locality: type: string example: 'Port Darrylview' state: type: string example: Iowa country: type: string example: FK serial: type: string example: YTT9GQOIPF613XLJJ81ZNPBKUKPGSGAI not_valid_before: type: string example: 20240722T062738Z not_valid_after: type: string example: 20250406T051042Z value: type: string example: "-----BEGIN CERTIFICATE-----\nPestVSQOZ2Z9kjJBmIvlHYP6clbCJ2YMqBI+Vf4P5doHfd3FgPFZLX2HWgOSkA+2\n3VyuqExpcwnE1qKwoztey6xs7A1RhP+pKHr3ZjTjnJ59kFUluT844pdj2d3vKMYB\nKDnIqLCUN8tQFk+wIca5yI0gH3nimIRbb3h2pZbc7EsI9IN+Csv8mL7e/wf2H4sv\ngySePiFUM1or/Xf/bn63+i4/1lAYyrBdwfdfqLDPUr5Xl8iyLYWy0nPD2499Q6GG\nXQXDpC4rC5Kn2xBYbK0jBzVMQ3qiFPCrCdUW5flawRv1RIswxELz8Ali4SKZoFGC\naAjmu7i9TT4hzqekjRoPUffHjjtj91WxxnT5mDB5tdo7/XgbT7Eqr8pMivX1RP/a\n+N4GW89hmavI17Fy9mH97KaXhmAyPpoJUa4uvPRpr2w3V1P1G1h9Wd8bN88jE6p5\nhOrs4snHw+Y2ugP5mZEnWmh4vU2lUV6zBqYDHH10UYEqbqZCqqDbV+S360woIKvi\n6V4QQW3JXPbkmY/UygKmRoN/HuIwkphYhfh30C5rHesZLtiLY+qOle3N4Uw8IUIw\nJ+F6Sul7Q6wr6iFQSJZCW48pjaRbbx8+qthaP4yUbFFIbsz43MgbyDlYt0AdldFZ\nOmFGXjXpVhaUnaRpSDDoSBK0puz1hWryO3TpF8JuVKieE+ndeRRIelurTeIB1Nan\nooAKknY0uW+WI+rK9AEhNvtUGd10x8TLqDuwvEBqVJJXoS7LZtfSa73Wd1QQeit1\n3P6/HXk4ORfMoi1tY0OPiee33Sf+h7ENN91XxWXN61kE7wKxdyhX/TAlCF+/ajdz\nHrWDzJrwF9UX7wJQ/rq986jF+MvB1+sxFu8ERpyUWlH0A3FJW70DPOsQTXIOpcMK\nvM8pknyCrnUjvbFvgxzOQfA30xgAi6k5qEn9PVt9h9B7iypfheMtSygWsWFZbwzY\nkDKiAl1iw1g0CIBpdzjYOShBflpZa2EEMMcT/SHYW6nBlyqQqDi5g28UoJQxGwYx\nI+jtTZAEAfpVTyb/fqkbvaa6FDTbn0mxsYWimOSNACwh/Unb+vtuiMNVogGpE1F8\nGnh1ai6JxEIMM9cbQGx/9ry0NaEC4mIOkAbOa82aN7a2m9eTAj+MvTEymJyPYh1d\nCKEocHEUPFf/RfHM3nkuhpWJ5S4GFu0M7fhdVDkJqnJ3AKw5oIS5UQyaSqNnN5HL\nODUffj1LOOh+wQLMO0QHhkxn6a1nuB77SjmeBT4oqqeYKcgFsDNj/ZV4Z7oXy6LU\n6O8RwhypnQss3FJk4gCizRXh+hCWBEYYap4NLC0gHp/XKTM/kM3uRH8Oi4m8dXm0\n6b3Roii3RbVH3kZ59LEQXQ==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2024-07-25T03:29:22.000000Z' last_seen: type: string example: '2024-08-08T07:25:26.000000Z' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: xlsx required: true schema: type: 'The type of export to generate' description: '' example: xlsx 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: common_name required: false schema: type: 'The column(s) to filter by. Eg filter=common_name:test.nl' description: '' example: common_name 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: scans required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: scans nullable: false enum: - certificates - applications - tags - scans responses: 200: description: 'Successfully retrieved certificate' content: application/json: schema: type: object example: data: id: 9d7080f9-a75b-4b25-b3f7-50ac619a4e90 company_id: '22' common_name: conroy.biz organization: 'Simonis, Cremin and Kovacek' organizational_unit: Inc locality: Tillmanstad state: 'North Carolina' country: SL serial: KCOP0RFX9POXHAOCOAX1JAI6XEBAJPXE not_valid_before: 20230327T112300Z not_valid_after: 20260102T192505Z value: "-----BEGIN CERTIFICATE-----\nTMO07a8yunKU3WCY+yshPx2LsUuYguw0UpqEddpGo58lkOUuKu9FMTNodFJbM8Sg\nQM7cDuUgN2Qp2zJ2+W2EpJzvnA4qttdFnnludGrGZLn93cnyXg7IvtQ1qVfk8N0L\ncQJ33fSNQ9uJ3brnUu1Ol+yP0PE8x6/dFzTLmGsonl2AI8wOHulSJ5RrAeqrwI7A\n8/pn0OMoNaJdGzhgGJ0xyjeT1Myxc+S3jxsFC5ReMadExEidpT6XS2yIXcxECP7b\n4/vMY6pYGbG9SABx/T7mDqOUpCcP0X4IP/vls01tR0QIK+Ie6VBNEgHERk7HdrBh\naHcE7l6PTMR4BQ0JAeeIyNiAZeIZGdoi2e2EzPwpJF7a60Rij61uM9J3Eo1bV8Va\ncak+RpfOpi4684Av5w26bqK0kuLnEJtYK08PgsvWF0GDeMy/7vsXtbQNvxhjFf+S\n4yVJ+OGrA1ctYC54aR2j71DWGdkyxRJyoTfnioJqqGE2UuWKSvdLtCVzAfD2oapN\n5FfhwaZJ5wBRRaDcKoghxeLN01lTgafPQYdYemtbDh9mhN0sjqhnZZl1NmD/Rimg\n+pwDGW0kf0msF368k9jwcw1PqvfOYbSUqRKo71F3Q8fTdNoz8SeN4rcsvQJjXpHw\nwRB8p/IaUlv/2QEnl0hYJJIIzZJCnBFG3jvwWXmDfRJscaaVVfuF1XEWfCPGM8Dz\ncUQ1ymkEK+fA/80zfb+cjcwGvdaSvNVyX+G6O/f4j0GH42sfLu+cpUCNmMI/nVbT\n3fW4yrTyCHnbRtgeHR0u/7xaj39KquLLokmw9leVb+JWXXE6U12nv6Y/DTU36215\nWiE4LpXDXphQnx0A7DzLrFoML/Lk8Xpw5TVIG9d1wA4l/iXU6cGA1TbbzDSE/ssY\nP4ryxlSccDuZCVFVRulkiwnXbY0Mx2oIzUxHHrwvGov9JaE+uzvzVSI6Cs8YdNAY\nl0DmeKt+/FmSrJ7cRYVQnMt9CNBWzH559oGA8tpoZuaPuGpfm36MSBLrKEm1c6cD\nCu7MYMbshERdpLD8E1wSnhmgS8U5AfpOPYx3K6jnbnC4ROp+UshLS8cDU1nGvuQf\nX0tb1qVQ65knu7Ov5vCssShbjdHUv0wLgkaYYVFjtg3XZXwuRSf5ncAmncS5r3ac\nmFZHmdskmGFyAOh9zVkJY9C1tHVg3fsY0K0uDjjiOQdDuSSlw0aj4PMdpIOjS/FU\nxFmbImU9O6C/VssaMNVCLi7iC0VzogCdwVInFjU6agYSiDiu4Zl458rTaxDwr9Cp\nidz5iTXYfw5QUP9SkC3pI5A/xXPwbwqjIPyPBhl6MiwcFdjumMD0seuuHcT9hiX/\niwSxhx9wjR0q4xMu6VollA==\n\n-----END CERTIFICATE-----" first_seen: '2024-02-17T04:39:00.000000Z' last_seen: '2024-09-15T21:24:07.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f9-a75b-4b25-b3f7-50ac619a4e90 company_id: type: string example: '22' common_name: type: string example: conroy.biz organization: type: string example: 'Simonis, Cremin and Kovacek' organizational_unit: type: string example: Inc locality: type: string example: Tillmanstad state: type: string example: 'North Carolina' country: type: string example: SL serial: type: string example: KCOP0RFX9POXHAOCOAX1JAI6XEBAJPXE not_valid_before: type: string example: 20230327T112300Z not_valid_after: type: string example: 20260102T192505Z value: type: string example: "-----BEGIN CERTIFICATE-----\nTMO07a8yunKU3WCY+yshPx2LsUuYguw0UpqEddpGo58lkOUuKu9FMTNodFJbM8Sg\nQM7cDuUgN2Qp2zJ2+W2EpJzvnA4qttdFnnludGrGZLn93cnyXg7IvtQ1qVfk8N0L\ncQJ33fSNQ9uJ3brnUu1Ol+yP0PE8x6/dFzTLmGsonl2AI8wOHulSJ5RrAeqrwI7A\n8/pn0OMoNaJdGzhgGJ0xyjeT1Myxc+S3jxsFC5ReMadExEidpT6XS2yIXcxECP7b\n4/vMY6pYGbG9SABx/T7mDqOUpCcP0X4IP/vls01tR0QIK+Ie6VBNEgHERk7HdrBh\naHcE7l6PTMR4BQ0JAeeIyNiAZeIZGdoi2e2EzPwpJF7a60Rij61uM9J3Eo1bV8Va\ncak+RpfOpi4684Av5w26bqK0kuLnEJtYK08PgsvWF0GDeMy/7vsXtbQNvxhjFf+S\n4yVJ+OGrA1ctYC54aR2j71DWGdkyxRJyoTfnioJqqGE2UuWKSvdLtCVzAfD2oapN\n5FfhwaZJ5wBRRaDcKoghxeLN01lTgafPQYdYemtbDh9mhN0sjqhnZZl1NmD/Rimg\n+pwDGW0kf0msF368k9jwcw1PqvfOYbSUqRKo71F3Q8fTdNoz8SeN4rcsvQJjXpHw\nwRB8p/IaUlv/2QEnl0hYJJIIzZJCnBFG3jvwWXmDfRJscaaVVfuF1XEWfCPGM8Dz\ncUQ1ymkEK+fA/80zfb+cjcwGvdaSvNVyX+G6O/f4j0GH42sfLu+cpUCNmMI/nVbT\n3fW4yrTyCHnbRtgeHR0u/7xaj39KquLLokmw9leVb+JWXXE6U12nv6Y/DTU36215\nWiE4LpXDXphQnx0A7DzLrFoML/Lk8Xpw5TVIG9d1wA4l/iXU6cGA1TbbzDSE/ssY\nP4ryxlSccDuZCVFVRulkiwnXbY0Mx2oIzUxHHrwvGov9JaE+uzvzVSI6Cs8YdNAY\nl0DmeKt+/FmSrJ7cRYVQnMt9CNBWzH559oGA8tpoZuaPuGpfm36MSBLrKEm1c6cD\nCu7MYMbshERdpLD8E1wSnhmgS8U5AfpOPYx3K6jnbnC4ROp+UshLS8cDU1nGvuQf\nX0tb1qVQ65knu7Ov5vCssShbjdHUv0wLgkaYYVFjtg3XZXwuRSf5ncAmncS5r3ac\nmFZHmdskmGFyAOh9zVkJY9C1tHVg3fsY0K0uDjjiOQdDuSSlw0aj4PMdpIOjS/FU\nxFmbImU9O6C/VssaMNVCLi7iC0VzogCdwVInFjU6agYSiDiu4Zl458rTaxDwr9Cp\nidz5iTXYfw5QUP9SkC3pI5A/xXPwbwqjIPyPBhl6MiwcFdjumMD0seuuHcT9hiX/\niwSxhx9wjR0q4xMu6VollA==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2024-02-17T04:39:00.000000Z' last_seen: type: string example: '2024-09-15T21:24:07.000000Z' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' tags: - Certificates delete: summary: 'Delete certificate.' operationId: deleteCertificate description: " Will delete an existing certificate \n " parameters: [] responses: 204: description: 'certificate deleted successfully' tags: - Certificates parameters: - in: path name: id description: 'The ID of the certificate.' example: sunt 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: animi 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' 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.partner required: false schema: type: string description: 'Include additional relationships (comma separated).' example: managingCompany.partner 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: 4ac58aa0-dbe0-45b3-9c14-2433601436c4 company_id: '1' managing_company_id: '1' first_name: Cruz last_name: Predovic two_factor_enabled: false email: arturo.bruen@jones.info email_verified_at: '2024-11-08T11:27:35Z' phonenumber: '+1 (319) 394-4032' phonenumber_verified_at: '2024-11-08 11:27:35' report_interval: weekly manageable_companies: - id: '1' uuid: 26aa8dee-0410-4ca3-bcfb-25b805bcd77c name: 'Kuphal and Sons' count_detections: null role: name: norole title: 'No role assigned' abilities: [] need_to_configure_2fa: false created_at: '2024-11-08T11:27:35Z' updated_at: '2024-11-08T11:27:36Z' links: self: 'http://api.securityhive.io/v1/me' properties: data: type: object properties: id: type: string example: 4ac58aa0-dbe0-45b3-9c14-2433601436c4 company_id: type: string example: '1' managing_company_id: type: string example: '1' first_name: type: string example: Cruz last_name: type: string example: Predovic two_factor_enabled: type: boolean example: false email: type: string example: arturo.bruen@jones.info email_verified_at: type: string example: '2024-11-08T11:27:35Z' phonenumber: type: string example: '+1 (319) 394-4032' phonenumber_verified_at: type: string example: '2024-11-08 11:27:35' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '1' uuid: 26aa8dee-0410-4ca3-bcfb-25b805bcd77c name: 'Kuphal and Sons' count_detections: null items: type: object properties: id: type: string example: '1' uuid: type: string example: 26aa8dee-0410-4ca3-bcfb-25b805bcd77c name: type: string example: 'Kuphal and Sons' count_detections: type: string example: null 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 created_at: type: string example: '2024-11-08T11:27:35Z' updated_at: type: string example: '2024-11-08T11:27:36Z' 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' 403: description: 'incorrect password' content: application/json: schema: type: object example: message: 'The old password is incorrect.' properties: message: type: string example: 'The old password is incorrect.' 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: 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 old_password: type: string description: 'This field is required when password is present. Must not be greater than 255 characters.' example: kxqovrxigofjkpcelvkbdf nullable: false password: type: string description: 'This field is required when old_password is present. Must not be greater than 255 characters.' example: Z6D5S~8t^>+2~ 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 role: type: string description: 'Must be a valid role name.' example: admin nullable: false /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: libero required: false schema: type: 'Filter by tag name.' description: '' example: libero 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: created_at required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=business_impact' description: '' example: created_at 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: 9d7080f9-b3a8-4611-9608-9cdd9188c3d9 company_id: '23' name: non description: 'Neque officiis voluptas sint aperiam qui iste nulla. Sed excepturi nihil cupiditate dolorem omnis aut. Minima delectus vero eos repellendus natus quis.' business_impact: medium system_tag: true asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-b7d9-4960-9dcf-13a2c753505f company_id: '24' name: sint description: 'Ab officiis adipisci eos voluptates velit. Eos repellendus dolorem et praesentium aliquam illo. Veritatis vero quod dolorem voluptatibus illo qui fugiat. Quaerat ducimus fugiat quia qui quod.' business_impact: low system_tag: false asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f9-b3a8-4611-9608-9cdd9188c3d9 company_id: '23' name: non description: 'Neque officiis voluptas sint aperiam qui iste nulla. Sed excepturi nihil cupiditate dolorem omnis aut. Minima delectus vero eos repellendus natus quis.' business_impact: medium system_tag: true asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' - id: 9d7080f9-b7d9-4960-9dcf-13a2c753505f company_id: '24' name: sint description: 'Ab officiis adipisci eos voluptates velit. Eos repellendus dolorem et praesentium aliquam illo. Veritatis vero quod dolorem voluptatibus illo qui fugiat. Quaerat ducimus fugiat quia qui quod.' business_impact: low system_tag: false asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' items: type: object properties: id: type: string example: 9d7080f9-b3a8-4611-9608-9cdd9188c3d9 company_id: type: string example: '23' name: type: string example: non description: type: string example: 'Neque officiis voluptas sint aperiam qui iste nulla. Sed excepturi nihil cupiditate dolorem omnis aut. Minima delectus vero eos repellendus natus quis.' business_impact: type: string example: medium system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: 9d7080f9-c214-4b86-9c1b-3f7256c049bc company_id: '25' name: doloremque description: 'Officiis iure unde iste inventore et doloremque maxime ipsam. Ea sit qui alias. Ratione perspiciatis aut illo consectetur ducimus. Et enim itaque consectetur aliquam est fugit ut.' business_impact: low system_tag: false asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f9-c214-4b86-9c1b-3f7256c049bc company_id: type: string example: '25' name: type: string example: doloremque description: type: string example: 'Officiis iure unde iste inventore et doloremque maxime ipsam. Ea sit qui alias. Ratione perspiciatis aut illo consectetur ducimus. Et enim itaque consectetur aliquam est fugit ut.' business_impact: type: string example: low system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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: vifu nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Doloremque est quisquam architecto quasi enim.' nullable: false business_impact: type: string description: '' example: low 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: 9d7080f9-c8e5-40b8-a5ab-2b3c952aa8ea company_id: '26' name: corporis description: 'Ad et in nihil laboriosam. Ut qui aut quia repellendus. Occaecati ut laudantium quis expedita alias explicabo voluptas excepturi.' business_impact: high system_tag: false asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f9-c8e5-40b8-a5ab-2b3c952aa8ea company_id: type: string example: '26' name: type: string example: corporis description: type: string example: 'Ad et in nihil laboriosam. Ut qui aut quia repellendus. Occaecati ut laudantium quis expedita alias explicabo voluptas excepturi.' business_impact: type: string example: high system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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: 9d7080f9-d134-4a20-b2a4-a83c78b5e3d2 company_id: '27' name: ratione description: 'Earum in numquam est aliquid facere quos. Et blanditiis sint qui magni. Harum ullam vel non voluptatem dolorem.' business_impact: low system_tag: false asset_count: 0 created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f9-d134-4a20-b2a4-a83c78b5e3d2 company_id: type: string example: '27' name: type: string example: ratione description: type: string example: 'Earum in numquam est aliquid facere quos. Et blanditiis sint qui magni. Harum ullam vel non voluptatem dolorem.' business_impact: type: string example: low system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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: ryyp nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Voluptatem animi libero ratione enim.' nullable: false business_impact: type: string description: '' example: high 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' tags: - Tags parameters: - in: path name: id description: 'The ID of the tag.' example: aliquam 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: company.partner required: false schema: type: string description: 'Include additional relationships (comma separated).' example: company.partner 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: b98769c5-6cd4-4ea3-a50e-116422b7c326 company_id: '9' managing_company_id: '9' first_name: Elnora last_name: Klein two_factor_enabled: false email: earnest.graham@hotmail.com email_verified_at: '2024-11-08T11:27:36.000000Z' phonenumber: 351-638-1364 phonenumber_verified_at: '2024-11-08 11:27:36' report_interval: weekly manageable_companies: - id: '9' uuid: 164482f1-8c1a-4dd9-a828-3699d201109d name: 'Zulauf LLC' count_detections: null role: name: norole title: 'No role assigned' created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 4810500e-9855-433b-985d-f8a43e90c804 company_id: '10' managing_company_id: '10' first_name: Alexandro last_name: Block two_factor_enabled: false email: dickens.taurean@douglas.com email_verified_at: '2024-11-08T11:27:36.000000Z' phonenumber: 364-270-3050 phonenumber_verified_at: '2024-11-08 11:27:36' report_interval: weekly manageable_companies: - id: '10' uuid: bc94abb9-e750-445b-ba54-584c2d1db471 name: 'Ebert, Lueilwitz and Gerhold' count_detections: null role: name: norole title: 'No role assigned' created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: b98769c5-6cd4-4ea3-a50e-116422b7c326 company_id: '9' managing_company_id: '9' first_name: Elnora last_name: Klein two_factor_enabled: false email: earnest.graham@hotmail.com email_verified_at: '2024-11-08T11:27:36.000000Z' phonenumber: 351-638-1364 phonenumber_verified_at: '2024-11-08 11:27:36' report_interval: weekly manageable_companies: - id: '9' uuid: 164482f1-8c1a-4dd9-a828-3699d201109d name: 'Zulauf LLC' count_detections: null role: name: norole title: 'No role assigned' created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 4810500e-9855-433b-985d-f8a43e90c804 company_id: '10' managing_company_id: '10' first_name: Alexandro last_name: Block two_factor_enabled: false email: dickens.taurean@douglas.com email_verified_at: '2024-11-08T11:27:36.000000Z' phonenumber: 364-270-3050 phonenumber_verified_at: '2024-11-08 11:27:36' report_interval: weekly manageable_companies: - id: '10' uuid: bc94abb9-e750-445b-ba54-584c2d1db471 name: 'Ebert, Lueilwitz and Gerhold' count_detections: null role: name: norole title: 'No role assigned' created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' items: type: object properties: id: type: string example: b98769c5-6cd4-4ea3-a50e-116422b7c326 company_id: type: string example: '9' managing_company_id: type: string example: '9' first_name: type: string example: Elnora last_name: type: string example: Klein two_factor_enabled: type: boolean example: false email: type: string example: earnest.graham@hotmail.com email_verified_at: type: string example: '2024-11-08T11:27:36.000000Z' phonenumber: type: string example: 351-638-1364 phonenumber_verified_at: type: string example: '2024-11-08 11:27:36' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '9' uuid: 164482f1-8c1a-4dd9-a828-3699d201109d name: 'Zulauf LLC' count_detections: null items: type: object properties: id: type: string example: '9' uuid: type: string example: 164482f1-8c1a-4dd9-a828-3699d201109d name: type: string example: 'Zulauf LLC' count_detections: type: string example: null role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' created_at: type: string example: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: vvvvr nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: nlosvuacbm nullable: false email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: ygleichner@example.net nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true report_interval: type: string description: '' example: monthly 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: company.partner required: false schema: type: string description: 'Include additional relationships (comma separated).' example: company.partner 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: 31158228-79d8-40f3-ac09-7ec6b9f96470 company_id: '11' managing_company_id: '11' first_name: Ismael last_name: Steuber two_factor_enabled: false email: harold.kautzer@yahoo.com email_verified_at: '2024-11-08T11:27:36.000000Z' phonenumber: 563-546-2813 phonenumber_verified_at: '2024-11-08 11:27:36' report_interval: weekly manageable_companies: - id: '11' uuid: 59bbadef-cbba-49aa-b025-22bb151c23ce name: Kautzer-Christiansen count_detections: null role: name: norole title: 'No role assigned' created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' properties: data: type: object properties: id: type: string example: 31158228-79d8-40f3-ac09-7ec6b9f96470 company_id: type: string example: '11' managing_company_id: type: string example: '11' first_name: type: string example: Ismael last_name: type: string example: Steuber two_factor_enabled: type: boolean example: false email: type: string example: harold.kautzer@yahoo.com email_verified_at: type: string example: '2024-11-08T11:27:36.000000Z' phonenumber: type: string example: 563-546-2813 phonenumber_verified_at: type: string example: '2024-11-08 11:27:36' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '11' uuid: 59bbadef-cbba-49aa-b025-22bb151c23ce name: Kautzer-Christiansen count_detections: null items: type: object properties: id: type: string example: '11' uuid: type: string example: 59bbadef-cbba-49aa-b025-22bb151c23ce name: type: string example: Kautzer-Christiansen count_detections: type: string example: null role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' created_at: type: string example: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.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' 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' 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: 46301677-c3bf-3fd0-bf3d-ebedc5d6b9bb 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: Detected required: false schema: type: 'Filter vulnerabilities by their status' description: '' example: Detected nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired - in: query name: 'filter[threat]' description: '' example: Critical required: false schema: type: 'Filter vulnerabilities by their threat level' description: '' example: Critical 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: port required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: port nullable: false enum: - name - port - cvss_base_score - qod_type - last_seen responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9d7080f9-45db-4c6f-99a2-328ad9ea91b0 company_id: '12' vulnerability_definition_id: 9d7080f9-4538-4bd4-abd0-bff36d9b089f vulnerability_definition: id: 9d7080f9-4538-4bd4-abd0-bff36d9b089f name: 'Quasi expedita cumque et.' description: 'Est omnis minima pariatur est enim rerum numquam. Sit vero deleniti laborum voluptatem.' solution: 'Labore ex enim qui. Consequuntur dignissimos aliquam eos eveniet nam nostrum molestiae. Molestias est vel recusandae magni possimus est occaecati.' category: '2' threat_level: High definition_type: openvas definition: id: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: '0 due to improper rerum handling' family: '0' reference_urls: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: 'CVE-2022-2901, CVE-2018-3306' solution_type: 'Configuration Change' solution_description: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: Low qod_type: remote_active qod_value: 10 cvss_base_score: 2.4 cvss_base_vector: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' host: 189.67.31.29 hostname: nienow.com port: 80/tcp details: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' status: Detected first_seen: '2023-12-20T11:11:58.000000Z' last_seen: '2024-03-07T10:43:33.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' name: 'Quasi expedita cumque et.' description: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' cvss_base_score: 2.4 cvss_base_vector: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' qod_type: remote_active qod_value: 10 threat: High scanner_id: null scanner_hostname: null plugin: id: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: '0 due to improper rerum handling' family: '0' reference_urls: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: 'CVE-2022-2901, CVE-2018-3306' solution_type: 'Configuration Change' solution_description: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: Low qod_type: remote_active qod_value: 10 - id: 9d7080f9-49da-4e02-bdb6-2f7855b16a8f company_id: '13' vulnerability_definition_id: 9d7080f9-4957-47f2-839f-3258ac52ac63 vulnerability_definition: id: 9d7080f9-4957-47f2-839f-3258ac52ac63 name: 'Ea et ea sint.' description: 'Impedit est ad ea numquam quia ut. Itaque nobis beatae molestiae dolor. Hic consequuntur dolorem minima in iusto et quis quod.' solution: 'Veniam et culpa consequuntur ut deserunt. Aspernatur expedita delectus enim dolor et nisi.' category: '2' threat_level: Low definition_type: openvas definition: id: 9d7080f9-48ad-4541-a386-0289e84148c9 o_id: 038431f8-f3cb-3592-b530-95e2dbb8e0df name: '1 in similique' family: '1' reference_urls: 'http://www.volkman.com/ex-minima-ex-vero-assumenda-ipsa-tempore, https://www.sporer.com/placeat-modi-totam-nihil-natus-et-facilis-maxime' reference_cves: 'CVE-2018-8829, CVE-2020-3332' solution_type: WorkAround solution_description: 'Id est dignissimos quis. Sapiente dolor qui error qui debitis temporibus rem.' summary: 'Rerum voluptate ut eos aperiam voluptatem. Id inventore debitis qui neque rem dolore. Cupiditate consequatur alias et. Magnam possimus est dignissimos debitis ut aut.' insight: 'Ad vel fuga aspernatur ipsa et nihil pariatur. Aliquam harum sed illo perferendis aliquid. Ab placeat et qui et.' affected: 'Rerum non illum eligendi quia nam totam. Facilis id consequatur quos sunt et consequuntur voluptatem. Aut ea sint aut non deleniti sit. Sapiente asperiores quia dignissimos rem nihil veniam nihil. Qui neque est exercitationem soluta.' impact: 'Nisi illo ut sed expedita voluptatem. Rerum vel inventore quia quia ut. Illum asperiores laborum nulla voluptas quasi necessitatibus consequatur aut. Tenetur magni ex id dicta odit suscipit veritatis.' vuldetect: 'Repellendus maiores ut ex dolorem ipsa dolor sit. Voluptas earum quasi voluptas fugit ullam voluptas. Suscipit aliquid dolorum dolorem asperiores qui quisquam consequatur. Repellat voluptas aut consequatur et assumenda dicta.' priority: Log qod_type: remote_active qod_value: 80 cvss_base_score: 1.3 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' host: 39.66.216.6 hostname: ullrich.com port: 56947/tcp details: 'Non illum omnis iure aut qui ipsa. Dolor corrupti suscipit sit vitae doloremque perferendis eius.' status: Accepted first_seen: '2024-02-28T19:36:08.000000Z' last_seen: '2024-03-08T12:36:10.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' name: 'Ea et ea sint.' description: 'Non illum omnis iure aut qui ipsa. Dolor corrupti suscipit sit vitae doloremque perferendis eius.' cvss_base_score: 1.3 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' qod_type: remote_active qod_value: 80 threat: Low scanner_id: null scanner_hostname: null plugin: id: 9d7080f9-48ad-4541-a386-0289e84148c9 o_id: 038431f8-f3cb-3592-b530-95e2dbb8e0df name: '1 in similique' family: '1' reference_urls: 'http://www.volkman.com/ex-minima-ex-vero-assumenda-ipsa-tempore, https://www.sporer.com/placeat-modi-totam-nihil-natus-et-facilis-maxime' reference_cves: 'CVE-2018-8829, CVE-2020-3332' solution_type: WorkAround solution_description: 'Id est dignissimos quis. Sapiente dolor qui error qui debitis temporibus rem.' summary: 'Rerum voluptate ut eos aperiam voluptatem. Id inventore debitis qui neque rem dolore. Cupiditate consequatur alias et. Magnam possimus est dignissimos debitis ut aut.' insight: 'Ad vel fuga aspernatur ipsa et nihil pariatur. Aliquam harum sed illo perferendis aliquid. Ab placeat et qui et.' affected: 'Rerum non illum eligendi quia nam totam. Facilis id consequatur quos sunt et consequuntur voluptatem. Aut ea sint aut non deleniti sit. Sapiente asperiores quia dignissimos rem nihil veniam nihil. Qui neque est exercitationem soluta.' impact: 'Nisi illo ut sed expedita voluptatem. Rerum vel inventore quia quia ut. Illum asperiores laborum nulla voluptas quasi necessitatibus consequatur aut. Tenetur magni ex id dicta odit suscipit veritatis.' vuldetect: 'Repellendus maiores ut ex dolorem ipsa dolor sit. Voluptas earum quasi voluptas fugit ullam voluptas. Suscipit aliquid dolorum dolorem asperiores qui quisquam consequatur. Repellat voluptas aut consequatur et assumenda dicta.' priority: Log qod_type: remote_active qod_value: 80 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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f9-45db-4c6f-99a2-328ad9ea91b0 company_id: '12' vulnerability_definition_id: 9d7080f9-4538-4bd4-abd0-bff36d9b089f vulnerability_definition: id: 9d7080f9-4538-4bd4-abd0-bff36d9b089f name: 'Quasi expedita cumque et.' description: 'Est omnis minima pariatur est enim rerum numquam. Sit vero deleniti laborum voluptatem.' solution: 'Labore ex enim qui. Consequuntur dignissimos aliquam eos eveniet nam nostrum molestiae. Molestias est vel recusandae magni possimus est occaecati.' category: '2' threat_level: High definition_type: openvas definition: id: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: '0 due to improper rerum handling' family: '0' reference_urls: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: 'CVE-2022-2901, CVE-2018-3306' solution_type: 'Configuration Change' solution_description: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: Low qod_type: remote_active qod_value: 10 cvss_base_score: 2.4 cvss_base_vector: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' host: 189.67.31.29 hostname: nienow.com port: 80/tcp details: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' status: Detected first_seen: '2023-12-20T11:11:58.000000Z' last_seen: '2024-03-07T10:43:33.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' name: 'Quasi expedita cumque et.' description: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' cvss_base_score: 2.4 cvss_base_vector: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' qod_type: remote_active qod_value: 10 threat: High scanner_id: null scanner_hostname: null plugin: id: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: '0 due to improper rerum handling' family: '0' reference_urls: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: 'CVE-2022-2901, CVE-2018-3306' solution_type: 'Configuration Change' solution_description: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: Low qod_type: remote_active qod_value: 10 - id: 9d7080f9-49da-4e02-bdb6-2f7855b16a8f company_id: '13' vulnerability_definition_id: 9d7080f9-4957-47f2-839f-3258ac52ac63 vulnerability_definition: id: 9d7080f9-4957-47f2-839f-3258ac52ac63 name: 'Ea et ea sint.' description: 'Impedit est ad ea numquam quia ut. Itaque nobis beatae molestiae dolor. Hic consequuntur dolorem minima in iusto et quis quod.' solution: 'Veniam et culpa consequuntur ut deserunt. Aspernatur expedita delectus enim dolor et nisi.' category: '2' threat_level: Low definition_type: openvas definition: id: 9d7080f9-48ad-4541-a386-0289e84148c9 o_id: 038431f8-f3cb-3592-b530-95e2dbb8e0df name: '1 in similique' family: '1' reference_urls: 'http://www.volkman.com/ex-minima-ex-vero-assumenda-ipsa-tempore, https://www.sporer.com/placeat-modi-totam-nihil-natus-et-facilis-maxime' reference_cves: 'CVE-2018-8829, CVE-2020-3332' solution_type: WorkAround solution_description: 'Id est dignissimos quis. Sapiente dolor qui error qui debitis temporibus rem.' summary: 'Rerum voluptate ut eos aperiam voluptatem. Id inventore debitis qui neque rem dolore. Cupiditate consequatur alias et. Magnam possimus est dignissimos debitis ut aut.' insight: 'Ad vel fuga aspernatur ipsa et nihil pariatur. Aliquam harum sed illo perferendis aliquid. Ab placeat et qui et.' affected: 'Rerum non illum eligendi quia nam totam. Facilis id consequatur quos sunt et consequuntur voluptatem. Aut ea sint aut non deleniti sit. Sapiente asperiores quia dignissimos rem nihil veniam nihil. Qui neque est exercitationem soluta.' impact: 'Nisi illo ut sed expedita voluptatem. Rerum vel inventore quia quia ut. Illum asperiores laborum nulla voluptas quasi necessitatibus consequatur aut. Tenetur magni ex id dicta odit suscipit veritatis.' vuldetect: 'Repellendus maiores ut ex dolorem ipsa dolor sit. Voluptas earum quasi voluptas fugit ullam voluptas. Suscipit aliquid dolorum dolorem asperiores qui quisquam consequatur. Repellat voluptas aut consequatur et assumenda dicta.' priority: Log qod_type: remote_active qod_value: 80 cvss_base_score: 1.3 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' host: 39.66.216.6 hostname: ullrich.com port: 56947/tcp details: 'Non illum omnis iure aut qui ipsa. Dolor corrupti suscipit sit vitae doloremque perferendis eius.' status: Accepted first_seen: '2024-02-28T19:36:08.000000Z' last_seen: '2024-03-08T12:36:10.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' name: 'Ea et ea sint.' description: 'Non illum omnis iure aut qui ipsa. Dolor corrupti suscipit sit vitae doloremque perferendis eius.' cvss_base_score: 1.3 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' qod_type: remote_active qod_value: 80 threat: Low scanner_id: null scanner_hostname: null plugin: id: 9d7080f9-48ad-4541-a386-0289e84148c9 o_id: 038431f8-f3cb-3592-b530-95e2dbb8e0df name: '1 in similique' family: '1' reference_urls: 'http://www.volkman.com/ex-minima-ex-vero-assumenda-ipsa-tempore, https://www.sporer.com/placeat-modi-totam-nihil-natus-et-facilis-maxime' reference_cves: 'CVE-2018-8829, CVE-2020-3332' solution_type: WorkAround solution_description: 'Id est dignissimos quis. Sapiente dolor qui error qui debitis temporibus rem.' summary: 'Rerum voluptate ut eos aperiam voluptatem. Id inventore debitis qui neque rem dolore. Cupiditate consequatur alias et. Magnam possimus est dignissimos debitis ut aut.' insight: 'Ad vel fuga aspernatur ipsa et nihil pariatur. Aliquam harum sed illo perferendis aliquid. Ab placeat et qui et.' affected: 'Rerum non illum eligendi quia nam totam. Facilis id consequatur quos sunt et consequuntur voluptatem. Aut ea sint aut non deleniti sit. Sapiente asperiores quia dignissimos rem nihil veniam nihil. Qui neque est exercitationem soluta.' impact: 'Nisi illo ut sed expedita voluptatem. Rerum vel inventore quia quia ut. Illum asperiores laborum nulla voluptas quasi necessitatibus consequatur aut. Tenetur magni ex id dicta odit suscipit veritatis.' vuldetect: 'Repellendus maiores ut ex dolorem ipsa dolor sit. Voluptas earum quasi voluptas fugit ullam voluptas. Suscipit aliquid dolorum dolorem asperiores qui quisquam consequatur. Repellat voluptas aut consequatur et assumenda dicta.' priority: Log qod_type: remote_active qod_value: 80 items: type: object properties: id: type: string example: 9d7080f9-45db-4c6f-99a2-328ad9ea91b0 company_id: type: string example: '12' vulnerability_definition_id: type: string example: 9d7080f9-4538-4bd4-abd0-bff36d9b089f vulnerability_definition: type: object properties: id: type: string example: 9d7080f9-4538-4bd4-abd0-bff36d9b089f name: type: string example: 'Quasi expedita cumque et.' description: type: string example: 'Est omnis minima pariatur est enim rerum numquam. Sit vero deleniti laborum voluptatem.' solution: type: string example: 'Labore ex enim qui. Consequuntur dignissimos aliquam eos eveniet nam nostrum molestiae. Molestias est vel recusandae magni possimus est occaecati.' category: type: string example: '2' threat_level: type: string example: High definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: type: string example: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: type: string example: '0 due to improper rerum handling' family: type: string example: '0' reference_urls: type: string example: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: type: string example: 'CVE-2022-2901, CVE-2018-3306' solution_type: type: string example: 'Configuration Change' solution_description: type: string example: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: type: string example: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: type: string example: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: type: string example: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: type: string example: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: type: string example: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: type: string example: Low qod_type: type: string example: remote_active qod_value: type: integer example: 10 cvss_base_score: type: number example: 2.4 cvss_base_vector: type: string example: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' host: type: string example: 189.67.31.29 hostname: type: string example: nienow.com port: type: string example: 80/tcp details: type: string example: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' status: type: string example: Detected first_seen: type: string example: '2023-12-20T11:11:58.000000Z' last_seen: type: string example: '2024-03-07T10:43:33.000000Z' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' name: type: string example: 'Quasi expedita cumque et.' description: type: string example: 'Labore rerum voluptas quos. Vel quos velit quidem minus nobis. Voluptatem ut saepe a ex blanditiis aut totam. Ipsa sit totam tenetur quia enim in.' cvss_base_score: type: number example: 2.4 cvss_base_vector: type: string example: 'AV:L/AC:H/Au:M/C:P/I:P/A:C' qod_type: type: string example: remote_active qod_value: type: integer example: 10 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: 9d7080f9-4116-4e9f-bef5-c912ef611679 o_id: type: string example: 36386fd6-e1ac-3107-a88f-d9a63671be76 name: type: string example: '0 due to improper rerum handling' family: type: string example: '0' reference_urls: type: string example: 'http://www.roob.com/, https://kunze.info/nostrum-sapiente-aut-dolores-sequi.html' reference_cves: type: string example: 'CVE-2022-2901, CVE-2018-3306' solution_type: type: string example: 'Configuration Change' solution_description: type: string example: 'Necessitatibus a voluptas perferendis sed sed sunt amet. Occaecati corrupti dolor dolorum labore sit dolor. Maxime dolorum odit quia corporis quia in reiciendis.' summary: type: string example: 'Odit voluptatibus tempora et consequatur natus est. Quod perferendis sint corrupti quisquam sed voluptatem. Cum sit culpa aperiam amet.' insight: type: string example: 'Et quisquam totam et alias dignissimos veritatis. Blanditiis voluptas rerum expedita est cumque eaque. Assumenda nobis debitis est.' affected: type: string example: 'Id odio quidem ab eaque quam necessitatibus ratione. Tenetur dolorem nihil sed accusamus sed est. Ipsum nisi minus maiores.' impact: type: string example: 'Possimus voluptatem ex repellendus similique voluptates pariatur. Occaecati non aut aut iste quas recusandae dignissimos. Voluptatem nesciunt et sit minus quia ea tenetur. Voluptas qui omnis autem atque vitae dolore dolores.' vuldetect: type: string example: 'Molestiae voluptatum veniam nihil veniam. Eum illum itaque laboriosam ut est eum iste. In et voluptatum autem et. Adipisci delectus et quod itaque et quisquam.' priority: type: string example: Low qod_type: type: string example: remote_active qod_value: type: integer example: 10 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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: wrtqoeqydqncaimiwilylaj nullable: false threat_level: type: string description: '' example: Critical nullable: false enum: - Log - Low - Medium - High - Critical host: type: string description: 'Must not be greater than 255 characters.' example: qkyoxfls nullable: false hostname: type: string description: 'Must not be greater than 255 characters.' example: ogcpvxiwyrhuwk 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: 7d6be8f6-7ae9-39ff-a0f2-9be0f4913252 nullable: false per_page: type: integer description: 'Must be at least 1. Must not be greater than 200.' example: 19 nullable: false /v1/vulnerabilities/export: get: summary: 'Export vulnerabilities.' operationId: exportVulnerabilities description: " Export all vulnerabilities for the current company in CSV or XLSX format.\n " parameters: - in: query name: type description: '' example: xlsx required: true schema: type: 'The type of export to generate' description: '' example: xlsx nullable: false enum: - csv - xlsx - 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: Detected required: false schema: type: 'Filter vulnerabilities by their status' description: '' example: Detected nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired - in: query name: 'filter[threat]' description: '' example: Low required: false schema: type: 'Filter vulnerabilities by their threat level' description: '' example: Low 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: qod_type required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: qod_type nullable: false enum: - name - port - cvss_base_score - qod_type - last_seen responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Vulnerabilities requestBody: required: true 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: ncxnydhcttnb nullable: false threat_level: type: string description: '' example: Log nullable: false enum: - Log - Low - Medium - High - Critical host: type: string description: 'Must not be greater than 255 characters.' example: brh nullable: false hostname: type: string description: 'Must not be greater than 255 characters.' example: jqfh nullable: false status: type: string description: '' example: Resolved nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired scan_id: type: string description: 'Must be a valid UUID.' example: 762bef7e-c091-3033-a96b-d678c1450ecb nullable: false per_page: type: integer description: 'Must be at least 1. Must not be greater than 200.' example: 15 nullable: false type: type: string description: '' example: csv nullable: false enum: - csv - xlsx required: - type '/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: 9d7080f9-5840-4e61-a884-1d0f9216c9fc company_id: '14' vulnerability_definition_id: 9d7080f9-57cc-4596-afcd-5e21658b7f49 vulnerability_definition: id: 9d7080f9-57cc-4596-afcd-5e21658b7f49 name: 'Doloribus aut cumque accusamus.' description: 'Laboriosam quaerat animi iste aut non deleniti. At voluptatum sunt expedita et dolores.' solution: 'Iure sit atque quia quia. Consequuntur id consequuntur veniam alias. Porro tempora perferendis id omnis temporibus.' category: '4' threat_level: Medium definition_type: openvas definition: id: 9d7080f9-5743-4e8d-b0a2-0132d68e44fb o_id: 652351cb-9c81-3e1b-b1df-4fed6ce4c421 name: '9 via exercitationem input' family: '9' reference_urls: 'http://olson.org/delectus-saepe-id-consequatur-saepe-aliquam-omnis-reprehenderit, http://mills.com/voluptatum-ullam-a-rerum-omnis.html' reference_cves: 'CVE-2017-8188, CVE-2021-6202' solution_type: Mitigation solution_description: 'Nostrum reiciendis omnis similique. Nostrum rem voluptas aut reprehenderit. Corrupti molestiae qui ut qui. Enim ab quidem architecto sequi sint quaerat quo. In rerum veniam dolorem neque. Eum beatae tenetur molestias aut odit.' summary: 'Veniam voluptatum eaque molestiae aut totam mollitia inventore. Et voluptas impedit praesentium consequatur nulla quam. Maxime debitis deserunt fugit qui. Aut et et saepe. Et amet doloremque eaque voluptas quae ad. Non quia id aut.' insight: 'Eum perferendis nihil officiis illo quia voluptatem. Esse accusamus doloribus non nobis. Minima necessitatibus doloremque optio et voluptatum. Exercitationem ut omnis quia aut magnam error.' affected: 'Dolorem provident ea qui eum sapiente ut ea. Dolore provident sequi aut esse magni. Minus vel a eum laboriosam. Sunt accusamus error nesciunt magnam officia ex.' impact: 'Eius voluptatem aut est quibusdam incidunt qui. Repellat dolorum eveniet qui voluptas ut necessitatibus. Cupiditate fuga magni sit. Eos quos voluptatum sint harum sint omnis beatae nemo.' vuldetect: 'Quia explicabo perferendis sunt qui laudantium qui. Possimus mollitia necessitatibus aut eveniet voluptatem et et. Et corporis sunt blanditiis sed.' priority: Low qod_type: exploit qod_value: 30 cvss_base_score: 0.4 cvss_base_vector: 'AV:A/AC:L/Au:S/C:C/I:N/A:N' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' host: 189.239.236.152 hostname: stokes.net port: 1433/tcp details: 'Sequi tempore nihil dolores voluptatem eos labore dolorem. Quod doloribus quibusdam recusandae consequuntur. Officia explicabo possimus vel voluptatem quis ut id.' status: Detected first_seen: '2024-01-26T03:49:27.000000Z' last_seen: '2024-05-22T10:52:58.000000Z' created_at: '2024-11-08T11:27:37.000000Z' updated_at: '2024-11-08T11:27:37.000000Z' name: 'Doloribus aut cumque accusamus.' description: 'Sequi tempore nihil dolores voluptatem eos labore dolorem. Quod doloribus quibusdam recusandae consequuntur. Officia explicabo possimus vel voluptatem quis ut id.' cvss_base_score: 0.4 cvss_base_vector: 'AV:A/AC:L/Au:S/C:C/I:N/A:N' qod_type: exploit qod_value: 30 threat: Medium scanner_id: null scanner_hostname: null plugin: id: 9d7080f9-5743-4e8d-b0a2-0132d68e44fb o_id: 652351cb-9c81-3e1b-b1df-4fed6ce4c421 name: '9 via exercitationem input' family: '9' reference_urls: 'http://olson.org/delectus-saepe-id-consequatur-saepe-aliquam-omnis-reprehenderit, http://mills.com/voluptatum-ullam-a-rerum-omnis.html' reference_cves: 'CVE-2017-8188, CVE-2021-6202' solution_type: Mitigation solution_description: 'Nostrum reiciendis omnis similique. Nostrum rem voluptas aut reprehenderit. Corrupti molestiae qui ut qui. Enim ab quidem architecto sequi sint quaerat quo. In rerum veniam dolorem neque. Eum beatae tenetur molestias aut odit.' summary: 'Veniam voluptatum eaque molestiae aut totam mollitia inventore. Et voluptas impedit praesentium consequatur nulla quam. Maxime debitis deserunt fugit qui. Aut et et saepe. Et amet doloremque eaque voluptas quae ad. Non quia id aut.' insight: 'Eum perferendis nihil officiis illo quia voluptatem. Esse accusamus doloribus non nobis. Minima necessitatibus doloremque optio et voluptatum. Exercitationem ut omnis quia aut magnam error.' affected: 'Dolorem provident ea qui eum sapiente ut ea. Dolore provident sequi aut esse magni. Minus vel a eum laboriosam. Sunt accusamus error nesciunt magnam officia ex.' impact: 'Eius voluptatem aut est quibusdam incidunt qui. Repellat dolorum eveniet qui voluptas ut necessitatibus. Cupiditate fuga magni sit. Eos quos voluptatum sint harum sint omnis beatae nemo.' vuldetect: 'Quia explicabo perferendis sunt qui laudantium qui. Possimus mollitia necessitatibus aut eveniet voluptatem et et. Et corporis sunt blanditiis sed.' priority: Low qod_type: exploit qod_value: 30 properties: data: type: object properties: id: type: string example: 9d7080f9-5840-4e61-a884-1d0f9216c9fc company_id: type: string example: '14' vulnerability_definition_id: type: string example: 9d7080f9-57cc-4596-afcd-5e21658b7f49 vulnerability_definition: type: object properties: id: type: string example: 9d7080f9-57cc-4596-afcd-5e21658b7f49 name: type: string example: 'Doloribus aut cumque accusamus.' description: type: string example: 'Laboriosam quaerat animi iste aut non deleniti. At voluptatum sunt expedita et dolores.' solution: type: string example: 'Iure sit atque quia quia. Consequuntur id consequuntur veniam alias. Porro tempora perferendis id omnis temporibus.' category: type: string example: '4' threat_level: type: string example: Medium definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9d7080f9-5743-4e8d-b0a2-0132d68e44fb o_id: type: string example: 652351cb-9c81-3e1b-b1df-4fed6ce4c421 name: type: string example: '9 via exercitationem input' family: type: string example: '9' reference_urls: type: string example: 'http://olson.org/delectus-saepe-id-consequatur-saepe-aliquam-omnis-reprehenderit, http://mills.com/voluptatum-ullam-a-rerum-omnis.html' reference_cves: type: string example: 'CVE-2017-8188, CVE-2021-6202' solution_type: type: string example: Mitigation solution_description: type: string example: 'Nostrum reiciendis omnis similique. Nostrum rem voluptas aut reprehenderit. Corrupti molestiae qui ut qui. Enim ab quidem architecto sequi sint quaerat quo. In rerum veniam dolorem neque. Eum beatae tenetur molestias aut odit.' summary: type: string example: 'Veniam voluptatum eaque molestiae aut totam mollitia inventore. Et voluptas impedit praesentium consequatur nulla quam. Maxime debitis deserunt fugit qui. Aut et et saepe. Et amet doloremque eaque voluptas quae ad. Non quia id aut.' insight: type: string example: 'Eum perferendis nihil officiis illo quia voluptatem. Esse accusamus doloribus non nobis. Minima necessitatibus doloremque optio et voluptatum. Exercitationem ut omnis quia aut magnam error.' affected: type: string example: 'Dolorem provident ea qui eum sapiente ut ea. Dolore provident sequi aut esse magni. Minus vel a eum laboriosam. Sunt accusamus error nesciunt magnam officia ex.' impact: type: string example: 'Eius voluptatem aut est quibusdam incidunt qui. Repellat dolorum eveniet qui voluptas ut necessitatibus. Cupiditate fuga magni sit. Eos quos voluptatum sint harum sint omnis beatae nemo.' vuldetect: type: string example: 'Quia explicabo perferendis sunt qui laudantium qui. Possimus mollitia necessitatibus aut eveniet voluptatem et et. Et corporis sunt blanditiis sed.' priority: type: string example: Low qod_type: type: string example: exploit qod_value: type: integer example: 30 cvss_base_score: type: number example: 0.4 cvss_base_vector: type: string example: 'AV:A/AC:L/Au:S/C:C/I:N/A:N' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' host: type: string example: 189.239.236.152 hostname: type: string example: stokes.net port: type: string example: 1433/tcp details: type: string example: 'Sequi tempore nihil dolores voluptatem eos labore dolorem. Quod doloribus quibusdam recusandae consequuntur. Officia explicabo possimus vel voluptatem quis ut id.' status: type: string example: Detected first_seen: type: string example: '2024-01-26T03:49:27.000000Z' last_seen: type: string example: '2024-05-22T10:52:58.000000Z' created_at: type: string example: '2024-11-08T11:27:37.000000Z' updated_at: type: string example: '2024-11-08T11:27:37.000000Z' name: type: string example: 'Doloribus aut cumque accusamus.' description: type: string example: 'Sequi tempore nihil dolores voluptatem eos labore dolorem. Quod doloribus quibusdam recusandae consequuntur. Officia explicabo possimus vel voluptatem quis ut id.' cvss_base_score: type: number example: 0.4 cvss_base_vector: type: string example: 'AV:A/AC:L/Au:S/C:C/I:N/A:N' qod_type: type: string example: exploit qod_value: type: integer example: 30 threat: type: string example: Medium scanner_id: type: string example: null scanner_hostname: type: string example: null plugin: type: object properties: id: type: string example: 9d7080f9-5743-4e8d-b0a2-0132d68e44fb o_id: type: string example: 652351cb-9c81-3e1b-b1df-4fed6ce4c421 name: type: string example: '9 via exercitationem input' family: type: string example: '9' reference_urls: type: string example: 'http://olson.org/delectus-saepe-id-consequatur-saepe-aliquam-omnis-reprehenderit, http://mills.com/voluptatum-ullam-a-rerum-omnis.html' reference_cves: type: string example: 'CVE-2017-8188, CVE-2021-6202' solution_type: type: string example: Mitigation solution_description: type: string example: 'Nostrum reiciendis omnis similique. Nostrum rem voluptas aut reprehenderit. Corrupti molestiae qui ut qui. Enim ab quidem architecto sequi sint quaerat quo. In rerum veniam dolorem neque. Eum beatae tenetur molestias aut odit.' summary: type: string example: 'Veniam voluptatum eaque molestiae aut totam mollitia inventore. Et voluptas impedit praesentium consequatur nulla quam. Maxime debitis deserunt fugit qui. Aut et et saepe. Et amet doloremque eaque voluptas quae ad. Non quia id aut.' insight: type: string example: 'Eum perferendis nihil officiis illo quia voluptatem. Esse accusamus doloribus non nobis. Minima necessitatibus doloremque optio et voluptatum. Exercitationem ut omnis quia aut magnam error.' affected: type: string example: 'Dolorem provident ea qui eum sapiente ut ea. Dolore provident sequi aut esse magni. Minus vel a eum laboriosam. Sunt accusamus error nesciunt magnam officia ex.' impact: type: string example: 'Eius voluptatem aut est quibusdam incidunt qui. Repellat dolorum eveniet qui voluptas ut necessitatibus. Cupiditate fuga magni sit. Eos quos voluptatum sint harum sint omnis beatae nemo.' vuldetect: type: string example: 'Quia explicabo perferendis sunt qui laudantium qui. Possimus mollitia necessitatibus aut eveniet voluptatem et et. Et corporis sunt blanditiis sed.' priority: type: string example: Low qod_type: type: string example: exploit qod_value: type: integer example: 30 tags: - Vulnerabilities parameters: - in: path name: id description: 'The ID of the vulnerability.' example: voluptatem 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: status required: false schema: type: string description: 'Filter the results by column(s) (comma separated).' example: status nullable: false enum: - webhook_id - event - status responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9d7080f7-fc8d-4ab0-b51f-7c32e6294392 webhook_id: 9d7080f7-fbc7-4d00-be41-54a478e48da7 event: non payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 9d7080f8-012d-40d4-966f-2df3a14fb31e webhook_id: 9d7080f8-0009-404f-a5d2-a20ea1f811c3 event: numquam payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: / per_page: 10 to: 2 total: 2 properties: data: type: array example: - id: 9d7080f7-fc8d-4ab0-b51f-7c32e6294392 webhook_id: 9d7080f7-fbc7-4d00-be41-54a478e48da7 event: non payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 9d7080f8-012d-40d4-966f-2df3a14fb31e webhook_id: 9d7080f8-0009-404f-a5d2-a20ea1f811c3 event: numquam payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' items: type: object properties: id: type: string example: 9d7080f7-fc8d-4ab0-b51f-7c32e6294392 webhook_id: type: string example: 9d7080f7-fbc7-4d00-be41-54a478e48da7 event: type: string example: non 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: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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' active: false - url: '/?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' 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: 9d7080f8-0b25-4174-b396-202476f50e1a webhook_id: 9d7080f8-0a5e-4df2-bceb-f9aa5eb5588f event: quas payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f8-0b25-4174-b396-202476f50e1a webhook_id: type: string example: 9d7080f8-0a5e-4df2-bceb-f9aa5eb5588f event: type: string example: quas 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: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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: 9d7080f7-fc8d-4ab0-b51f-7c32e6294392 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: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 company_id: 7a93396a-b33c-4709-9a9f-184f60e5aa30 url: 'https://roob.net' description: null events: [] secret: 56cc53d1c443bbef42bb1b884019c9ae5f5501a6f7f87aea63b25a3ed9d86b31 last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 9d7080f7-e633-4120-b369-cfee5495a2c8 company_id: 817915d9-1564-4cee-b8b8-deac0d49adb7 url: 'https://gottlieb.com' description: null events: [] secret: a50355b6446c47cc98e403b28afb0cb5edd42ae63c5ff8e0f32820e47c0d7d80 last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' properties: data: type: array example: - id: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 company_id: 7a93396a-b33c-4709-9a9f-184f60e5aa30 url: 'https://roob.net' description: null events: [] secret: 56cc53d1c443bbef42bb1b884019c9ae5f5501a6f7f87aea63b25a3ed9d86b31 last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' - id: 9d7080f7-e633-4120-b369-cfee5495a2c8 company_id: 817915d9-1564-4cee-b8b8-deac0d49adb7 url: 'https://gottlieb.com' description: null events: [] secret: a50355b6446c47cc98e403b28afb0cb5edd42ae63c5ff8e0f32820e47c0d7d80 last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' items: type: object properties: id: type: string example: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 company_id: type: string example: 7a93396a-b33c-4709-9a9f-184f60e5aa30 url: type: string example: 'https://roob.net' description: type: string example: null events: type: array example: [] secret: type: string example: 56cc53d1c443bbef42bb1b884019c9ae5f5501a6f7f87aea63b25a3ed9d86b31 last_sent_at: type: string example: null created_at: type: string example: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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.' example: 'http://www.gerhold.net/' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Nobis occaecati velit cum quae.' 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: 9d7080f7-ede6-422e-93ce-d55fd3242501 company_id: 254bbc76-b7d6-495c-acab-bccb9db365b6 url: 'https://robel.com' description: null events: [] secret: a76398945f4e70fc9db1b7254604c6c319613252199123fc9ee39f8f5ec19f5a last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f7-ede6-422e-93ce-d55fd3242501 company_id: type: string example: 254bbc76-b7d6-495c-acab-bccb9db365b6 url: type: string example: 'https://robel.com' description: type: string example: null events: type: array example: [] secret: type: string example: a76398945f4e70fc9db1b7254604c6c319613252199123fc9ee39f8f5ec19f5a last_sent_at: type: string example: null created_at: type: string example: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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://www.miller.com/deserunt-in-autem-sapiente-laborum-ducimus-libero' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Dolore qui iure hic ullam.' 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' 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: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 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: 9d7080f7-f208-4142-bde8-f3ebf744d343 company_id: a6cb4640-4770-4e4e-bd1c-4ed9ab2d814b url: 'https://pagac.net' description: null events: [] secret: 627583ca35dc28aa501efecd8a01132d0b144b065ca0ad5e44035301f2f1ec6b last_sent_at: null created_at: '2024-11-08T11:27:36.000000Z' updated_at: '2024-11-08T11:27:36.000000Z' properties: data: type: object properties: id: type: string example: 9d7080f7-f208-4142-bde8-f3ebf744d343 company_id: type: string example: a6cb4640-4770-4e4e-bd1c-4ed9ab2d814b url: type: string example: 'https://pagac.net' description: type: string example: null events: type: array example: [] secret: type: string example: 627583ca35dc28aa501efecd8a01132d0b144b065ca0ad5e44035301f2f1ec6b last_sent_at: type: string example: null created_at: type: string example: '2024-11-08T11:27:36.000000Z' updated_at: type: string example: '2024-11-08T11:27:36.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: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 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' 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: 9d7080f7-e2b2-4251-83b5-3a987f0fc6a8 required: true schema: type: string 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: []