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: 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 - 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: 9e170913-c118-42a9-a4d3-db23da17f993 cpe: 'cpe:2.3:a:microsoft:sql_server:*:*:*:*:*:*:*:*' vendor: Microsoft product: 'SQL Server' version: 3.70.7803 update: update1 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-c221-4d5c-a30d-c86b813fd71d cpe: 'cpe:2.3:a:ibm:db2:*:*:*:*:*:*:*:*' vendor: IBM product: DB2 version: 15.87.1309 update: sp1 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15: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: 9e170913-c118-42a9-a4d3-db23da17f993 cpe: 'cpe:2.3:a:microsoft:sql_server:*:*:*:*:*:*:*:*' vendor: Microsoft product: 'SQL Server' version: 3.70.7803 update: update1 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-c221-4d5c-a30d-c86b813fd71d cpe: 'cpe:2.3:a:ibm:db2:*:*:*:*:*:*:*:*' vendor: IBM product: DB2 version: 15.87.1309 update: sp1 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' items: type: object properties: id: type: string example: 9e170913-c118-42a9-a4d3-db23da17f993 cpe: type: string example: 'cpe:2.3:a:microsoft:sql_server:*:*:*:*:*:*:*:*' vendor: type: string example: Microsoft product: type: string example: 'SQL Server' version: type: string example: 3.70.7803 update: type: string example: update1 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: version required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor' description: '' example: version 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: 9e170913-c6ca-42a9-a455-087e43cf4f17 cpe: 'cpe:2.3:a:cisco:jabber:*:*:*:*:*:*:*:*' vendor: Cisco product: Jabber version: 15.19.7049 update: sp2 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' properties: data: type: object properties: id: type: string example: 9e170913-c6ca-42a9-a455-087e43cf4f17 cpe: type: string example: 'cpe:2.3:a:cisco:jabber:*:*:*:*:*:*:*:*' vendor: type: string example: Cisco product: type: string example: Jabber version: type: string example: 15.19.7049 update: type: string example: sp2 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15:37.000000Z' tags: - Applications parameters: - in: path name: id description: 'The ID of the application.' example: ut 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: tags required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: tags nullable: false enum: - certificates - software - tags - scans responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9e170913-7d35-42c2-b94c-457a1ca65ebd company_id: '3371920' name: 'Enrique Strosin' identifier: '51:B8:6B:C0:40:64' host: 6.66.158.81 mac_address: '51:B8:6B:C0:40:64' hostname: pacocha.info operating_system: ab operating_system_name: necessitatibus first_seen: '1976-01-31T04:42:22.000000Z' last_seen: '2019-06-01T16:50:25.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] - id: 9e170913-7ffc-4dbe-9013-57e93936fca3 company_id: '4572017' name: 'Mr. Rashawn Gusikowski III' identifier: 131.43.156.137 host: 131.43.156.137 mac_address: null hostname: hartmann.com operating_system: perferendis operating_system_name: corrupti first_seen: '1989-12-05T18:52:32.000000Z' last_seen: '2002-08-14T12:54: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: 9e170913-7d35-42c2-b94c-457a1ca65ebd company_id: '3371920' name: 'Enrique Strosin' identifier: '51:B8:6B:C0:40:64' host: 6.66.158.81 mac_address: '51:B8:6B:C0:40:64' hostname: pacocha.info operating_system: ab operating_system_name: necessitatibus first_seen: '1976-01-31T04:42:22.000000Z' last_seen: '2019-06-01T16:50:25.000000Z' open_tcp_ports: '80,443' open_udp_ports: '53,123' traceroute: - '' ssh_key: null average_scan_duration: 0 scans: [] - id: 9e170913-7ffc-4dbe-9013-57e93936fca3 company_id: '4572017' name: 'Mr. Rashawn Gusikowski III' identifier: 131.43.156.137 host: 131.43.156.137 mac_address: null hostname: hartmann.com operating_system: perferendis operating_system_name: corrupti first_seen: '1989-12-05T18:52:32.000000Z' last_seen: '2002-08-14T12:54: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: 9e170913-7d35-42c2-b94c-457a1ca65ebd company_id: type: string example: '3371920' name: type: string example: 'Enrique Strosin' identifier: type: string example: '51:B8:6B:C0:40:64' host: type: string example: 6.66.158.81 mac_address: type: string example: '51:B8:6B:C0:40:64' hostname: type: string example: pacocha.info operating_system: type: string example: ab operating_system_name: type: string example: necessitatibus first_seen: type: string example: '1976-01-31T04:42:22.000000Z' last_seen: type: string example: '2019-06-01T16:50:25.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: 9e170913-8b79-4561-b2b1-9b1bf5cd617e company_id: '9388123' name: 'Ivah Leuschke' identifier: '47:37:54:E7:7F:70' host: 87.87.194.8 mac_address: '47:37:54:E7:7F:70' hostname: hintz.net operating_system: doloremque operating_system_name: voluptate first_seen: '2016-12-21T20:06:35.000000Z' last_seen: '2012-06-29T04:12:02.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: 9e170913-8b79-4561-b2b1-9b1bf5cd617e company_id: type: string example: '9388123' name: type: string example: 'Ivah Leuschke' identifier: type: string example: '47:37:54:E7:7F:70' host: type: string example: 87.87.194.8 mac_address: type: string example: '47:37:54:E7:7F:70' hostname: type: string example: hintz.net operating_system: type: string example: doloremque operating_system_name: type: string example: voluptate first_seen: type: string example: '2016-12-21T20:06:35.000000Z' last_seen: type: string example: '2012-06-29T04:12:02.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: pdgjfnxtstqx nullable: false host: type: string description: 'A valid IPv4 or IPv6 address. Must be unique' example: molestias 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: csv required: true schema: type: 'The type of export to generate' description: '' example: csv 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: true content: application/json: schema: type: object properties: data: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: action: type: string description: '' example: addTags nullable: false enum: - addTags - removeTags - delete id: type: string description: '' example: repudiandae nullable: false data: type: object description: '' example: [] nullable: false properties: tags: type: object description: '' example: [] nullable: false properties: { } required: - action - id required: - data '/v1/assets/{id}': get: summary: 'Retrieve an asset.' operationId: retrieveAnAsset description: " Retrieves an asset by its ID.\n " parameters: - in: query name: include description: '' example: tags required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: tags nullable: false enum: - certificates - software - tags - scans responses: 200: description: 'Successfully retrieved asset' content: application/json: schema: type: object example: data: id: 9e170913-90f8-4f68-be63-6ed01907adbf company_id: '4031823' name: 'Shania Wyman' identifier: 'DB:9D:D0:AA:1E:3A' host: 120.60.227.0 mac_address: 'DB:9D:D0:AA:1E:3A' hostname: pfannerstill.com operating_system: aut operating_system_name: perferendis first_seen: '2010-09-29T19:38:56.000000Z' last_seen: '1976-06-02T23:11:52.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: 9e170913-90f8-4f68-be63-6ed01907adbf company_id: type: string example: '4031823' name: type: string example: 'Shania Wyman' identifier: type: string example: 'DB:9D:D0:AA:1E:3A' host: type: string example: 120.60.227.0 mac_address: type: string example: 'DB:9D:D0:AA:1E:3A' hostname: type: string example: pfannerstill.com operating_system: type: string example: aut operating_system_name: type: string example: perferendis first_seen: type: string example: '2010-09-29T19:38:56.000000Z' last_seen: type: string example: '1976-06-02T23:11:52.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: 9e170913-952b-4ad4-8bb0-a91be2a0db75 company_id: '3873852' name: 'Hallie Lueilwitz Jr.' identifier: '5B:81:2A:7F:B8:2C' host: 66.40.210.35 mac_address: '5B:81:2A:7F:B8:2C' hostname: konopelski.com operating_system: et operating_system_name: qui first_seen: '2004-07-21T15:55:01.000000Z' last_seen: '1992-02-17T15:44:54.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: 9e170913-952b-4ad4-8bb0-a91be2a0db75 company_id: type: string example: '3873852' name: type: string example: 'Hallie Lueilwitz Jr.' identifier: type: string example: '5B:81:2A:7F:B8:2C' host: type: string example: 66.40.210.35 mac_address: type: string example: '5B:81:2A:7F:B8:2C' hostname: type: string example: konopelski.com operating_system: type: string example: et operating_system_name: type: string example: qui first_seen: type: string example: '2004-07-21T15:55:01.000000Z' last_seen: type: string example: '1992-02-17T15:44:54.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: wmrruobopsezcgil 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: doloremque 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: 9e170913-9c3b-486f-9414-70896e596a34 company_id: '1267069' common_name: conroy.com organization: Wilkinson-Herzog organizational_unit: LLC locality: null state: null country: IE serial: TWN8ILLCPSCVCLYY4AVQQTVPGOEEKGZ1 not_valid_before: 20240406T074827Z not_valid_after: 20261219T143757Z value: "-----BEGIN CERTIFICATE-----\noHCcRRuJZjaVwAjiRd8pQKFOF+OaR40K9dZ1xtY3PJedqTWgwaqCiOAUgJKFetbL\ntbG0KFGNb6p58kbS06lLawAWiYOkw6U2ci3n4mMHtWFLpszNwBNULwORRqjLJHkp\n6Y2ecHi83Ta2ZLPyS2uXKa2mzzlXl+XRnJodK1vY5tonuSrrGdc8zDQZn8F24RTX\nnTQ8JZkzpk7txfj9EmOal3jJQZyLKXRYR+9VrSo93YGlYOmUG5b7RF6HsJDxAFdN\nRMYysHNC97KTdkYMshbOsIql2IuM6KdQt0H4pIkUgkaf4ANvJUe5PIqgkiQ4xpTJ\nDtxk/TSC89V7QeNhobJVShfCx+cBBQGF+IOc0moY/LnQ1UN5BfRMDNukXihdKWDy\nmQPl8ZMxOJyIvlvF17KtDqgccj2vufbj2neLFqVCVuQcBoekkbrDyEXPjHt8eGNF\nWgDYxWxG2522WOukvHRKhNdc1khPIijHwAiBvBXlBANMFZ9iNmi+a/WYBCnq4Iug\nyLdQCEc3/3W5xM53kqoxRbJSWaJwJueZvpSAMzxbf1w5JTTWGF+63fOccpBU8j9Z\njpB70ENCupvK52npfkUY9b3M1/4Xjr9jB8nwQouL42UQ5k3Zmh5vKC4EAUQ9bHT8\nQUrbGxIs6aLA1KxwbFzYrjf98EY+fDtsNAL5TzIwBWpJgeSDtBlcd45rsZmpkiTB\noz27M7Xsh7IEK21YMTPQ+uTlo9E0iKHIrygJQnuBqW1dYaAzG+IJsoDx8ISQuOnZ\nP4cdhQS3wduSGK1mSDwkFVTOjU9uXCWMm8oFweeGAdxAIUMbxHTJ5Z8RxRq9pTcE\nDbnHYnBYJfazDQU7q5DU86J4tgk7ryUNCjVCgPjS6tiSgAQv1VrOd97+9xApRvyp\nyX/UC2rIP9DjI4Ms6snhV64YzyJwHHouX29R7bDoOrV5EqKmfKxm46kANsbk0J3q\n3AtmyZRanQLW/Z/MIh6/6cR7B9bnL01U9s4ECM4yUu0dqloTafJu4iSnALeVlI/5\nCbRENqwcDvvJNhHxekpBm2kqMkPp1B1N/2ODa4AAXRyGbBoqdv8aFWnOKLe349Qn\nr64aR5gciHuDhnEWo976HNBNLsra+Y79TX0STMPfCqxQxS/bGh4Dwx00X0540SsE\nSGOKMj76jChWo/ncylTgWdHLjbbZaGyXxesOt4MqQnjXqOvFWQ0nW4x83j+JgWXj\n/8YCveWs22gFiGi1ICRgTTVYaufzdWwx3nNNG0RZp2glGvStDobfqYUqnR/Mo3QY\nOCxSEAaFXNUaravTSHjBI/KYT+qEAFsukhi1ExJt6Ef/f4+0fBvHPfxyb+7qAFeZ\njaMAogHD9jlaMZk4cPLSBA==\n\n-----END CERTIFICATE-----" first_seen: '2024-04-15T07:57:31.000000Z' last_seen: '2024-04-16T09:08:31.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-9ec9-47ac-9c1e-1614d6507b4f company_id: '3296472' common_name: thompson.com organization: Kohler-Zemlak organizational_unit: 'and Sons' locality: 'North Deborah' state: Mississippi country: CZ serial: UIE67JEQS4PKBVYEJKOACQC1EZDMUX1C not_valid_before: 20240731T003558Z not_valid_after: 20251017T224107Z value: "-----BEGIN CERTIFICATE-----\nzmtCIc31hgMTySiE7XKScCSZnWKlafQCYQjqss18J3YZXncK5EJDSOLqrm8tyqnL\ncS8VVei4uRWnGhRvJI7e/Pz9tI2jLos9dDzT4P0K0CJH1RyIpFWqhiICbLD8h9Mq\n8MiFbejo1GrvS8rQ/Lg7FVyp/K4/36rvroJsXV61bhroKcIBxA9/0l37n1SKOosV\nYa8eWrJ7Q1UvCtAiMZVrfjNFkJorcxxNReIC4OUiTpdpEDPWHVnDJF35h7OLjIfB\nbXlEZaWsiCRSqxwK88s/NqDx6xD/kFVbKAqe2aRnYD/zxCSQTzfP0RKU53zyIyYl\noLWBPnukejWzL8F/mXxHLM9WrQ8rcwdsfvTcsyfSGa1/fVprfzvqbRSSSJf36hHv\naPAchvAqrZ7ZEHzf+L82nHI/HdZSyxByj2bcGTjGR+VhXfziHUGTLevM3e2o7Z2d\n+SOGgJV+n6DWjPLF7DpADyxYBYFFJO2DQCeFpM7ENDh2ZtrP2Rr0pxjy9TcyWHYq\nmdIJwuqUR4EcrbWm/emVanwOP2n8PBwGuqQhhFFAK1Iy4XHbE8Cdu7ykXfQ5sWwa\nsuk/kvnygO6NCt389I8j/+eMfjtNzpL1jlgRrrwSbsR1noXurRPRN5keY9AWil6z\nKAUws0G06VuPv1oydkPtmgmCTspPQMmu2VeAmwKYDgSwHsBmn11cyNSE8illSLMk\novut50wCzhkYH41c242KAdNY6NQCHWip3Ok0T+AFaC3zzCx5ECp2nplpok3cnJem\n8OA10iMqgEAcl5rBUvTdFf3mHg5qVeNQ9YjMRa1/3G6MJkdnD/h39F+KDgl10tia\n75UeDpz4wdLAZFRNtRv/5mb40NTZR/N+PBUZiFwuOvgREm7XMML6tjjK7qD7H7Uf\nt3GfZ7a9oAqqQRqo1uKq0XOHhwGYJntKURycxhdxDb4DpNn1fN/CXCl4s4oyJqjl\nuZy6Mjb8NLZEMM6Ksx8xnUtZTOM9Mwto53+fuYZRC/4G7ZXWLBmJ+jTlZqOpdg5+\nJQnH1nIPNBlOLcdD1cqiqLTWbAJBxfbY+kWI2nZk2dN1B5ECiQdEVDnC84JdBo9J\npHkoqPHMvHtyzFBWi/GbU9B9vDWE5mzXKT5TXO/c1T4hfQtUrM2qxs6w0FYwFy/7\nu/aqAzvRNRP12kXTxsdpsi3E2RNkcpHET25e7TEh+aX9MvTfqWiIHcAEbRO81lvh\n0sW8QUtUKBTvroVQr4+KjEhFfHk46UtYn1QLZ+Yqhv9/C81lmKbvgYyA8ZWniIio\nVMvGlMDfgS39OYw73msB1TioVPUbmPCwQ0AUaBNlKQ1YvqhgSaWAHj874fvJYbFM\nkezlLcxEIJagYMmr5mHRXw==\n\n-----END CERTIFICATE-----" first_seen: '2024-09-29T08:24:49.000000Z' last_seen: '2024-12-21T20:31:05.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15: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: 9e170913-9c3b-486f-9414-70896e596a34 company_id: '1267069' common_name: conroy.com organization: Wilkinson-Herzog organizational_unit: LLC locality: null state: null country: IE serial: TWN8ILLCPSCVCLYY4AVQQTVPGOEEKGZ1 not_valid_before: 20240406T074827Z not_valid_after: 20261219T143757Z value: "-----BEGIN CERTIFICATE-----\noHCcRRuJZjaVwAjiRd8pQKFOF+OaR40K9dZ1xtY3PJedqTWgwaqCiOAUgJKFetbL\ntbG0KFGNb6p58kbS06lLawAWiYOkw6U2ci3n4mMHtWFLpszNwBNULwORRqjLJHkp\n6Y2ecHi83Ta2ZLPyS2uXKa2mzzlXl+XRnJodK1vY5tonuSrrGdc8zDQZn8F24RTX\nnTQ8JZkzpk7txfj9EmOal3jJQZyLKXRYR+9VrSo93YGlYOmUG5b7RF6HsJDxAFdN\nRMYysHNC97KTdkYMshbOsIql2IuM6KdQt0H4pIkUgkaf4ANvJUe5PIqgkiQ4xpTJ\nDtxk/TSC89V7QeNhobJVShfCx+cBBQGF+IOc0moY/LnQ1UN5BfRMDNukXihdKWDy\nmQPl8ZMxOJyIvlvF17KtDqgccj2vufbj2neLFqVCVuQcBoekkbrDyEXPjHt8eGNF\nWgDYxWxG2522WOukvHRKhNdc1khPIijHwAiBvBXlBANMFZ9iNmi+a/WYBCnq4Iug\nyLdQCEc3/3W5xM53kqoxRbJSWaJwJueZvpSAMzxbf1w5JTTWGF+63fOccpBU8j9Z\njpB70ENCupvK52npfkUY9b3M1/4Xjr9jB8nwQouL42UQ5k3Zmh5vKC4EAUQ9bHT8\nQUrbGxIs6aLA1KxwbFzYrjf98EY+fDtsNAL5TzIwBWpJgeSDtBlcd45rsZmpkiTB\noz27M7Xsh7IEK21YMTPQ+uTlo9E0iKHIrygJQnuBqW1dYaAzG+IJsoDx8ISQuOnZ\nP4cdhQS3wduSGK1mSDwkFVTOjU9uXCWMm8oFweeGAdxAIUMbxHTJ5Z8RxRq9pTcE\nDbnHYnBYJfazDQU7q5DU86J4tgk7ryUNCjVCgPjS6tiSgAQv1VrOd97+9xApRvyp\nyX/UC2rIP9DjI4Ms6snhV64YzyJwHHouX29R7bDoOrV5EqKmfKxm46kANsbk0J3q\n3AtmyZRanQLW/Z/MIh6/6cR7B9bnL01U9s4ECM4yUu0dqloTafJu4iSnALeVlI/5\nCbRENqwcDvvJNhHxekpBm2kqMkPp1B1N/2ODa4AAXRyGbBoqdv8aFWnOKLe349Qn\nr64aR5gciHuDhnEWo976HNBNLsra+Y79TX0STMPfCqxQxS/bGh4Dwx00X0540SsE\nSGOKMj76jChWo/ncylTgWdHLjbbZaGyXxesOt4MqQnjXqOvFWQ0nW4x83j+JgWXj\n/8YCveWs22gFiGi1ICRgTTVYaufzdWwx3nNNG0RZp2glGvStDobfqYUqnR/Mo3QY\nOCxSEAaFXNUaravTSHjBI/KYT+qEAFsukhi1ExJt6Ef/f4+0fBvHPfxyb+7qAFeZ\njaMAogHD9jlaMZk4cPLSBA==\n\n-----END CERTIFICATE-----" first_seen: '2024-04-15T07:57:31.000000Z' last_seen: '2024-04-16T09:08:31.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-9ec9-47ac-9c1e-1614d6507b4f company_id: '3296472' common_name: thompson.com organization: Kohler-Zemlak organizational_unit: 'and Sons' locality: 'North Deborah' state: Mississippi country: CZ serial: UIE67JEQS4PKBVYEJKOACQC1EZDMUX1C not_valid_before: 20240731T003558Z not_valid_after: 20251017T224107Z value: "-----BEGIN CERTIFICATE-----\nzmtCIc31hgMTySiE7XKScCSZnWKlafQCYQjqss18J3YZXncK5EJDSOLqrm8tyqnL\ncS8VVei4uRWnGhRvJI7e/Pz9tI2jLos9dDzT4P0K0CJH1RyIpFWqhiICbLD8h9Mq\n8MiFbejo1GrvS8rQ/Lg7FVyp/K4/36rvroJsXV61bhroKcIBxA9/0l37n1SKOosV\nYa8eWrJ7Q1UvCtAiMZVrfjNFkJorcxxNReIC4OUiTpdpEDPWHVnDJF35h7OLjIfB\nbXlEZaWsiCRSqxwK88s/NqDx6xD/kFVbKAqe2aRnYD/zxCSQTzfP0RKU53zyIyYl\noLWBPnukejWzL8F/mXxHLM9WrQ8rcwdsfvTcsyfSGa1/fVprfzvqbRSSSJf36hHv\naPAchvAqrZ7ZEHzf+L82nHI/HdZSyxByj2bcGTjGR+VhXfziHUGTLevM3e2o7Z2d\n+SOGgJV+n6DWjPLF7DpADyxYBYFFJO2DQCeFpM7ENDh2ZtrP2Rr0pxjy9TcyWHYq\nmdIJwuqUR4EcrbWm/emVanwOP2n8PBwGuqQhhFFAK1Iy4XHbE8Cdu7ykXfQ5sWwa\nsuk/kvnygO6NCt389I8j/+eMfjtNzpL1jlgRrrwSbsR1noXurRPRN5keY9AWil6z\nKAUws0G06VuPv1oydkPtmgmCTspPQMmu2VeAmwKYDgSwHsBmn11cyNSE8illSLMk\novut50wCzhkYH41c242KAdNY6NQCHWip3Ok0T+AFaC3zzCx5ECp2nplpok3cnJem\n8OA10iMqgEAcl5rBUvTdFf3mHg5qVeNQ9YjMRa1/3G6MJkdnD/h39F+KDgl10tia\n75UeDpz4wdLAZFRNtRv/5mb40NTZR/N+PBUZiFwuOvgREm7XMML6tjjK7qD7H7Uf\nt3GfZ7a9oAqqQRqo1uKq0XOHhwGYJntKURycxhdxDb4DpNn1fN/CXCl4s4oyJqjl\nuZy6Mjb8NLZEMM6Ksx8xnUtZTOM9Mwto53+fuYZRC/4G7ZXWLBmJ+jTlZqOpdg5+\nJQnH1nIPNBlOLcdD1cqiqLTWbAJBxfbY+kWI2nZk2dN1B5ECiQdEVDnC84JdBo9J\npHkoqPHMvHtyzFBWi/GbU9B9vDWE5mzXKT5TXO/c1T4hfQtUrM2qxs6w0FYwFy/7\nu/aqAzvRNRP12kXTxsdpsi3E2RNkcpHET25e7TEh+aX9MvTfqWiIHcAEbRO81lvh\n0sW8QUtUKBTvroVQr4+KjEhFfHk46UtYn1QLZ+Yqhv9/C81lmKbvgYyA8ZWniIio\nVMvGlMDfgS39OYw73msB1TioVPUbmPCwQ0AUaBNlKQ1YvqhgSaWAHj874fvJYbFM\nkezlLcxEIJagYMmr5mHRXw==\n\n-----END CERTIFICATE-----" first_seen: '2024-09-29T08:24:49.000000Z' last_seen: '2024-12-21T20:31:05.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' items: type: object properties: id: type: string example: 9e170913-9c3b-486f-9414-70896e596a34 company_id: type: string example: '1267069' common_name: type: string example: conroy.com organization: type: string example: Wilkinson-Herzog organizational_unit: type: string example: LLC locality: type: string example: null state: type: string example: null country: type: string example: IE serial: type: string example: TWN8ILLCPSCVCLYY4AVQQTVPGOEEKGZ1 not_valid_before: type: string example: 20240406T074827Z not_valid_after: type: string example: 20261219T143757Z value: type: string example: "-----BEGIN CERTIFICATE-----\noHCcRRuJZjaVwAjiRd8pQKFOF+OaR40K9dZ1xtY3PJedqTWgwaqCiOAUgJKFetbL\ntbG0KFGNb6p58kbS06lLawAWiYOkw6U2ci3n4mMHtWFLpszNwBNULwORRqjLJHkp\n6Y2ecHi83Ta2ZLPyS2uXKa2mzzlXl+XRnJodK1vY5tonuSrrGdc8zDQZn8F24RTX\nnTQ8JZkzpk7txfj9EmOal3jJQZyLKXRYR+9VrSo93YGlYOmUG5b7RF6HsJDxAFdN\nRMYysHNC97KTdkYMshbOsIql2IuM6KdQt0H4pIkUgkaf4ANvJUe5PIqgkiQ4xpTJ\nDtxk/TSC89V7QeNhobJVShfCx+cBBQGF+IOc0moY/LnQ1UN5BfRMDNukXihdKWDy\nmQPl8ZMxOJyIvlvF17KtDqgccj2vufbj2neLFqVCVuQcBoekkbrDyEXPjHt8eGNF\nWgDYxWxG2522WOukvHRKhNdc1khPIijHwAiBvBXlBANMFZ9iNmi+a/WYBCnq4Iug\nyLdQCEc3/3W5xM53kqoxRbJSWaJwJueZvpSAMzxbf1w5JTTWGF+63fOccpBU8j9Z\njpB70ENCupvK52npfkUY9b3M1/4Xjr9jB8nwQouL42UQ5k3Zmh5vKC4EAUQ9bHT8\nQUrbGxIs6aLA1KxwbFzYrjf98EY+fDtsNAL5TzIwBWpJgeSDtBlcd45rsZmpkiTB\noz27M7Xsh7IEK21YMTPQ+uTlo9E0iKHIrygJQnuBqW1dYaAzG+IJsoDx8ISQuOnZ\nP4cdhQS3wduSGK1mSDwkFVTOjU9uXCWMm8oFweeGAdxAIUMbxHTJ5Z8RxRq9pTcE\nDbnHYnBYJfazDQU7q5DU86J4tgk7ryUNCjVCgPjS6tiSgAQv1VrOd97+9xApRvyp\nyX/UC2rIP9DjI4Ms6snhV64YzyJwHHouX29R7bDoOrV5EqKmfKxm46kANsbk0J3q\n3AtmyZRanQLW/Z/MIh6/6cR7B9bnL01U9s4ECM4yUu0dqloTafJu4iSnALeVlI/5\nCbRENqwcDvvJNhHxekpBm2kqMkPp1B1N/2ODa4AAXRyGbBoqdv8aFWnOKLe349Qn\nr64aR5gciHuDhnEWo976HNBNLsra+Y79TX0STMPfCqxQxS/bGh4Dwx00X0540SsE\nSGOKMj76jChWo/ncylTgWdHLjbbZaGyXxesOt4MqQnjXqOvFWQ0nW4x83j+JgWXj\n/8YCveWs22gFiGi1ICRgTTVYaufzdWwx3nNNG0RZp2glGvStDobfqYUqnR/Mo3QY\nOCxSEAaFXNUaravTSHjBI/KYT+qEAFsukhi1ExJt6Ef/f4+0fBvHPfxyb+7qAFeZ\njaMAogHD9jlaMZk4cPLSBA==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2024-04-15T07:57:31.000000Z' last_seen: type: string example: '2024-04-16T09:08:31.000000Z' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: csv required: true schema: type: 'The type of export to generate' description: '' example: csv nullable: false enum: - csv - xlsx - in: query name: 'filter[common_name]' description: '' example: test.nl required: false schema: type: 'Filter certificates by their common name.' description: '' example: test.nl nullable: false - in: query name: 'filter[organization]' description: '' example: 'Test B.V.' required: false schema: type: 'Filter certificates by their organization name.' description: '' example: 'Test B.V.' nullable: false - in: query name: sort description: '' example: not_valid_after required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before' description: '' example: not_valid_after nullable: false enum: - not_valid_after - in: query name: filter description: '' example: organization required: false schema: type: 'The column(s) to filter by. Eg filter=common_name:test.nl' description: '' example: organization nullable: false enum: - common_name - organization responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Certificates '/v1/certificates/{id}': get: summary: 'Retrieve a certificate.' operationId: retrieveACertificate description: " Retrieves an by its ID.\n " parameters: - in: query name: include description: '' example: applications required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: applications nullable: false enum: - certificates - applications - tags - scans responses: 200: description: 'Successfully retrieved certificate' content: application/json: schema: type: object example: data: id: 9e170913-a496-4bd6-af5b-964b5e46152f company_id: '5513380' common_name: langworth.biz organization: Weissnat-Blanda organizational_unit: 'and Sons' locality: 'East Marlin' state: 'District of Columbia' country: CM serial: CJ9OYOLXN42LU0ZWD58ISAXQVJJVH21V not_valid_before: 20240309T125537Z not_valid_after: 20250527T055348Z value: "-----BEGIN CERTIFICATE-----\nzOdggE0yOnBh14n0uSCJw8FV5WeIrYxUJYChQX5laf6lOC7hnuJNSp4MdT0EZn1j\nNHb4yLl8AS0476T/9p0E0YALL3OckIaIa5VsNKV1puV3xMXOzDG4BQ2ulhw7oVm5\n9+3yJ4ftEX72rRLEa78bmzmN5xrnoGRcCGqjwyDtss9pt02j0Ce2sjDLZqy+D0Bw\nJzQ7p68ol9yUzQZQbX1Cwho6lEjyrkfAxhg4GXplxgIpzm6RdE/n5OttbU5WP80I\nrgtWiXHZVxwt0Kz7+jNXzoXyQt7k/IEGSA4AHuQREmdUaGhreNitwE12H3+G9vY3\nBYxWBDAid/gMj4G1vu5XbCmOS/L6spYR+z1G7OglIJYwMnP61KjxlQ+ZyU3CUvo1\nRmF/pigSC0bSlud0i/0LjJhJx3H0zSsJBoSE3KREOxKVlsv7TgIcDopNSDKAfcML\n3LPuFI2Y8PP39ISk+7slWXhK4Oezs58vYKsHZdXghYhUX5PvvoP0JFZkZABwSLQr\ngOXVfIxSNvNUtmYGH7Zf+XYt1bQpVuRq2rYnYGdRVUYxvjhKWilcg+9BelBl+YhF\nJRI/is3gS/DxrugMLJtl6c3RcYwQGUU+Tt1wSOREem5w7hI7D9pqpVofYU9dW7M+\nYzUDiIbC/LzKBmhTtxPNVDGnT+zQPbsj3ahoWhjmkXKP4Uy/ULo8moOiGKSpHhsS\nGmBiwn7SPA1W5lh/vnep7eF7/6gZOntFTGybqPRlJdZD4hxW5gEDB5epLlTWB3SL\nkw6Hxx7a0x2lW3UHsKoFpZnY6Rr+iS71xms9IDTbsvlecqvjN4w5Tb2csI/N7w4I\nL3eUmCGyWoaRCENQiWpYQs2wVr6c/gLGwzFmwBPe4zU9rVPccqoVWIFTAhKITffz\nX+2lrJX/obVb1VJb2l+490VLbUFIm7GRmKWiU4BZmYNluHtijxvGTMp22fqrU4fr\nxio61fZVFnmx76X9wAknTfpdEepKRiw3XZy+VwyzCciS/IuAWreHA/PSlWEJhRuJ\nuNTShghYLyNW3gtcjgXMNhY37gNINBn/v0AOqkvbzJegVQd3CUypPjdLCciUvZVW\nqVNwsMCzVRpdEEaBqp2FWjV7smLhXUh/2HpJnrmTeFfDiJYdjwbTQ7VfqllpMsjZ\nBVTRQMdI5bcfclcuRhXv3Mh4TyLEXT2Xjc9oIP1jx/QO/nJmXR+XNm7iuUzLLV8k\ns/31XHpudPHq7ZAKcquoLHVqAN7BSp74ygUV+wwFumq+wAJtUaAUICGYDSo/XERa\nprpqO9DRQUvwM/wVwhJ1dyL4nDEgpgHkWAImK9F7CGm0mDKnyCdcAZapV0c4LCR2\nWs3qeN4Qe6MYkfSCKKVGzg==\n\n-----END CERTIFICATE-----" first_seen: '2024-05-05T01:11:57.000000Z' last_seen: '2024-05-16T03:14:42.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' properties: data: type: object properties: id: type: string example: 9e170913-a496-4bd6-af5b-964b5e46152f company_id: type: string example: '5513380' common_name: type: string example: langworth.biz organization: type: string example: Weissnat-Blanda organizational_unit: type: string example: 'and Sons' locality: type: string example: 'East Marlin' state: type: string example: 'District of Columbia' country: type: string example: CM serial: type: string example: CJ9OYOLXN42LU0ZWD58ISAXQVJJVH21V not_valid_before: type: string example: 20240309T125537Z not_valid_after: type: string example: 20250527T055348Z value: type: string example: "-----BEGIN CERTIFICATE-----\nzOdggE0yOnBh14n0uSCJw8FV5WeIrYxUJYChQX5laf6lOC7hnuJNSp4MdT0EZn1j\nNHb4yLl8AS0476T/9p0E0YALL3OckIaIa5VsNKV1puV3xMXOzDG4BQ2ulhw7oVm5\n9+3yJ4ftEX72rRLEa78bmzmN5xrnoGRcCGqjwyDtss9pt02j0Ce2sjDLZqy+D0Bw\nJzQ7p68ol9yUzQZQbX1Cwho6lEjyrkfAxhg4GXplxgIpzm6RdE/n5OttbU5WP80I\nrgtWiXHZVxwt0Kz7+jNXzoXyQt7k/IEGSA4AHuQREmdUaGhreNitwE12H3+G9vY3\nBYxWBDAid/gMj4G1vu5XbCmOS/L6spYR+z1G7OglIJYwMnP61KjxlQ+ZyU3CUvo1\nRmF/pigSC0bSlud0i/0LjJhJx3H0zSsJBoSE3KREOxKVlsv7TgIcDopNSDKAfcML\n3LPuFI2Y8PP39ISk+7slWXhK4Oezs58vYKsHZdXghYhUX5PvvoP0JFZkZABwSLQr\ngOXVfIxSNvNUtmYGH7Zf+XYt1bQpVuRq2rYnYGdRVUYxvjhKWilcg+9BelBl+YhF\nJRI/is3gS/DxrugMLJtl6c3RcYwQGUU+Tt1wSOREem5w7hI7D9pqpVofYU9dW7M+\nYzUDiIbC/LzKBmhTtxPNVDGnT+zQPbsj3ahoWhjmkXKP4Uy/ULo8moOiGKSpHhsS\nGmBiwn7SPA1W5lh/vnep7eF7/6gZOntFTGybqPRlJdZD4hxW5gEDB5epLlTWB3SL\nkw6Hxx7a0x2lW3UHsKoFpZnY6Rr+iS71xms9IDTbsvlecqvjN4w5Tb2csI/N7w4I\nL3eUmCGyWoaRCENQiWpYQs2wVr6c/gLGwzFmwBPe4zU9rVPccqoVWIFTAhKITffz\nX+2lrJX/obVb1VJb2l+490VLbUFIm7GRmKWiU4BZmYNluHtijxvGTMp22fqrU4fr\nxio61fZVFnmx76X9wAknTfpdEepKRiw3XZy+VwyzCciS/IuAWreHA/PSlWEJhRuJ\nuNTShghYLyNW3gtcjgXMNhY37gNINBn/v0AOqkvbzJegVQd3CUypPjdLCciUvZVW\nqVNwsMCzVRpdEEaBqp2FWjV7smLhXUh/2HpJnrmTeFfDiJYdjwbTQ7VfqllpMsjZ\nBVTRQMdI5bcfclcuRhXv3Mh4TyLEXT2Xjc9oIP1jx/QO/nJmXR+XNm7iuUzLLV8k\ns/31XHpudPHq7ZAKcquoLHVqAN7BSp74ygUV+wwFumq+wAJtUaAUICGYDSo/XERa\nprpqO9DRQUvwM/wVwhJ1dyL4nDEgpgHkWAImK9F7CGm0mDKnyCdcAZapV0c4LCR2\nWs3qeN4Qe6MYkfSCKKVGzg==\n\n-----END CERTIFICATE-----" first_seen: type: string example: '2024-05-05T01:11:57.000000Z' last_seen: type: string example: '2024-05-16T03:14:42.000000Z' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: ab 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: placeat 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 required: false schema: type: string description: 'Include additional relationships (comma separated).' example: managingCompany nullable: false enum: - company - company.type - company.partner - managingCompany - managingCompany.type - managingCompany.partner responses: 200: description: '' content: application/json: schema: type: object example: data: id: 4944fa3f-51e3-4a92-b9a7-7364ef23a54d company_id: '3198633' managing_company_id: '3198633' first_name: Magdalen last_name: Klocko two_factor_enabled: false email: green.emmy@yahoo.com email_verified_at: '2025-01-30T06:15:35Z' phonenumber: +1-747-512-7190 phonenumber_verified_at: '2025-01-30T06:15:35Z' report_interval: weekly manageable_companies: - id: '3198633' uuid: f8af6fd4-fa98-4d6d-8049-e06ffd557f1a name: Metz-Fahey count_detections: null role: name: norole title: 'No role assigned' abilities: [] need_to_configure_2fa: false terms_agreed_at: '2025-01-30T06:15:35Z' created_at: '2025-01-30T06:15:35Z' updated_at: '2025-01-30T06:15:36Z' links: self: 'http://api.securityhive.io/v1/me' properties: data: type: object properties: id: type: string example: 4944fa3f-51e3-4a92-b9a7-7364ef23a54d company_id: type: string example: '3198633' managing_company_id: type: string example: '3198633' first_name: type: string example: Magdalen last_name: type: string example: Klocko two_factor_enabled: type: boolean example: false email: type: string example: green.emmy@yahoo.com email_verified_at: type: string example: '2025-01-30T06:15:35Z' phonenumber: type: string example: +1-747-512-7190 phonenumber_verified_at: type: string example: '2025-01-30T06:15:35Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '3198633' uuid: f8af6fd4-fa98-4d6d-8049-e06ffd557f1a name: Metz-Fahey count_detections: null items: type: object properties: id: type: string example: '3198633' uuid: type: string example: f8af6fd4-fa98-4d6d-8049-e06ffd557f1a name: type: string example: Metz-Fahey 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 terms_agreed_at: type: string example: '2025-01-30T06:15:35Z' created_at: type: string example: '2025-01-30T06:15:35Z' updated_at: type: string example: '2025-01-30T06:15: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: true content: application/json: schema: type: object properties: first_name: type: string description: 'Must not be greater than 100 characters.' example: John nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: Doe nullable: false 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: jlqnhsvkh nullable: false password: type: string description: 'This field is required when old_password is present. Must not be greater than 255 characters.' example: 'J8Q*"*Y' nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true managing_company_id: type: string description: 'Must be a valid company id the user has access to.' example: '1' nullable: false report_interval: type: string description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.' example: weekly nullable: false terms_agreed_at: type: string description: 'Must be a valid date.' example: '2025-01-30T06:15:36' nullable: false role: type: string description: 'Must be a valid role name.' example: admin nullable: false required: - terms_agreed_at /v1/tags: get: summary: 'List tags.' operationId: listTags description: " Retrieve all tags for the current company. Look at the 'Retrieve a tag' endpoint for more details on the tag object.\n " parameters: - in: query name: 'filter[name]' description: '' example: rerum required: false schema: type: 'Filter by tag name.' description: '' example: rerum nullable: false - in: query name: 'filter[business_impact]' description: '' example: high required: false schema: type: 'Filter by business impact.' description: '' example: high nullable: false - in: query name: 'filter[system_tag]' description: '' example: true required: false schema: type: 'Filter tags that are default.' description: '' example: true nullable: false - in: query name: sort description: '' example: business_impact required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=business_impact' description: '' example: business_impact nullable: false enum: - business_impact - name - created_at - in: query name: include description: '' example: assets required: false schema: type: 'Include additional relationships (comma separated).' description: '' example: assets nullable: false enum: - assets responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 9e170913-aba2-41c9-98be-e5b4c098c2f9 company_id: '1126548' name: 49ca3170-7c35-3c92-a02c-78b47bcdc931 description: 'Accusamus non voluptate possimus aut eos eum qui. Vel ullam voluptatum sed deleniti. Quos rem error aspernatur.' business_impact: high system_tag: false asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-ae32-4928-ac57-a7698bc3eee0 company_id: '8497599' name: 4361da0f-061a-37c2-b41d-f599e2185463 description: 'Quos quo excepturi aut perspiciatis. Porro natus et eos quas consequatur soluta officiis autem.' business_impact: critical system_tag: true asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15: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: 9e170913-aba2-41c9-98be-e5b4c098c2f9 company_id: '1126548' name: 49ca3170-7c35-3c92-a02c-78b47bcdc931 description: 'Accusamus non voluptate possimus aut eos eum qui. Vel ullam voluptatum sed deleniti. Quos rem error aspernatur.' business_impact: high system_tag: false asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' - id: 9e170913-ae32-4928-ac57-a7698bc3eee0 company_id: '8497599' name: 4361da0f-061a-37c2-b41d-f599e2185463 description: 'Quos quo excepturi aut perspiciatis. Porro natus et eos quas consequatur soluta officiis autem.' business_impact: critical system_tag: true asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' items: type: object properties: id: type: string example: 9e170913-aba2-41c9-98be-e5b4c098c2f9 company_id: type: string example: '1126548' name: type: string example: 49ca3170-7c35-3c92-a02c-78b47bcdc931 description: type: string example: 'Accusamus non voluptate possimus aut eos eum qui. Vel ullam voluptatum sed deleniti. Quos rem error aspernatur.' business_impact: type: string example: high system_tag: type: boolean example: false asset_count: type: integer example: 0 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: 9e170913-b332-45fe-8938-849b7abd20b0 company_id: '291377' name: 0de16e71-960b-3019-a24c-94b7fd758e27 description: 'Eaque libero voluptatem occaecati ut ut temporibus ut. Eos dolorum quia quod dolores deleniti. Nobis eaque et ab aut qui ut quae.' business_impact: medium system_tag: true asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' properties: data: type: object properties: id: type: string example: 9e170913-b332-45fe-8938-849b7abd20b0 company_id: type: string example: '291377' name: type: string example: 0de16e71-960b-3019-a24c-94b7fd758e27 description: type: string example: 'Eaque libero voluptatem occaecati ut ut temporibus ut. Eos dolorum quia quod dolores deleniti. Nobis eaque et ab aut qui ut quae.' business_impact: type: string example: medium system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: etnaewru nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Id aut non inventore ducimus.' nullable: false business_impact: type: string description: '' example: high 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: 9e170913-b6cd-4c48-a418-19503221a622 company_id: '9676226' name: 1e5722f0-4301-3d13-afc2-427961e2fe7f description: 'Ea natus est est id qui autem quae. Aliquid nostrum et earum quisquam praesentium culpa nostrum aperiam. Laboriosam accusantium eligendi ea consequatur. Omnis aut impedit aut aliquam.' business_impact: high system_tag: true asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' properties: data: type: object properties: id: type: string example: 9e170913-b6cd-4c48-a418-19503221a622 company_id: type: string example: '9676226' name: type: string example: 1e5722f0-4301-3d13-afc2-427961e2fe7f description: type: string example: 'Ea natus est est id qui autem quae. Aliquid nostrum et earum quisquam praesentium culpa nostrum aperiam. Laboriosam accusantium eligendi ea consequatur. Omnis aut impedit aut aliquam.' business_impact: type: string example: high system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: 9e170913-bb24-4fdb-89a9-0112d42da21b company_id: '6060002' name: 91141b5c-5b4c-38e0-a7e4-3d24aba2ae64 description: 'Quibusdam qui non facilis facilis nobis. Et nihil et iure et assumenda incidunt. Aut voluptates culpa eos tempora. Voluptatum repellendus ipsum ut ipsum. Accusantium praesentium fuga nobis qui.' business_impact: low system_tag: true asset_count: 0 created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' properties: data: type: object properties: id: type: string example: 9e170913-bb24-4fdb-89a9-0112d42da21b company_id: type: string example: '6060002' name: type: string example: 91141b5c-5b4c-38e0-a7e4-3d24aba2ae64 description: type: string example: 'Quibusdam qui non facilis facilis nobis. Et nihil et iure et assumenda incidunt. Aut voluptates culpa eos tempora. Voluptatum repellendus ipsum ut ipsum. Accusantium praesentium fuga nobis qui.' business_impact: type: string example: low system_tag: type: boolean example: true asset_count: type: integer example: 0 created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: zmcpffuq nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Voluptatem a quia nihil sed aut voluptatem ut.' nullable: false business_impact: type: string description: '' example: critical nullable: false enum: - low - medium - high - critical required: - name - description - business_impact delete: summary: 'Delete tag.' operationId: deleteTag description: "Will delete an existing tag \n " parameters: [] responses: 204: description: 'tag deleted successfully' tags: - Tags parameters: - in: path name: id description: 'The ID of the tag.' example: qui 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 required: false schema: type: string description: 'Include additional relationships (comma separated).' example: company 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: 2b5ad9c5-1698-4436-9be5-67d15d5b5d36 company_id: '8773476' managing_company_id: '8773476' first_name: Paul last_name: Schamberger two_factor_enabled: false email: jacquelyn97@yahoo.com email_verified_at: '2025-01-30T06:15:36.000000Z' phonenumber: +1-972-961-8326 phonenumber_verified_at: '2025-01-30T06:15:36.000000Z' report_interval: weekly manageable_companies: - id: '8773476' uuid: 6393011f-9bdc-41df-97d1-2c82293273dc name: 'McGlynn, Veum and Orn' count_detections: null role: name: norole title: 'No role assigned' terms_agreed_at: '2025-01-30T06:15:36.000000Z' created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 4b1e291a-3bf0-40a9-b366-dfb12b8ee53e company_id: '3696702' managing_company_id: '3696702' first_name: Kaia last_name: Koepp two_factor_enabled: false email: hmclaughlin@schinner.net email_verified_at: '2025-01-30T06:15:36.000000Z' phonenumber: 283.276.6676 phonenumber_verified_at: '2025-01-30T06:15:36.000000Z' report_interval: weekly manageable_companies: - id: '3696702' uuid: 6d514f62-6f7d-4d5e-877d-17f373c1a300 name: 'Howell PLC' count_detections: null role: name: norole title: 'No role assigned' terms_agreed_at: '2025-01-30T06:15:36.000000Z' created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15: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: 2b5ad9c5-1698-4436-9be5-67d15d5b5d36 company_id: '8773476' managing_company_id: '8773476' first_name: Paul last_name: Schamberger two_factor_enabled: false email: jacquelyn97@yahoo.com email_verified_at: '2025-01-30T06:15:36.000000Z' phonenumber: +1-972-961-8326 phonenumber_verified_at: '2025-01-30T06:15:36.000000Z' report_interval: weekly manageable_companies: - id: '8773476' uuid: 6393011f-9bdc-41df-97d1-2c82293273dc name: 'McGlynn, Veum and Orn' count_detections: null role: name: norole title: 'No role assigned' terms_agreed_at: '2025-01-30T06:15:36.000000Z' created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 4b1e291a-3bf0-40a9-b366-dfb12b8ee53e company_id: '3696702' managing_company_id: '3696702' first_name: Kaia last_name: Koepp two_factor_enabled: false email: hmclaughlin@schinner.net email_verified_at: '2025-01-30T06:15:36.000000Z' phonenumber: 283.276.6676 phonenumber_verified_at: '2025-01-30T06:15:36.000000Z' report_interval: weekly manageable_companies: - id: '3696702' uuid: 6d514f62-6f7d-4d5e-877d-17f373c1a300 name: 'Howell PLC' count_detections: null role: name: norole title: 'No role assigned' terms_agreed_at: '2025-01-30T06:15:36.000000Z' created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' items: type: object properties: id: type: string example: 2b5ad9c5-1698-4436-9be5-67d15d5b5d36 company_id: type: string example: '8773476' managing_company_id: type: string example: '8773476' first_name: type: string example: Paul last_name: type: string example: Schamberger two_factor_enabled: type: boolean example: false email: type: string example: jacquelyn97@yahoo.com email_verified_at: type: string example: '2025-01-30T06:15:36.000000Z' phonenumber: type: string example: +1-972-961-8326 phonenumber_verified_at: type: string example: '2025-01-30T06:15:36.000000Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '8773476' uuid: 6393011f-9bdc-41df-97d1-2c82293273dc name: 'McGlynn, Veum and Orn' count_detections: null items: type: object properties: id: type: string example: '8773476' uuid: type: string example: 6393011f-9bdc-41df-97d1-2c82293273dc name: type: string example: 'McGlynn, Veum and Orn' count_detections: type: string example: null role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' terms_agreed_at: type: string example: '2025-01-30T06:15:36.000000Z' created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: zbaboahghq nullable: false last_name: type: string description: 'Must not be greater than 100 characters.' example: otvtnetvrexnpurrzagfvyn nullable: false email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: bogisich.dorcas@example.net nullable: false phonenumber: type: string description: 'Must be a valid phone number.' example: '+31612345678' nullable: true report_interval: type: string description: '' example: weekly 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: 535c8aa3-efdd-4df4-99d6-59120e412306 company_id: '3545090' managing_company_id: '3545090' first_name: Savanah last_name: Grimes two_factor_enabled: false email: evans.kreiger@hotmail.com email_verified_at: '2025-01-30T06:15:36.000000Z' phonenumber: '(951) 394-0803' phonenumber_verified_at: '2025-01-30T06:15:36.000000Z' report_interval: weekly manageable_companies: - id: '3545090' uuid: debec5f1-246d-4262-b3ed-6a4d4bbff889 name: Schimmel-Bayer count_detections: null role: name: norole title: 'No role assigned' terms_agreed_at: '2025-01-30T06:15:36.000000Z' created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' properties: data: type: object properties: id: type: string example: 535c8aa3-efdd-4df4-99d6-59120e412306 company_id: type: string example: '3545090' managing_company_id: type: string example: '3545090' first_name: type: string example: Savanah last_name: type: string example: Grimes two_factor_enabled: type: boolean example: false email: type: string example: evans.kreiger@hotmail.com email_verified_at: type: string example: '2025-01-30T06:15:36.000000Z' phonenumber: type: string example: '(951) 394-0803' phonenumber_verified_at: type: string example: '2025-01-30T06:15:36.000000Z' report_interval: type: string example: weekly manageable_companies: type: array example: - id: '3545090' uuid: debec5f1-246d-4262-b3ed-6a4d4bbff889 name: Schimmel-Bayer count_detections: null items: type: object properties: id: type: string example: '3545090' uuid: type: string example: debec5f1-246d-4262-b3ed-6a4d4bbff889 name: type: string example: Schimmel-Bayer count_detections: type: string example: null role: type: object properties: name: type: string example: norole title: type: string example: 'No role assigned' terms_agreed_at: type: string example: '2025-01-30T06:15:36.000000Z' created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15:36.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: 7be998a9-295b-3fad-91c0-49edd4196ba1 required: true schema: type: string /v1/vulnerabilities: get: summary: 'List vulnerabilities.' operationId: listVulnerabilities description: " Retrieve all vulnerabilities for the current company. Look at the 'Retrieve a vulnerability' endpoint for more details on the vulnerability object.\n " parameters: - in: query name: 'filter[name]' description: '' example: SQL required: false schema: type: 'Filter vulnerabilities by their name' description: '' example: SQL nullable: false - in: query name: 'filter[host]' description: '' example: 192.168.1.1 required: false schema: type: 'Filter vulnerabilities found on host' description: '' example: 192.168.1.1 nullable: false - in: query name: 'filter[hostname]' description: '' example: laptop-1.local required: false schema: type: 'Filter vulnerabilities found on hostname' description: '' example: laptop-1.local nullable: false - in: query name: 'filter[status]' description: '' example: Unresolved required: false schema: type: 'Filter vulnerabilities by their status' description: '' example: Unresolved nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired - in: query name: 'filter[threat]' description: '' example: 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: 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: 9e170913-5f48-4576-a915-b10aeb7ebc46 asset_id: null company_id: '9960916' vulnerability_definition_id: 9e170913-5e6f-46c0-9b06-797e52b29231 vulnerability_definition: id: 9e170913-5e6f-46c0-9b06-797e52b29231 name: 'Est error id eveniet.' description: 'Ea accusantium voluptatibus culpa qui voluptas mollitia. Quod dolores quia laborum enim animi ipsum.' solution: 'Accusamus minima quae eius similique accusamus illum alias qui. Eveniet eligendi quis omnis ut. Itaque cum consectetur rerum sunt suscipit non fugiat.' category: 'Default Credentials' threat_level: Medium definition_type: openvas definition: id: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: '2 via veritatis input' family: '2' reference_urls: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: 'CVE-2015-1705, CVE-2016-4291' solution_type: WorkAround solution_description: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: Medium qod_type: remote_active qod_value: 20 cvss_base_score: 4.4 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' host: 205.146.33.10 hostname: grady.net port: 1433/tcp details: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' status: Resolved first_seen: '2024-01-31T22:19:31.000000Z' last_seen: '2024-05-01T08:19:21.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' name: 'Est error id eveniet.' description: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' cvss_base_score: 4.4 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' qod_type: remote_active qod_value: 20 threat: Medium scanner_id: null scanner_hostname: null plugin: id: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: '2 via veritatis input' family: '2' reference_urls: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: 'CVE-2015-1705, CVE-2016-4291' solution_type: WorkAround solution_description: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: Medium qod_type: remote_active qod_value: 20 - id: 9e170913-641a-4d9f-94ad-53158b583103 asset_id: null company_id: '7723639' vulnerability_definition_id: 9e170913-635f-4ab8-a649-5d9c9fbb34d8 vulnerability_definition: id: 9e170913-635f-4ab8-a649-5d9c9fbb34d8 name: 'Possimus sit fuga quisquam.' description: 'Quia itaque ut dolores inventore. Nesciunt porro aut iste eligendi ratione.' solution: 'Ex quae dolorem expedita perspiciatis. Aut impedit fugiat sed fuga. Ipsam natus voluptate autem eius.' category: '1' threat_level: Critical definition_type: openvas definition: id: 9e170913-62c6-4ba7-8a9a-86805915164c o_id: 53bc4d81-ba92-3bda-80fa-de3c3f9f428b name: '4 affecting similique functionality' family: '4' reference_urls: 'http://hilpert.net/recusandae-et-nihil-officiis-minus-porro, https://powlowski.com/ratione-odio-et-saepe-non-deleniti-ratione-eligendi-consequatur.html' reference_cves: 'CVE-2020-3085, CVE-2020-6365' solution_type: Mitigation solution_description: 'Et vitae voluptatem dolorem dolore itaque et error. Dolor error quaerat quos itaque rem itaque exercitationem ipsa. Porro numquam ut maiores laborum.' summary: 'Aut nam vel dolores dignissimos ipsum. Ducimus placeat voluptatibus quos velit. Voluptatem et culpa ipsum velit fuga velit.' insight: 'Sit sit laborum quis et. Earum tempore quo et quisquam. Aut quo et et. Dolores et illo animi et rerum.' affected: 'Quasi dolore quisquam quae deleniti velit architecto eius. Esse molestias quibusdam quidem totam laboriosam. Praesentium natus iusto dolor officiis sunt. Labore mollitia at maxime nemo.' impact: 'Ea ducimus expedita adipisci ad numquam et. Libero dolores aut minima blanditiis quia. Id quis autem nulla praesentium quia sint cum. Quas molestiae voluptatum eos molestias.' vuldetect: 'Dolorem nesciunt ab officiis sed. Error quis animi ipsa maxime. Tempora sunt beatae ratione consectetur. Modi dolor voluptas numquam aut eaque expedita velit. Sapiente atque fugiat minima maiores. A quos enim harum ad.' priority: Log qod_type: package qod_value: 11 cvss_base_score: 4.7 cvss_base_vector: 'AV:L/AC:H/Au:N/C:N/I:N/A:C' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' host: 176.210.43.178 hostname: botsford.net port: 443/tcp details: 'Ut quasi nisi quia veritatis. Rem debitis et non voluptatem. Dolor ab quod eveniet assumenda neque ut autem.' status: Detected first_seen: '2024-07-10T23:03:44.000000Z' last_seen: '2024-08-29T05:03:35.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' name: 'Possimus sit fuga quisquam.' description: 'Ut quasi nisi quia veritatis. Rem debitis et non voluptatem. Dolor ab quod eveniet assumenda neque ut autem.' cvss_base_score: 4.7 cvss_base_vector: 'AV:L/AC:H/Au:N/C:N/I:N/A:C' qod_type: package qod_value: 11 threat: Critical scanner_id: null scanner_hostname: null plugin: id: 9e170913-62c6-4ba7-8a9a-86805915164c o_id: 53bc4d81-ba92-3bda-80fa-de3c3f9f428b name: '4 affecting similique functionality' family: '4' reference_urls: 'http://hilpert.net/recusandae-et-nihil-officiis-minus-porro, https://powlowski.com/ratione-odio-et-saepe-non-deleniti-ratione-eligendi-consequatur.html' reference_cves: 'CVE-2020-3085, CVE-2020-6365' solution_type: Mitigation solution_description: 'Et vitae voluptatem dolorem dolore itaque et error. Dolor error quaerat quos itaque rem itaque exercitationem ipsa. Porro numquam ut maiores laborum.' summary: 'Aut nam vel dolores dignissimos ipsum. Ducimus placeat voluptatibus quos velit. Voluptatem et culpa ipsum velit fuga velit.' insight: 'Sit sit laborum quis et. Earum tempore quo et quisquam. Aut quo et et. Dolores et illo animi et rerum.' affected: 'Quasi dolore quisquam quae deleniti velit architecto eius. Esse molestias quibusdam quidem totam laboriosam. Praesentium natus iusto dolor officiis sunt. Labore mollitia at maxime nemo.' impact: 'Ea ducimus expedita adipisci ad numquam et. Libero dolores aut minima blanditiis quia. Id quis autem nulla praesentium quia sint cum. Quas molestiae voluptatum eos molestias.' vuldetect: 'Dolorem nesciunt ab officiis sed. Error quis animi ipsa maxime. Tempora sunt beatae ratione consectetur. Modi dolor voluptas numquam aut eaque expedita velit. Sapiente atque fugiat minima maiores. A quos enim harum ad.' priority: Log qod_type: package qod_value: 11 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: 9e170913-5f48-4576-a915-b10aeb7ebc46 asset_id: null company_id: '9960916' vulnerability_definition_id: 9e170913-5e6f-46c0-9b06-797e52b29231 vulnerability_definition: id: 9e170913-5e6f-46c0-9b06-797e52b29231 name: 'Est error id eveniet.' description: 'Ea accusantium voluptatibus culpa qui voluptas mollitia. Quod dolores quia laborum enim animi ipsum.' solution: 'Accusamus minima quae eius similique accusamus illum alias qui. Eveniet eligendi quis omnis ut. Itaque cum consectetur rerum sunt suscipit non fugiat.' category: 'Default Credentials' threat_level: Medium definition_type: openvas definition: id: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: '2 via veritatis input' family: '2' reference_urls: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: 'CVE-2015-1705, CVE-2016-4291' solution_type: WorkAround solution_description: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: Medium qod_type: remote_active qod_value: 20 cvss_base_score: 4.4 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' host: 205.146.33.10 hostname: grady.net port: 1433/tcp details: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' status: Resolved first_seen: '2024-01-31T22:19:31.000000Z' last_seen: '2024-05-01T08:19:21.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' name: 'Est error id eveniet.' description: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' cvss_base_score: 4.4 cvss_base_vector: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' qod_type: remote_active qod_value: 20 threat: Medium scanner_id: null scanner_hostname: null plugin: id: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: '2 via veritatis input' family: '2' reference_urls: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: 'CVE-2015-1705, CVE-2016-4291' solution_type: WorkAround solution_description: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: Medium qod_type: remote_active qod_value: 20 - id: 9e170913-641a-4d9f-94ad-53158b583103 asset_id: null company_id: '7723639' vulnerability_definition_id: 9e170913-635f-4ab8-a649-5d9c9fbb34d8 vulnerability_definition: id: 9e170913-635f-4ab8-a649-5d9c9fbb34d8 name: 'Possimus sit fuga quisquam.' description: 'Quia itaque ut dolores inventore. Nesciunt porro aut iste eligendi ratione.' solution: 'Ex quae dolorem expedita perspiciatis. Aut impedit fugiat sed fuga. Ipsam natus voluptate autem eius.' category: '1' threat_level: Critical definition_type: openvas definition: id: 9e170913-62c6-4ba7-8a9a-86805915164c o_id: 53bc4d81-ba92-3bda-80fa-de3c3f9f428b name: '4 affecting similique functionality' family: '4' reference_urls: 'http://hilpert.net/recusandae-et-nihil-officiis-minus-porro, https://powlowski.com/ratione-odio-et-saepe-non-deleniti-ratione-eligendi-consequatur.html' reference_cves: 'CVE-2020-3085, CVE-2020-6365' solution_type: Mitigation solution_description: 'Et vitae voluptatem dolorem dolore itaque et error. Dolor error quaerat quos itaque rem itaque exercitationem ipsa. Porro numquam ut maiores laborum.' summary: 'Aut nam vel dolores dignissimos ipsum. Ducimus placeat voluptatibus quos velit. Voluptatem et culpa ipsum velit fuga velit.' insight: 'Sit sit laborum quis et. Earum tempore quo et quisquam. Aut quo et et. Dolores et illo animi et rerum.' affected: 'Quasi dolore quisquam quae deleniti velit architecto eius. Esse molestias quibusdam quidem totam laboriosam. Praesentium natus iusto dolor officiis sunt. Labore mollitia at maxime nemo.' impact: 'Ea ducimus expedita adipisci ad numquam et. Libero dolores aut minima blanditiis quia. Id quis autem nulla praesentium quia sint cum. Quas molestiae voluptatum eos molestias.' vuldetect: 'Dolorem nesciunt ab officiis sed. Error quis animi ipsa maxime. Tempora sunt beatae ratione consectetur. Modi dolor voluptas numquam aut eaque expedita velit. Sapiente atque fugiat minima maiores. A quos enim harum ad.' priority: Log qod_type: package qod_value: 11 cvss_base_score: 4.7 cvss_base_vector: 'AV:L/AC:H/Au:N/C:N/I:N/A:C' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' host: 176.210.43.178 hostname: botsford.net port: 443/tcp details: 'Ut quasi nisi quia veritatis. Rem debitis et non voluptatem. Dolor ab quod eveniet assumenda neque ut autem.' status: Detected first_seen: '2024-07-10T23:03:44.000000Z' last_seen: '2024-08-29T05:03:35.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' name: 'Possimus sit fuga quisquam.' description: 'Ut quasi nisi quia veritatis. Rem debitis et non voluptatem. Dolor ab quod eveniet assumenda neque ut autem.' cvss_base_score: 4.7 cvss_base_vector: 'AV:L/AC:H/Au:N/C:N/I:N/A:C' qod_type: package qod_value: 11 threat: Critical scanner_id: null scanner_hostname: null plugin: id: 9e170913-62c6-4ba7-8a9a-86805915164c o_id: 53bc4d81-ba92-3bda-80fa-de3c3f9f428b name: '4 affecting similique functionality' family: '4' reference_urls: 'http://hilpert.net/recusandae-et-nihil-officiis-minus-porro, https://powlowski.com/ratione-odio-et-saepe-non-deleniti-ratione-eligendi-consequatur.html' reference_cves: 'CVE-2020-3085, CVE-2020-6365' solution_type: Mitigation solution_description: 'Et vitae voluptatem dolorem dolore itaque et error. Dolor error quaerat quos itaque rem itaque exercitationem ipsa. Porro numquam ut maiores laborum.' summary: 'Aut nam vel dolores dignissimos ipsum. Ducimus placeat voluptatibus quos velit. Voluptatem et culpa ipsum velit fuga velit.' insight: 'Sit sit laborum quis et. Earum tempore quo et quisquam. Aut quo et et. Dolores et illo animi et rerum.' affected: 'Quasi dolore quisquam quae deleniti velit architecto eius. Esse molestias quibusdam quidem totam laboriosam. Praesentium natus iusto dolor officiis sunt. Labore mollitia at maxime nemo.' impact: 'Ea ducimus expedita adipisci ad numquam et. Libero dolores aut minima blanditiis quia. Id quis autem nulla praesentium quia sint cum. Quas molestiae voluptatum eos molestias.' vuldetect: 'Dolorem nesciunt ab officiis sed. Error quis animi ipsa maxime. Tempora sunt beatae ratione consectetur. Modi dolor voluptas numquam aut eaque expedita velit. Sapiente atque fugiat minima maiores. A quos enim harum ad.' priority: Log qod_type: package qod_value: 11 items: type: object properties: id: type: string example: 9e170913-5f48-4576-a915-b10aeb7ebc46 asset_id: type: string example: null company_id: type: string example: '9960916' vulnerability_definition_id: type: string example: 9e170913-5e6f-46c0-9b06-797e52b29231 vulnerability_definition: type: object properties: id: type: string example: 9e170913-5e6f-46c0-9b06-797e52b29231 name: type: string example: 'Est error id eveniet.' description: type: string example: 'Ea accusantium voluptatibus culpa qui voluptas mollitia. Quod dolores quia laborum enim animi ipsum.' solution: type: string example: 'Accusamus minima quae eius similique accusamus illum alias qui. Eveniet eligendi quis omnis ut. Itaque cum consectetur rerum sunt suscipit non fugiat.' category: type: string example: 'Default Credentials' threat_level: type: string example: Medium definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: type: string example: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: type: string example: '2 via veritatis input' family: type: string example: '2' reference_urls: type: string example: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: type: string example: 'CVE-2015-1705, CVE-2016-4291' solution_type: type: string example: WorkAround solution_description: type: string example: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: type: string example: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: type: string example: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: type: string example: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: type: string example: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: type: string example: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: type: string example: Medium qod_type: type: string example: remote_active qod_value: type: integer example: 20 cvss_base_score: type: number example: 4.4 cvss_base_vector: type: string example: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15:37.000000Z' host: type: string example: 205.146.33.10 hostname: type: string example: grady.net port: type: string example: 1433/tcp details: type: string example: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' status: type: string example: Resolved first_seen: type: string example: '2024-01-31T22:19:31.000000Z' last_seen: type: string example: '2024-05-01T08:19:21.000000Z' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15:37.000000Z' name: type: string example: 'Est error id eveniet.' description: type: string example: 'Nihil officia doloremque eius mollitia rem. Non aliquam delectus quasi similique delectus eum esse maiores. Et illum aliquam reiciendis.' cvss_base_score: type: number example: 4.4 cvss_base_vector: type: string example: 'AV:P/AC:H/Au:M/C:P/I:P/A:P' qod_type: type: string example: remote_active qod_value: type: integer example: 20 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: 9e170913-5a23-4778-9ed9-7d821cb6d058 o_id: type: string example: 50dd44ac-7333-3f74-9a3d-b22ef0b59f04 name: type: string example: '2 via veritatis input' family: type: string example: '2' reference_urls: type: string example: 'http://www.terry.com/et-totam-nesciunt-rerum-ullam, http://hansen.com/' reference_cves: type: string example: 'CVE-2015-1705, CVE-2016-4291' solution_type: type: string example: WorkAround solution_description: type: string example: 'Qui mollitia et voluptas expedita ut natus repellat cupiditate. Voluptatem modi delectus animi et fugit porro vel.' summary: type: string example: 'Ut atque nesciunt vel dolores. Dolores quae qui atque illum aut. Molestiae non ipsa quisquam. Sequi nobis a quisquam quis cum quis. Velit quo alias provident quod temporibus. Ut in odit et quam. Quia vitae vel aut enim quia quam et.' insight: type: string example: 'Dolor consequatur unde nam dolorum necessitatibus. Maiores quos suscipit laboriosam et sit. Ad aut hic aut nihil. Natus eos ipsum itaque doloribus praesentium voluptates. Provident quam tempore illo sint unde placeat nisi et.' affected: type: string example: 'Delectus inventore aut excepturi nostrum. Eos fugit est nisi porro suscipit ut. Omnis aut explicabo eius molestias veniam.' impact: type: string example: 'Laboriosam eligendi saepe quia temporibus nisi voluptatem. Dolorem dolorum ipsam labore excepturi ipsam exercitationem. Eligendi ut saepe molestiae est sunt neque praesentium.' vuldetect: type: string example: 'Et aut recusandae et. Harum perspiciatis similique sit nam laboriosam ullam omnis atque. Distinctio excepturi quae aut sunt ut recusandae et. Enim ad voluptatem aut voluptas.' priority: type: string example: Medium qod_type: type: string example: remote_active qod_value: type: integer example: 20 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: ndp 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: jaadpywgfnigsybcivuoogt nullable: false hostname: type: string description: 'Must not be greater than 255 characters.' example: raozwbm nullable: false status: type: string description: '' example: Detected nullable: false enum: - Resolved - Unresolved - Accepted - Detected - Expired scan_id: type: string description: 'Must be a valid UUID.' example: d0ce43f5-9643-3ba6-a516-6bc06f7e8124 nullable: false per_page: type: integer description: 'Must be at least 1. Must not be greater than 200.' example: 24 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: High required: false schema: type: 'Filter vulnerabilities by their threat level' description: '' example: High nullable: false enum: - Log - Low - Medium - High - Critical - in: query name: 'filter[scan_id]' description: '' example: '123' required: false schema: type: 'Filter vulnerabilities found by given scan_id' description: '' example: '123' nullable: false - in: query name: 'filter[family]' description: '' example: 'SQL Injection' required: false schema: type: 'Filter vulnerabilities by their family' description: '' example: 'SQL Injection' nullable: false - in: query name: sort description: '' example: cvss_base_score required: false schema: type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name' description: '' example: cvss_base_score nullable: false enum: - name - port - cvss_base_score - 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: oykhfqnmnnsirwslcutqjhq nullable: false threat_level: type: string description: '' example: High nullable: false enum: - Log - Low - Medium - High - Critical host: type: string description: 'Must not be greater than 255 characters.' example: hxzaihsdrqb nullable: false hostname: type: string description: 'Must not be greater than 255 characters.' example: wfoshtcspalzidu 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: 8d384806-e51d-3fd0-a19a-41919270c571 nullable: false per_page: type: integer description: 'Must be at least 1. Must not be greater than 200.' example: 14 nullable: false type: type: string description: '' example: xlsx 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: 9e170913-7323-4419-ac43-e905b52dea5b asset_id: null company_id: '477672' vulnerability_definition_id: 9e170913-7286-4c67-b37e-3eeef258639f vulnerability_definition: id: 9e170913-7286-4c67-b37e-3eeef258639f name: 'Illum debitis.' description: 'In explicabo impedit ullam exercitationem. Ipsum et nesciunt porro et nobis occaecati. Aliquam sunt molestiae aut reprehenderit inventore.' solution: 'Quo nostrum necessitatibus quam sint. Quia qui natus hic molestiae omnis ullam id. Quia et voluptates cum sint.' category: 'Stack Overflow' threat_level: Medium definition_type: openvas definition: id: 9e170913-71d1-4d9c-a7b0-01fb4505a2b1 o_id: 416a72d3-c9dc-32ad-8440-8fb70dd570fb name: 'Weak Passwords affecting est functionality' family: 'Weak Passwords' reference_urls: 'https://koepp.com/voluptatibus-vel-nihil-harum.html, http://www.pouros.com/maxime-quisquam-illo-nesciunt-quo-veniam-fugit' reference_cves: 'CVE-2018-8861, CVE-2015-8750' solution_type: Mitigation solution_description: 'Repellendus dolorem nobis voluptas unde earum nihil aut. Aut harum voluptatem rerum voluptatem. Quod et aut est iure illum sequi. Quo consequuntur quo deserunt ea placeat culpa.' summary: 'Consequatur perferendis rerum repellat voluptatem minus sit a. Exercitationem nobis consequuntur ex dicta quidem voluptas. Eius iusto nesciunt aut magni et.' insight: 'Dolorum ut quia excepturi commodi nihil corrupti aspernatur. Quam molestias repellat explicabo doloribus. Excepturi labore minima maxime aperiam quaerat qui. Ullam ea eius ut iure.' affected: 'Maxime corrupti et doloremque reiciendis nulla temporibus. Voluptate aut autem in consectetur totam est minus. Atque vitae officiis quia voluptas id voluptatem consequatur. Est est et ipsum minus. Vitae quod et rem molestiae quia.' impact: 'Occaecati dolorum doloremque ut et quam facilis et. Esse occaecati et quia voluptate quis molestiae. Ab sequi eum qui quo nulla. Exercitationem voluptatibus aut rem unde quibusdam repudiandae.' vuldetect: 'Adipisci recusandae aspernatur voluptas quos et illo consequatur. Numquam eaque tempore sed voluptatibus impedit praesentium quia sed. Officiis aut ut ex est aut repellendus eveniet.' priority: Medium qod_type: exploit qod_value: 50 cvss_base_score: 1.7 cvss_base_vector: 'AV:P/AC:H/Au:N/C:C/I:N/A:N' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' host: 38.160.53.125 hostname: kertzmann.com port: 5432/tcp details: 'Ipsum eos odio atque esse minus labore dolorem. Placeat consequatur ab ratione molestias. Quis voluptas aliquam a. Molestiae alias at beatae qui non. Sapiente in est sed in.' status: Detected first_seen: '2025-01-10T02:36:29.000000Z' last_seen: '2025-01-11T05:07:57.000000Z' created_at: '2025-01-30T06:15:37.000000Z' updated_at: '2025-01-30T06:15:37.000000Z' name: 'Illum debitis.' description: 'Ipsum eos odio atque esse minus labore dolorem. Placeat consequatur ab ratione molestias. Quis voluptas aliquam a. Molestiae alias at beatae qui non. Sapiente in est sed in.' cvss_base_score: 1.7 cvss_base_vector: 'AV:P/AC:H/Au:N/C:C/I:N/A:N' qod_type: exploit qod_value: 50 threat: Medium scanner_id: null scanner_hostname: null plugin: id: 9e170913-71d1-4d9c-a7b0-01fb4505a2b1 o_id: 416a72d3-c9dc-32ad-8440-8fb70dd570fb name: 'Weak Passwords affecting est functionality' family: 'Weak Passwords' reference_urls: 'https://koepp.com/voluptatibus-vel-nihil-harum.html, http://www.pouros.com/maxime-quisquam-illo-nesciunt-quo-veniam-fugit' reference_cves: 'CVE-2018-8861, CVE-2015-8750' solution_type: Mitigation solution_description: 'Repellendus dolorem nobis voluptas unde earum nihil aut. Aut harum voluptatem rerum voluptatem. Quod et aut est iure illum sequi. Quo consequuntur quo deserunt ea placeat culpa.' summary: 'Consequatur perferendis rerum repellat voluptatem minus sit a. Exercitationem nobis consequuntur ex dicta quidem voluptas. Eius iusto nesciunt aut magni et.' insight: 'Dolorum ut quia excepturi commodi nihil corrupti aspernatur. Quam molestias repellat explicabo doloribus. Excepturi labore minima maxime aperiam quaerat qui. Ullam ea eius ut iure.' affected: 'Maxime corrupti et doloremque reiciendis nulla temporibus. Voluptate aut autem in consectetur totam est minus. Atque vitae officiis quia voluptas id voluptatem consequatur. Est est et ipsum minus. Vitae quod et rem molestiae quia.' impact: 'Occaecati dolorum doloremque ut et quam facilis et. Esse occaecati et quia voluptate quis molestiae. Ab sequi eum qui quo nulla. Exercitationem voluptatibus aut rem unde quibusdam repudiandae.' vuldetect: 'Adipisci recusandae aspernatur voluptas quos et illo consequatur. Numquam eaque tempore sed voluptatibus impedit praesentium quia sed. Officiis aut ut ex est aut repellendus eveniet.' priority: Medium qod_type: exploit qod_value: 50 properties: data: type: object properties: id: type: string example: 9e170913-7323-4419-ac43-e905b52dea5b asset_id: type: string example: null company_id: type: string example: '477672' vulnerability_definition_id: type: string example: 9e170913-7286-4c67-b37e-3eeef258639f vulnerability_definition: type: object properties: id: type: string example: 9e170913-7286-4c67-b37e-3eeef258639f name: type: string example: 'Illum debitis.' description: type: string example: 'In explicabo impedit ullam exercitationem. Ipsum et nesciunt porro et nobis occaecati. Aliquam sunt molestiae aut reprehenderit inventore.' solution: type: string example: 'Quo nostrum necessitatibus quam sint. Quia qui natus hic molestiae omnis ullam id. Quia et voluptates cum sint.' category: type: string example: 'Stack Overflow' threat_level: type: string example: Medium definition_type: type: string example: openvas definition: type: object properties: id: type: string example: 9e170913-71d1-4d9c-a7b0-01fb4505a2b1 o_id: type: string example: 416a72d3-c9dc-32ad-8440-8fb70dd570fb name: type: string example: 'Weak Passwords affecting est functionality' family: type: string example: 'Weak Passwords' reference_urls: type: string example: 'https://koepp.com/voluptatibus-vel-nihil-harum.html, http://www.pouros.com/maxime-quisquam-illo-nesciunt-quo-veniam-fugit' reference_cves: type: string example: 'CVE-2018-8861, CVE-2015-8750' solution_type: type: string example: Mitigation solution_description: type: string example: 'Repellendus dolorem nobis voluptas unde earum nihil aut. Aut harum voluptatem rerum voluptatem. Quod et aut est iure illum sequi. Quo consequuntur quo deserunt ea placeat culpa.' summary: type: string example: 'Consequatur perferendis rerum repellat voluptatem minus sit a. Exercitationem nobis consequuntur ex dicta quidem voluptas. Eius iusto nesciunt aut magni et.' insight: type: string example: 'Dolorum ut quia excepturi commodi nihil corrupti aspernatur. Quam molestias repellat explicabo doloribus. Excepturi labore minima maxime aperiam quaerat qui. Ullam ea eius ut iure.' affected: type: string example: 'Maxime corrupti et doloremque reiciendis nulla temporibus. Voluptate aut autem in consectetur totam est minus. Atque vitae officiis quia voluptas id voluptatem consequatur. Est est et ipsum minus. Vitae quod et rem molestiae quia.' impact: type: string example: 'Occaecati dolorum doloremque ut et quam facilis et. Esse occaecati et quia voluptate quis molestiae. Ab sequi eum qui quo nulla. Exercitationem voluptatibus aut rem unde quibusdam repudiandae.' vuldetect: type: string example: 'Adipisci recusandae aspernatur voluptas quos et illo consequatur. Numquam eaque tempore sed voluptatibus impedit praesentium quia sed. Officiis aut ut ex est aut repellendus eveniet.' priority: type: string example: Medium qod_type: type: string example: exploit qod_value: type: integer example: 50 cvss_base_score: type: number example: 1.7 cvss_base_vector: type: string example: 'AV:P/AC:H/Au:N/C:C/I:N/A:N' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15:37.000000Z' host: type: string example: 38.160.53.125 hostname: type: string example: kertzmann.com port: type: string example: 5432/tcp details: type: string example: 'Ipsum eos odio atque esse minus labore dolorem. Placeat consequatur ab ratione molestias. Quis voluptas aliquam a. Molestiae alias at beatae qui non. Sapiente in est sed in.' status: type: string example: Detected first_seen: type: string example: '2025-01-10T02:36:29.000000Z' last_seen: type: string example: '2025-01-11T05:07:57.000000Z' created_at: type: string example: '2025-01-30T06:15:37.000000Z' updated_at: type: string example: '2025-01-30T06:15:37.000000Z' name: type: string example: 'Illum debitis.' description: type: string example: 'Ipsum eos odio atque esse minus labore dolorem. Placeat consequatur ab ratione molestias. Quis voluptas aliquam a. Molestiae alias at beatae qui non. Sapiente in est sed in.' cvss_base_score: type: number example: 1.7 cvss_base_vector: type: string example: 'AV:P/AC:H/Au:N/C:C/I:N/A:N' qod_type: type: string example: exploit qod_value: type: integer example: 50 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: 9e170913-71d1-4d9c-a7b0-01fb4505a2b1 o_id: type: string example: 416a72d3-c9dc-32ad-8440-8fb70dd570fb name: type: string example: 'Weak Passwords affecting est functionality' family: type: string example: 'Weak Passwords' reference_urls: type: string example: 'https://koepp.com/voluptatibus-vel-nihil-harum.html, http://www.pouros.com/maxime-quisquam-illo-nesciunt-quo-veniam-fugit' reference_cves: type: string example: 'CVE-2018-8861, CVE-2015-8750' solution_type: type: string example: Mitigation solution_description: type: string example: 'Repellendus dolorem nobis voluptas unde earum nihil aut. Aut harum voluptatem rerum voluptatem. Quod et aut est iure illum sequi. Quo consequuntur quo deserunt ea placeat culpa.' summary: type: string example: 'Consequatur perferendis rerum repellat voluptatem minus sit a. Exercitationem nobis consequuntur ex dicta quidem voluptas. Eius iusto nesciunt aut magni et.' insight: type: string example: 'Dolorum ut quia excepturi commodi nihil corrupti aspernatur. Quam molestias repellat explicabo doloribus. Excepturi labore minima maxime aperiam quaerat qui. Ullam ea eius ut iure.' affected: type: string example: 'Maxime corrupti et doloremque reiciendis nulla temporibus. Voluptate aut autem in consectetur totam est minus. Atque vitae officiis quia voluptas id voluptatem consequatur. Est est et ipsum minus. Vitae quod et rem molestiae quia.' impact: type: string example: 'Occaecati dolorum doloremque ut et quam facilis et. Esse occaecati et quia voluptate quis molestiae. Ab sequi eum qui quo nulla. Exercitationem voluptatibus aut rem unde quibusdam repudiandae.' vuldetect: type: string example: 'Adipisci recusandae aspernatur voluptas quos et illo consequatur. Numquam eaque tempore sed voluptatibus impedit praesentium quia sed. Officiis aut ut ex est aut repellendus eveniet.' priority: type: string example: Medium qod_type: type: string example: exploit qod_value: type: integer example: 50 tags: - Vulnerabilities parameters: - in: path name: id description: 'The ID of the vulnerability.' example: et 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: next_retry_at required: false schema: type: string description: 'Sort the results by column(s) (comma separated).' example: next_retry_at 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: 9e170912-0566-49a4-be6e-f8892ec4ad68 webhook_id: 9e170912-046f-40f2-862b-ba790b93e71f event: impedit payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 9e170912-0968-4b12-9ce9-2c5fe009d964 webhook_id: 9e170912-07cd-49f9-9337-08b2e614e5c8 event: voluptas payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15: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: 9e170912-0566-49a4-be6e-f8892ec4ad68 webhook_id: 9e170912-046f-40f2-862b-ba790b93e71f event: impedit payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 9e170912-0968-4b12-9ce9-2c5fe009d964 webhook_id: 9e170912-07cd-49f9-9337-08b2e614e5c8 event: voluptas payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' items: type: object properties: id: type: string example: 9e170912-0566-49a4-be6e-f8892ec4ad68 webhook_id: type: string example: 9e170912-046f-40f2-862b-ba790b93e71f event: type: string example: impedit payload: type: object properties: key: type: string example: value status: type: string example: pending retries: type: integer example: 0 next_retry_at: type: string example: null last_sent_at: type: string example: null created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: 9e170912-16da-4897-8002-4063e6821f2a webhook_id: 9e170912-1520-415b-af8b-551fb4e5cdbb event: velit payload: key: value status: pending retries: 0 next_retry_at: null last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' properties: data: type: object properties: id: type: string example: 9e170912-16da-4897-8002-4063e6821f2a webhook_id: type: string example: 9e170912-1520-415b-af8b-551fb4e5cdbb event: type: string example: velit payload: type: object properties: key: type: string example: value status: type: string example: pending retries: type: integer example: 0 next_retry_at: type: string example: null last_sent_at: type: string example: null created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: 9e170912-0566-49a4-be6e-f8892ec4ad68 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: 9e170911-e637-432b-b712-0906a14bf11a company_id: 2d2abd72-d84c-4968-93c6-16f79855077b url: 'https://morar.net' description: null events: [] secret: 62bdd51e994b8071cb4e5448dfcdc04ec349b0ecdd8934b0d5d67fe463774ed2 last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 9e170911-eb88-4807-bd7a-16043602c123 company_id: 4d87610d-97ee-46e6-b36d-b1fd71519e03 url: 'https://tromp.com' description: null events: [] secret: aa91435c187f4b30595692f278e6ba3d668adcee7006a7cb8ecc4d5f7bec12ff last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' properties: data: type: array example: - id: 9e170911-e637-432b-b712-0906a14bf11a company_id: 2d2abd72-d84c-4968-93c6-16f79855077b url: 'https://morar.net' description: null events: [] secret: 62bdd51e994b8071cb4e5448dfcdc04ec349b0ecdd8934b0d5d67fe463774ed2 last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' - id: 9e170911-eb88-4807-bd7a-16043602c123 company_id: 4d87610d-97ee-46e6-b36d-b1fd71519e03 url: 'https://tromp.com' description: null events: [] secret: aa91435c187f4b30595692f278e6ba3d668adcee7006a7cb8ecc4d5f7bec12ff last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' items: type: object properties: id: type: string example: 9e170911-e637-432b-b712-0906a14bf11a company_id: type: string example: 2d2abd72-d84c-4968-93c6-16f79855077b url: type: string example: 'https://morar.net' description: type: string example: null events: type: array example: [] secret: type: string example: 62bdd51e994b8071cb4e5448dfcdc04ec349b0ecdd8934b0d5d67fe463774ed2 last_sent_at: type: string example: null created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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://wolff.org/reprehenderit-quia-quisquam-perferendis-culpa-dolor-et-tempora' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'In aut consectetur nam.' 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: 9e170911-f501-4689-8088-0c6c47ecdd0e company_id: 3f78e972-f2c8-4e30-9874-849c1ae57e8c url: 'https://wuckert.info' description: null events: [] secret: 8531c2f71f70c213357ee944f8d028a755a2ca646876eeedd5b3aa49d66473a9 last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' properties: data: type: object properties: id: type: string example: 9e170911-f501-4689-8088-0c6c47ecdd0e company_id: type: string example: 3f78e972-f2c8-4e30-9874-849c1ae57e8c url: type: string example: 'https://wuckert.info' description: type: string example: null events: type: array example: [] secret: type: string example: 8531c2f71f70c213357ee944f8d028a755a2ca646876eeedd5b3aa49d66473a9 last_sent_at: type: string example: null created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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://cole.com/nobis-nostrum-consectetur-id-et-suscipit-quos' nullable: false description: type: string description: 'Must not be greater than 255 characters.' example: 'Iste delectus a sint quo voluptatem.' 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: 9e170911-e637-432b-b712-0906a14bf11a 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: 9e170911-f912-4533-af7c-e179937f2b45 company_id: 02db0c02-136e-4b84-8245-de2d5548d1c8 url: 'https://lockman.com' description: null events: [] secret: 358e815c48de5addb873b032fcee2eadf550f24a17627adedff3c4e83c5d0b77 last_sent_at: null created_at: '2025-01-30T06:15:36.000000Z' updated_at: '2025-01-30T06:15:36.000000Z' properties: data: type: object properties: id: type: string example: 9e170911-f912-4533-af7c-e179937f2b45 company_id: type: string example: 02db0c02-136e-4b84-8245-de2d5548d1c8 url: type: string example: 'https://lockman.com' description: type: string example: null events: type: array example: [] secret: type: string example: 358e815c48de5addb873b032fcee2eadf550f24a17627adedff3c4e83c5d0b77 last_sent_at: type: string example: null created_at: type: string example: '2025-01-30T06:15:36.000000Z' updated_at: type: string example: '2025-01-30T06:15: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: 9e170911-e637-432b-b712-0906a14bf11a 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: 9e170911-e637-432b-b712-0906a14bf11a 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: []