openapi: 3.0.3
info:
title: 'SecurityHive API Documentation'
description: ''
version: 1.0.0
servers:
-
url: 'https://api.securityhive.io'
tags:
-
name: Applications
description: 'Manage the applications that have been discovered on your assets.'
-
name: Assets
description: 'Manage assets that have been discovered on your network.'
-
name: Certificates
description: 'Manage certificates that have been discovered on your network.'
-
name: Endpoints
description: ''
-
name: Integrations
description: "\nAPIs for managing integrations"
-
name: Me
description: "\nAPIs for managing the authenticated user"
-
name: Tags
description: 'Tags can be used to categorize assets.'
-
name: Users
description: "\nAPIs for managing users"
-
name: Vulnerabilities
description: 'Manage vulnerabilities that have been discovered on your network.'
-
name: 'Webhook Events'
description: "\nAPIs for managing webhook events"
-
name: Webhooks
description: "\nAPIs for managing webhooks"
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting the dashboard and clicking Generate new token at your profile.'
security:
-
default: []
paths:
/v1/applications:
get:
summary: 'List applications.'
operationId: listApplications
description: " Retrieve all applications for the current company. Look at the 'Retrieve an application' endpoint for more details on the application object.\n "
parameters:
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
nullable: false
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
nullable: false
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
nullable: false
-
in: query
name: sort
description: ''
example: vendor
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: vendor
nullable: false
enum:
- cpe
- vendor
- product
- version
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
nullable: false
enum:
- assets
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 9f5db46e-bc20-4505-b71d-9a1143e262ee
cpe: 'cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*'
vendor: Mozilla
product: Bugzilla
version: 19.37.4681
update: hotfix1
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-bda7-4c53-a008-93bc1d30c723
cpe: 'cpe:2.3:a:adobe:photoshop:*:*:*:*:*:*:*:*'
vendor: Adobe
product: Photoshop
version: 18.82.1052
update: build2973
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.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: 9f5db46e-bc20-4505-b71d-9a1143e262ee
cpe: 'cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*'
vendor: Mozilla
product: Bugzilla
version: 19.37.4681
update: hotfix1
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-bda7-4c53-a008-93bc1d30c723
cpe: 'cpe:2.3:a:adobe:photoshop:*:*:*:*:*:*:*:*'
vendor: Adobe
product: Photoshop
version: 18.82.1052
update: build2973
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46e-bc20-4505-b71d-9a1143e262ee
cpe:
type: string
example: 'cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Mozilla
product:
type: string
example: Bugzilla
version:
type: string
example: 19.37.4681
update:
type: string
example: hotfix1
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: product
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: product
nullable: false
enum:
- cpe
- vendor
- product
- version
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: ''
example: csv
nullable: false
enum:
- csv
- xlsx
required:
- type
'/v1/applications/{id}':
get:
summary: 'Retrieve an application.'
operationId: retrieveAnApplication
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
nullable: false
enum:
- assets
responses:
200:
description: 'Successfully retrieved application'
content:
application/json:
schema:
type: object
example:
data:
id: 9f5db46e-c2a1-40d9-a3ac-42a025fa9f78
cpe: 'cpe:2.3:a:ibm:db2:*:*:*:*:*:*:*:*'
vendor: IBM
product: DB2
version: 19.50.7002
update: sp2
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-c2a1-40d9-a3ac-42a025fa9f78
cpe:
type: string
example: 'cpe:2.3:a:ibm:db2:*:*:*:*:*:*:*:*'
vendor:
type: string
example: IBM
product:
type: string
example: DB2
version:
type: string
example: 19.50.7002
update:
type: string
example: sp2
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: sint
required: true
schema:
type: string
/v1/assets:
get:
summary: 'List assets.'
operationId: listAssets
description: " Retrieve all assets for the current company. Look at the 'Retrieve an asset' endpoint for more details on the asset object.\n "
parameters:
-
in: query
name: 'filter[name]'
description: ''
example: Laptop-1
required: false
schema:
type: 'Filter assets by name.'
description: ''
example: Laptop-1
nullable: false
-
in: query
name: 'filter[host]'
description: ''
example: 192.168.1.1
required: false
schema:
type: 'Filter assets by their IP-address.'
description: ''
example: 192.168.1.1
nullable: false
-
in: query
name: 'filter[mac_address]'
description: ''
example: '3A:5E:D6:95:BF'
required: false
schema:
type: 'Filter assets by their MAC-address.'
description: ''
example: '3A:5E:D6:95:BF'
nullable: false
-
in: query
name: 'filter[hostname]'
description: ''
example: laptop-1.local
required: false
schema:
type: 'Filter assets by their hostname.'
description: ''
example: laptop-1.local
nullable: false
-
in: query
name: 'filter[tags][]'
description: ''
example: 'New,Old'
required: false
schema:
type: 'Filter assets by their tags.'
description: ''
example: 'New,Old'
nullable: false
-
in: query
name: 'filter[licensed]'
description: ''
example: 'true,false'
required: false
schema:
type: 'Filter assets by licensed status.'
description: ''
example: 'true,false'
nullable: false
-
in: query
name: sort
description: ''
example: host
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: host
nullable: false
enum:
- name
- host
- last_seen
- licensed
-
in: query
name: include
description: ''
example: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
nullable: false
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 9f5db46e-3ef4-4744-ab55-376232c1a20b
company_id: '8222748'
name: 'Antonio Torphy'
identifier: 39.69.114.59
host: 39.69.114.59
mac_address: null
hostname: friesen.org
operating_system: sit
operating_system_name: porro
first_seen: '1972-10-18T16:31:55.000000Z'
last_seen: '2007-01-15T12:31:12.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-07-31T17:29:57.000000Z'
-
id: 9f5db46e-420e-4e43-aec8-68c182688535
company_id: '2854937'
name: 'Jairo McKenzie'
identifier: '07:4F:7F:35:60:61'
host: 86.8.99.175
mac_address: '07:4F:7F:35:60:61'
hostname: hudson.info
operating_system: provident
operating_system_name: modi
first_seen: '2002-07-30T04:56:15.000000Z'
last_seen: '2008-11-15T11:30:40.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-07-26T08:20:42.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: 9f5db46e-3ef4-4744-ab55-376232c1a20b
company_id: '8222748'
name: 'Antonio Torphy'
identifier: 39.69.114.59
host: 39.69.114.59
mac_address: null
hostname: friesen.org
operating_system: sit
operating_system_name: porro
first_seen: '1972-10-18T16:31:55.000000Z'
last_seen: '2007-01-15T12:31:12.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-07-31T17:29:57.000000Z'
-
id: 9f5db46e-420e-4e43-aec8-68c182688535
company_id: '2854937'
name: 'Jairo McKenzie'
identifier: '07:4F:7F:35:60:61'
host: 86.8.99.175
mac_address: '07:4F:7F:35:60:61'
hostname: hudson.info
operating_system: provident
operating_system_name: modi
first_seen: '2002-07-30T04:56:15.000000Z'
last_seen: '2008-11-15T11:30:40.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-07-26T08:20:42.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46e-3ef4-4744-ab55-376232c1a20b
company_id:
type: string
example: '8222748'
name:
type: string
example: 'Antonio Torphy'
identifier:
type: string
example: 39.69.114.59
host:
type: string
example: 39.69.114.59
mac_address:
type: string
example: null
hostname:
type: string
example: friesen.org
operating_system:
type: string
example: sit
operating_system_name:
type: string
example: porro
first_seen:
type: string
example: '1972-10-18T16:31:55.000000Z'
last_seen:
type: string
example: '2007-01-15T12:31:12.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
scans:
type: array
example: []
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2025-07-31T17:29:57.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:
- 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: 9f5db46e-4a9d-4df3-99be-063b376a994d
company_id: '2954511'
name: 'Alda Schaden'
identifier: '09:49:B1:62:ED:D2'
host: 227.118.60.100
mac_address: '09:49:B1:62:ED:D2'
hostname: gusikowski.biz
operating_system: hic
operating_system_name: et
first_seen: '1998-12-03T05:04:30.000000Z'
last_seen: '1973-09-20T13:56:30.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-07-26T01:15:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-4a9d-4df3-99be-063b376a994d
company_id:
type: string
example: '2954511'
name:
type: string
example: 'Alda Schaden'
identifier:
type: string
example: '09:49:B1:62:ED:D2'
host:
type: string
example: 227.118.60.100
mac_address:
type: string
example: '09:49:B1:62:ED:D2'
hostname:
type: string
example: gusikowski.biz
operating_system:
type: string
example: hic
operating_system_name:
type: string
example: et
first_seen:
type: string
example: '1998-12-03T05:04:30.000000Z'
last_seen:
type: string
example: '1973-09-20T13:56:30.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
scans:
type: array
example: []
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2025-07-26T01:15:55.000000Z'
422:
description: 'duplicate host found'
content:
application/json:
schema:
type: object
example:
message: 'host must be unique'
properties:
message:
type: string
example: 'host must be unique'
tags:
- Assets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: vjgglvfwjgymhwbdhrxpirg
nullable: false
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: consequatur
nullable: false
licensed:
type: boolean
description: ''
example: true
nullable: false
required:
- name
- host
- licensed
/v1/assets/actions:
patch:
summary: 'Bulk asset action.'
operationId: bulkAssetAction
description: "Will perform a bulk action on assets (Add Tags, Remove Tags or delete). \n "
parameters: []
responses:
204:
description: 'bulk action performed successfully'
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: removeTags
nullable: false
enum:
- addTags
- removeTags
- delete
- assignLicense
- removeLicense
id:
type: string
description: ''
example: veniam
nullable: false
data:
type: object
description: ''
example: []
nullable: false
properties:
tags:
type: object
description: ''
example: []
nullable: false
properties: { }
required:
- tags
required:
- action
- id
required:
- data
'/v1/assets/{id}':
get:
summary: 'Retrieve an asset.'
operationId: retrieveAnAsset
description: " Retrieves an asset by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
nullable: false
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: 'Successfully retrieved asset'
content:
application/json:
schema:
type: object
example:
data:
id: 9f5db46e-4f96-48d0-92d4-cec39971cf7b
company_id: '4254766'
name: 'Dr. Chadd Boyer'
identifier: '99:08:89:0C:01:CC'
host: 37.11.161.27
mac_address: '99:08:89:0C:01:CC'
hostname: nolan.biz
operating_system: dolor
operating_system_name: aut
first_seen: '2013-05-08T16:36:02.000000Z'
last_seen: '1973-07-03T17:28:53.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: false
change_license_at: '2025-08-09T17:01:23.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-4f96-48d0-92d4-cec39971cf7b
company_id:
type: string
example: '4254766'
name:
type: string
example: 'Dr. Chadd Boyer'
identifier:
type: string
example: '99:08:89:0C:01:CC'
host:
type: string
example: 37.11.161.27
mac_address:
type: string
example: '99:08:89:0C:01:CC'
hostname:
type: string
example: nolan.biz
operating_system:
type: string
example: dolor
operating_system_name:
type: string
example: aut
first_seen:
type: string
example: '2013-05-08T16:36:02.000000Z'
last_seen:
type: string
example: '1973-07-03T17:28:53.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
scans:
type: array
example: []
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2025-08-09T17:01:23.000000Z'
tags:
- Assets
patch:
summary: 'Update asset.'
operationId: updateAsset
description: "Will update an existing asset \n "
parameters: []
responses:
200:
description: 'Successfully updated asset'
content:
application/json:
schema:
type: object
example:
data:
id: 9f5db46e-551a-43c5-8b0b-f7a7121a341f
company_id: '5769246'
name: 'Rickey Herman'
identifier: '4C:3D:C6:86:8A:58'
host: 206.54.252.53
mac_address: '4C:3D:C6:86:8A:58'
hostname: maggio.net
operating_system: et
operating_system_name: culpa
first_seen: '2003-03-15T07:36:15.000000Z'
last_seen: '2001-06-28T01:35:18.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
scans: []
licensed: true
change_license_at: '2025-08-06T16:08:36.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-551a-43c5-8b0b-f7a7121a341f
company_id:
type: string
example: '5769246'
name:
type: string
example: 'Rickey Herman'
identifier:
type: string
example: '4C:3D:C6:86:8A:58'
host:
type: string
example: 206.54.252.53
mac_address:
type: string
example: '4C:3D:C6:86:8A:58'
hostname:
type: string
example: maggio.net
operating_system:
type: string
example: et
operating_system_name:
type: string
example: culpa
first_seen:
type: string
example: '2003-03-15T07:36:15.000000Z'
last_seen:
type: string
example: '2001-06-28T01:35:18.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
scans:
type: array
example: []
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2025-08-06T16:08:36.000000Z'
422:
description: 'name field is empty'
content:
application/json:
schema:
type: object
example:
message: 'name is required'
properties:
message:
type: string
example: 'name is required'
tags:
- Assets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: ln
nullable: false
licensed:
type: boolean
description: ''
example: true
nullable: false
required:
- name
- licensed
delete:
summary: 'Delete asset.'
operationId: deleteAsset
description: "Will delete an existing asset \n "
parameters: []
responses:
204:
description: 'asset deleted successfully'
tags:
- Assets
parameters:
-
in: path
name: id
description: 'The ID of the asset.'
example: totam
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: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
nullable: false
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 9f5db46e-5d81-467f-a055-76d19c93714c
company_id: '8215197'
common_name: donnelly.com
organization: null
organizational_unit: null
locality: null
state: Colorado
country: MA
serial: 3AXW7DV3EVU1BNOMVVO4PMM9SQRPWETJ
not_valid_before: 20240702T220422Z
not_valid_after: 20260929T222801Z
value: "-----BEGIN CERTIFICATE-----\nqc5NpqExTczmSc5dwrBoBYycEORAOAxJm8FrFoYdKg/brcnGUeBvWWIFeboZZnrT\n2MMWees2Q4gcmJmkw7ODK0Zow+BZatwHPrsIovD8fzM1rveT7Afi9Jl9wqtE5z0a\nT2H4nDayVGWYMj0ow1nTtpw39fWQYvYpsbjc3EGYGkHCeCyb93c+mmK5ees/43cP\n7YftQLZMSe7kGof4/xbVgU3sUv9NG4nHUFslbV9NjTVRgdPAe2fyIq0F/oji+g0r\nYMYPDJhBR0ZsY5pF4djjv22yDfZmP2v5y3jJ2FzgKFUewyfjBGUyhpqHIGCNYaOS\n+yWwFI1jDoCPfhdAD6W14uVr8AkDGw3ANlbM5TFmfaqZbnv9ryssjk92qN07E+ta\n8RrfQEZSHMuVc8HnmFbuaXqqA/zPs1jdUwMZK1XBCbbyG2grLB9b2TEnfXLVvPd6\nS9LQZKXd2vb62T/VQA1qNtvOcMh9MLGvukc8YsH5XnVSVDI/lKg4JqnFk7PEcCzW\nctJ+8JeeYgbVwaoDBtLQAM6VpJdepwj8J/3+49NKrBdaJ2DDv/PCE7ZpfYk8MjQT\nZ5MFMHYEYPzf5CeOnAg2gYPA91g5kwyVRHD5SCITgNeict5ZlM1GRaqmBmG1ouSB\nrXjvnUHLAvS976Vv8GfHMtW4caG1KCQ4ieffQAfHkS1AluzvOX0o/hC59wa+XNYQ\ngArZBFxHu2sKsbzO6329eYit9nY6x3XQITb03yPy3rtHGs7heg97bZ4uC1vRRrXa\nkomcDOnCO2kxqf7u12ck91fKR5Z3YwSSxaRh2CxWcVlpwuCf/IFNIOmw+EdML5XN\n3VL2o3vlQIKiZYozrWw8ra53LyAgbDt8i2la1h8ijuW77G4XsUI+5/+54ZlLfU5j\nFdwcClq1Pr6x+ViC5OifYq7TjOG2AwggO2Qc6extQt6tBW4p37qMcr+pTUIVoQcp\nbu4GdiXXZt6KaSEjWAuCRalw+eTXIJqBnrLKdHQekl+KHaAdYdMm6oL5BQ8v1kuj\ncw+uIkJtISjCkyr9xKizWoNT7RP+pCxs6Y6LDyhbqyQEiwgWjDKG3lD2qVM+C/VK\n5FF0OXUYiKXwkPx3W8yBg/uc+qzUD+CMgRucy4NF8LDbxKB9G42hgX/rzGaT2y0x\naiQ0vH+JoP4YW6uTS8csIFWQHrJwXcL94uuG1JVNK+7isDW0cfVhAx6ukeEDXuRV\nNMnVag/T/2sTUe8oXtOk/Fp0ZqpYhanp8KqkepgMEKAGc9CYIRl5vI9l7iitde7u\n4Gdo3Q96avXYpX10hfPDDhhcTH9DCQBS9xmKzgHQOTXGb/znFaUORsLngK6WK1d2\n6AnIyJyAhKV04EKrF2pGwg==\n\n-----END CERTIFICATE-----"
first_seen: '2025-02-12T09:11:45.000000Z'
last_seen: '2025-06-06T16:33:42.000000Z'
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-929a-4400-a79f-9a1c26867867
company_id: '78872'
common_name: torphy.com
organization: null
organizational_unit: null
locality: Katarinahaven
state: Idaho
country: AW
serial: XR6B3NI0ZNQHRCO8R23KHRBEOQ4VIRCY
not_valid_before: 20240610T110959Z
not_valid_after: 20270226T063857Z
value: "-----BEGIN CERTIFICATE-----\nEy59yZZUEXxUNiWrvZ5kZ+wZQG1sGa6KtGwwIpxixJgXb8VFYLPOgWfRr5zHeFHw\nAjpTD5dKJ5jjROoattb+zIYlJjbu1anxa5Vlg1EIdzpLU6Wlhl7DpDOEv/hBEt9f\nCR1mNnntkLsSbzxkaoKITqGiSZvyItS+ZU84xZW2EVW0Jllac9IZhxpIz7bC+jf2\nBTnDa4HznjLdcSICcMQxL7DW8SM8S143YM9QZ7NwqyaEOan3Ro8U2Qr60Dc5/tMw\ntF3Hu+KDmLjYl3NE0tMDgP+mfNGqEihzqg56hYLF0BK7vvaoFkGN5DkH52BtXcZa\nTXDrm7D7roTBVQGx7YFK2qKlanMVI+FmRHLacG08pkixICSiY9I79T4oGMPebwpG\nccH9ZZ9IjkHAtt5zV7lWAgIwPYoN4X5Xrbgpww6Kkt/2vDjmXsUfsbe7SGI8bH3H\nIES/zP/Bdvhd2OSNQEZ5HdIVq7/cBkSHW7gHF7J56K2rlOPQZok94Ne1K47U0xXy\nbewqmEhQ41Vlj/xqVtlxUPDYU3CCichMIlEevoDjzKq7hopQTjZbrBCTfsrnfVy0\nb2govGRGWpWQBPLF6ejM8aLPkODbbRTKGEcZQHFugwK5uFs9KeNUDSdIK+hM33yW\nxeaF4Vg3tvFpeE7KBoV2pHOKiaeI22EBo9zaBU8fj6IV/iZJQCdKBqxTnmZiupxV\n7cUMIIB5mbubPMXeGXWqkuIDuI9uqlrSApY4ryLZaMiBh07TZrxw+xdvlPU3qvJB\nqmTQlJL3V8opKS2x7Tb1U/cxkM884cZ9Fjbr4Wv/F2SpxOAlANkHQlvZMdOQDkm1\n1NmCvzUTvLR3Rb2ec21/qgW6YDYP90uFc8ty2Whzd4ZvCsl0eOz+xXJJIKsegUnS\ngjw9hjx3NFYP5JsnEp6H4Yo7Ng9EGSDd+i6y7nDcd2XsrTrLLexNPbKr58EJWQhH\nKFt9QD7rMJML+q6fY3S8VLXFbET2UtgcKj/TIZAJcOZMQ89LzYyE1L0vrfuZcWir\n04flCyfV8P3sl4LM3maQGP40ANOzbklHtEkDbxKA+0iKFCL6fuUZv2DKV9CNfVIV\nh5VYP2FAGLot47B/IuD4ni4xOhjtOTJdIkDIjrFd8iSqggv2ffiqL1dVssbGzLKl\ngVd2U5uIV9GlV0Xl2ZqqhSHLoMsLMR3u/u5EtJjOuzhklAz6D3tAZLLgEoAI3mv8\nGVHieODNyO4Hc9c+eyIs3Nx800zFqg4buDmGfYPFbjPJgzEFMTt8cLgznYwxEe5k\n9Xwxlmaqw4ZF1zhbdAhBZ4V6FXSV6FDiltu5K/hbDx8OExtui2iezDTlWZVm8xBB\nNjw53p/urczOYoB6aqPh/A==\n\n-----END CERTIFICATE-----"
first_seen: '2024-07-17T05:45:57.000000Z'
last_seen: '2024-12-07T04:04:47.000000Z'
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.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: 9f5db46e-5d81-467f-a055-76d19c93714c
company_id: '8215197'
common_name: donnelly.com
organization: null
organizational_unit: null
locality: null
state: Colorado
country: MA
serial: 3AXW7DV3EVU1BNOMVVO4PMM9SQRPWETJ
not_valid_before: 20240702T220422Z
not_valid_after: 20260929T222801Z
value: "-----BEGIN CERTIFICATE-----\nqc5NpqExTczmSc5dwrBoBYycEORAOAxJm8FrFoYdKg/brcnGUeBvWWIFeboZZnrT\n2MMWees2Q4gcmJmkw7ODK0Zow+BZatwHPrsIovD8fzM1rveT7Afi9Jl9wqtE5z0a\nT2H4nDayVGWYMj0ow1nTtpw39fWQYvYpsbjc3EGYGkHCeCyb93c+mmK5ees/43cP\n7YftQLZMSe7kGof4/xbVgU3sUv9NG4nHUFslbV9NjTVRgdPAe2fyIq0F/oji+g0r\nYMYPDJhBR0ZsY5pF4djjv22yDfZmP2v5y3jJ2FzgKFUewyfjBGUyhpqHIGCNYaOS\n+yWwFI1jDoCPfhdAD6W14uVr8AkDGw3ANlbM5TFmfaqZbnv9ryssjk92qN07E+ta\n8RrfQEZSHMuVc8HnmFbuaXqqA/zPs1jdUwMZK1XBCbbyG2grLB9b2TEnfXLVvPd6\nS9LQZKXd2vb62T/VQA1qNtvOcMh9MLGvukc8YsH5XnVSVDI/lKg4JqnFk7PEcCzW\nctJ+8JeeYgbVwaoDBtLQAM6VpJdepwj8J/3+49NKrBdaJ2DDv/PCE7ZpfYk8MjQT\nZ5MFMHYEYPzf5CeOnAg2gYPA91g5kwyVRHD5SCITgNeict5ZlM1GRaqmBmG1ouSB\nrXjvnUHLAvS976Vv8GfHMtW4caG1KCQ4ieffQAfHkS1AluzvOX0o/hC59wa+XNYQ\ngArZBFxHu2sKsbzO6329eYit9nY6x3XQITb03yPy3rtHGs7heg97bZ4uC1vRRrXa\nkomcDOnCO2kxqf7u12ck91fKR5Z3YwSSxaRh2CxWcVlpwuCf/IFNIOmw+EdML5XN\n3VL2o3vlQIKiZYozrWw8ra53LyAgbDt8i2la1h8ijuW77G4XsUI+5/+54ZlLfU5j\nFdwcClq1Pr6x+ViC5OifYq7TjOG2AwggO2Qc6extQt6tBW4p37qMcr+pTUIVoQcp\nbu4GdiXXZt6KaSEjWAuCRalw+eTXIJqBnrLKdHQekl+KHaAdYdMm6oL5BQ8v1kuj\ncw+uIkJtISjCkyr9xKizWoNT7RP+pCxs6Y6LDyhbqyQEiwgWjDKG3lD2qVM+C/VK\n5FF0OXUYiKXwkPx3W8yBg/uc+qzUD+CMgRucy4NF8LDbxKB9G42hgX/rzGaT2y0x\naiQ0vH+JoP4YW6uTS8csIFWQHrJwXcL94uuG1JVNK+7isDW0cfVhAx6ukeEDXuRV\nNMnVag/T/2sTUe8oXtOk/Fp0ZqpYhanp8KqkepgMEKAGc9CYIRl5vI9l7iitde7u\n4Gdo3Q96avXYpX10hfPDDhhcTH9DCQBS9xmKzgHQOTXGb/znFaUORsLngK6WK1d2\n6AnIyJyAhKV04EKrF2pGwg==\n\n-----END CERTIFICATE-----"
first_seen: '2025-02-12T09:11:45.000000Z'
last_seen: '2025-06-06T16:33:42.000000Z'
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-929a-4400-a79f-9a1c26867867
company_id: '78872'
common_name: torphy.com
organization: null
organizational_unit: null
locality: Katarinahaven
state: Idaho
country: AW
serial: XR6B3NI0ZNQHRCO8R23KHRBEOQ4VIRCY
not_valid_before: 20240610T110959Z
not_valid_after: 20270226T063857Z
value: "-----BEGIN CERTIFICATE-----\nEy59yZZUEXxUNiWrvZ5kZ+wZQG1sGa6KtGwwIpxixJgXb8VFYLPOgWfRr5zHeFHw\nAjpTD5dKJ5jjROoattb+zIYlJjbu1anxa5Vlg1EIdzpLU6Wlhl7DpDOEv/hBEt9f\nCR1mNnntkLsSbzxkaoKITqGiSZvyItS+ZU84xZW2EVW0Jllac9IZhxpIz7bC+jf2\nBTnDa4HznjLdcSICcMQxL7DW8SM8S143YM9QZ7NwqyaEOan3Ro8U2Qr60Dc5/tMw\ntF3Hu+KDmLjYl3NE0tMDgP+mfNGqEihzqg56hYLF0BK7vvaoFkGN5DkH52BtXcZa\nTXDrm7D7roTBVQGx7YFK2qKlanMVI+FmRHLacG08pkixICSiY9I79T4oGMPebwpG\nccH9ZZ9IjkHAtt5zV7lWAgIwPYoN4X5Xrbgpww6Kkt/2vDjmXsUfsbe7SGI8bH3H\nIES/zP/Bdvhd2OSNQEZ5HdIVq7/cBkSHW7gHF7J56K2rlOPQZok94Ne1K47U0xXy\nbewqmEhQ41Vlj/xqVtlxUPDYU3CCichMIlEevoDjzKq7hopQTjZbrBCTfsrnfVy0\nb2govGRGWpWQBPLF6ejM8aLPkODbbRTKGEcZQHFugwK5uFs9KeNUDSdIK+hM33yW\nxeaF4Vg3tvFpeE7KBoV2pHOKiaeI22EBo9zaBU8fj6IV/iZJQCdKBqxTnmZiupxV\n7cUMIIB5mbubPMXeGXWqkuIDuI9uqlrSApY4ryLZaMiBh07TZrxw+xdvlPU3qvJB\nqmTQlJL3V8opKS2x7Tb1U/cxkM884cZ9Fjbr4Wv/F2SpxOAlANkHQlvZMdOQDkm1\n1NmCvzUTvLR3Rb2ec21/qgW6YDYP90uFc8ty2Whzd4ZvCsl0eOz+xXJJIKsegUnS\ngjw9hjx3NFYP5JsnEp6H4Yo7Ng9EGSDd+i6y7nDcd2XsrTrLLexNPbKr58EJWQhH\nKFt9QD7rMJML+q6fY3S8VLXFbET2UtgcKj/TIZAJcOZMQ89LzYyE1L0vrfuZcWir\n04flCyfV8P3sl4LM3maQGP40ANOzbklHtEkDbxKA+0iKFCL6fuUZv2DKV9CNfVIV\nh5VYP2FAGLot47B/IuD4ni4xOhjtOTJdIkDIjrFd8iSqggv2ffiqL1dVssbGzLKl\ngVd2U5uIV9GlV0Xl2ZqqhSHLoMsLMR3u/u5EtJjOuzhklAz6D3tAZLLgEoAI3mv8\nGVHieODNyO4Hc9c+eyIs3Nx800zFqg4buDmGfYPFbjPJgzEFMTt8cLgznYwxEe5k\n9Xwxlmaqw4ZF1zhbdAhBZ4V6FXSV6FDiltu5K/hbDx8OExtui2iezDTlWZVm8xBB\nNjw53p/urczOYoB6aqPh/A==\n\n-----END CERTIFICATE-----"
first_seen: '2024-07-17T05:45:57.000000Z'
last_seen: '2024-12-07T04:04:47.000000Z'
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46e-5d81-467f-a055-76d19c93714c
company_id:
type: string
example: '8215197'
common_name:
type: string
example: donnelly.com
organization:
type: string
example: null
organizational_unit:
type: string
example: null
locality:
type: string
example: null
state:
type: string
example: Colorado
country:
type: string
example: MA
serial:
type: string
example: 3AXW7DV3EVU1BNOMVVO4PMM9SQRPWETJ
not_valid_before:
type: string
example: 20240702T220422Z
not_valid_after:
type: string
example: 20260929T222801Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nqc5NpqExTczmSc5dwrBoBYycEORAOAxJm8FrFoYdKg/brcnGUeBvWWIFeboZZnrT\n2MMWees2Q4gcmJmkw7ODK0Zow+BZatwHPrsIovD8fzM1rveT7Afi9Jl9wqtE5z0a\nT2H4nDayVGWYMj0ow1nTtpw39fWQYvYpsbjc3EGYGkHCeCyb93c+mmK5ees/43cP\n7YftQLZMSe7kGof4/xbVgU3sUv9NG4nHUFslbV9NjTVRgdPAe2fyIq0F/oji+g0r\nYMYPDJhBR0ZsY5pF4djjv22yDfZmP2v5y3jJ2FzgKFUewyfjBGUyhpqHIGCNYaOS\n+yWwFI1jDoCPfhdAD6W14uVr8AkDGw3ANlbM5TFmfaqZbnv9ryssjk92qN07E+ta\n8RrfQEZSHMuVc8HnmFbuaXqqA/zPs1jdUwMZK1XBCbbyG2grLB9b2TEnfXLVvPd6\nS9LQZKXd2vb62T/VQA1qNtvOcMh9MLGvukc8YsH5XnVSVDI/lKg4JqnFk7PEcCzW\nctJ+8JeeYgbVwaoDBtLQAM6VpJdepwj8J/3+49NKrBdaJ2DDv/PCE7ZpfYk8MjQT\nZ5MFMHYEYPzf5CeOnAg2gYPA91g5kwyVRHD5SCITgNeict5ZlM1GRaqmBmG1ouSB\nrXjvnUHLAvS976Vv8GfHMtW4caG1KCQ4ieffQAfHkS1AluzvOX0o/hC59wa+XNYQ\ngArZBFxHu2sKsbzO6329eYit9nY6x3XQITb03yPy3rtHGs7heg97bZ4uC1vRRrXa\nkomcDOnCO2kxqf7u12ck91fKR5Z3YwSSxaRh2CxWcVlpwuCf/IFNIOmw+EdML5XN\n3VL2o3vlQIKiZYozrWw8ra53LyAgbDt8i2la1h8ijuW77G4XsUI+5/+54ZlLfU5j\nFdwcClq1Pr6x+ViC5OifYq7TjOG2AwggO2Qc6extQt6tBW4p37qMcr+pTUIVoQcp\nbu4GdiXXZt6KaSEjWAuCRalw+eTXIJqBnrLKdHQekl+KHaAdYdMm6oL5BQ8v1kuj\ncw+uIkJtISjCkyr9xKizWoNT7RP+pCxs6Y6LDyhbqyQEiwgWjDKG3lD2qVM+C/VK\n5FF0OXUYiKXwkPx3W8yBg/uc+qzUD+CMgRucy4NF8LDbxKB9G42hgX/rzGaT2y0x\naiQ0vH+JoP4YW6uTS8csIFWQHrJwXcL94uuG1JVNK+7isDW0cfVhAx6ukeEDXuRV\nNMnVag/T/2sTUe8oXtOk/Fp0ZqpYhanp8KqkepgMEKAGc9CYIRl5vI9l7iitde7u\n4Gdo3Q96avXYpX10hfPDDhhcTH9DCQBS9xmKzgHQOTXGb/znFaUORsLngK6WK1d2\n6AnIyJyAhKV04EKrF2pGwg==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2025-02-12T09:11:45.000000Z'
last_seen:
type: string
example: '2025-06-06T16:33:42.000000Z'
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Certificates
/v1/certificates/export:
get:
summary: 'Export certificates.'
operationId: exportCertificates
description: " Export all certificates for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: xlsx
required: true
schema:
type: 'The type of export to generate'
description: ''
example: xlsx
nullable: false
enum:
- csv
- xlsx
-
in: query
name: 'filter[common_name]'
description: ''
example: test.nl
required: false
schema:
type: 'Filter certificates by their common name.'
description: ''
example: test.nl
nullable: false
-
in: query
name: 'filter[organization]'
description: ''
example: 'Test B.V.'
required: false
schema:
type: 'Filter certificates by their organization name.'
description: ''
example: 'Test B.V.'
nullable: false
-
in: query
name: sort
description: ''
example: not_valid_after
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before'
description: ''
example: not_valid_after
nullable: false
enum:
- not_valid_after
-
in: query
name: filter
description: ''
example: 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: 9f5db46e-9a19-45de-bb3f-7ea8df1d9263
company_id: '6882023'
common_name: rice.com
organization: Aufderhar-Ruecker
organizational_unit: LLC
locality: Weissnatmouth
state: Louisiana
country: GA
serial: LJFDVPBL7VWDYNHUEGMNHGR8SDNAVZA6
not_valid_before: 20230807T011337Z
not_valid_after: 20270325T054547Z
value: "-----BEGIN CERTIFICATE-----\nNvzb+ixXjnmm84R0NtoV4rWJTErRBGXW1/nqw4/DR5Faj0BtfjrbGEq6uas31tFg\nXtXcUud5e64HuB1eU/h/Of0k7MYDZOnQY7iDtRfh9cFQy64z+UQAqbqZQDe7GcPx\ntNUjOci0FvPbeYFKghPKwb6A0lb7iY7tC6om9Uq+IWjQ+AgwD498lqeTe1e4O07M\ni0i0iGCQuCVanvKhOxXQ0KdMVXennhZDp8jgDFBS1tJdpvWF/5vfdcUFKX+0hLnP\nORGmBmUt+xB06GjtyhMQ6YRAPPmKRNTrWkNmYfST5Yp0AUYpznPC7bByjpq6ot8i\nJLr0LJgZaYJQ0W+XL9nP0Ql0/lbhFzVt/67t4hvfKHBwTJLtOySWhL7JvP2YGWwC\n/ifxyKJKcDU+/BPawPh0AEwI8C5pxzwqx0YKy/TxbNSSjAZxOZ4QNZUseN4kN/LI\nxyt/9AugAyum0GxDVHkWLtuIKaLkXDkJTCevEylnc6cvBfOAbP6gOMEPGWeO6IvB\n8Uf9u1kKJnUItywIyJyvHeXMGYOFiZwfLX94jdkG34Um2w8vpumF1mvbWgmMSYW6\nUO3fwNlFbas4W7x7afe/OJB+Fi/klseNGX/fZ3wwSkJDVdU8CYN7xnUzkw/CE5t3\nCB8Xpk0hHZgYxTk6HXDkJqyiXAH1YOyyvl8DnLw9B//oDm18yXwucmlYsSuiX/Rb\nmhHBI3+uvCVNIKzTEdDoZuHjHzmeMNQ85KosWmgLzq1RPlUTtjKLG6dRwtXuYZot\nuTTtzEnvErTkJCYBClwlJUnPW0beOUZosm5tdG/iBAzUSv63pjdO3yhcTv1s9bZc\nEEiGkYO3zQgSDkXBjzl5ElL4ZXliiHdDJN0suky9R9F5M1F6+hHO7ctiULbxzxcS\nb8kheBmC6n2pBGkOoFGTDvSVpyo6n6yF/HGY2K3WxodwuWDSkzOLG3fMa8IzwJhF\ngfQE8zpvhnE0DwzSuimQKMUZCtvh28MYRW2yOO7tL3sAmqoKw21Pg1xocFqaYGWP\nZpQvcBL9t0QIg4JUbenN2K9GO3fxSySYjgj02nYeUVb2WcykYfNckCnghrNiCLnF\nApjz51CqhJ0k5e/5krRKE+Lzs8mxgvfhBDnLRrjLD+jPxUKaHhUs7+0tbqOyafbM\nxlGZDaEL2EOGPSzSnu/vtBkCJYOTiVZYF+kwEyTpRahP4o5sSlfOKLrXLfJxIiaR\naCbhTTPbkDA5yW9cZfBjZtNTfZzXBmAmOrwylUn2NkFAsfHpdDv522zGJDeUF1lQ\ntquzdGnfttmPRH2RTwH8EjVCOVe7+neNMWj6VaiFztdZ6b48y3E9WOW8Qcv8pHHJ\nQBWqUTcQi2ZlmSz9PxEeBQ==\n\n-----END CERTIFICATE-----"
first_seen: '2023-09-19T21:45:45.000000Z'
last_seen: '2024-08-12T01:51:53.000000Z'
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-9a19-45de-bb3f-7ea8df1d9263
company_id:
type: string
example: '6882023'
common_name:
type: string
example: rice.com
organization:
type: string
example: Aufderhar-Ruecker
organizational_unit:
type: string
example: LLC
locality:
type: string
example: Weissnatmouth
state:
type: string
example: Louisiana
country:
type: string
example: GA
serial:
type: string
example: LJFDVPBL7VWDYNHUEGMNHGR8SDNAVZA6
not_valid_before:
type: string
example: 20230807T011337Z
not_valid_after:
type: string
example: 20270325T054547Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nNvzb+ixXjnmm84R0NtoV4rWJTErRBGXW1/nqw4/DR5Faj0BtfjrbGEq6uas31tFg\nXtXcUud5e64HuB1eU/h/Of0k7MYDZOnQY7iDtRfh9cFQy64z+UQAqbqZQDe7GcPx\ntNUjOci0FvPbeYFKghPKwb6A0lb7iY7tC6om9Uq+IWjQ+AgwD498lqeTe1e4O07M\ni0i0iGCQuCVanvKhOxXQ0KdMVXennhZDp8jgDFBS1tJdpvWF/5vfdcUFKX+0hLnP\nORGmBmUt+xB06GjtyhMQ6YRAPPmKRNTrWkNmYfST5Yp0AUYpznPC7bByjpq6ot8i\nJLr0LJgZaYJQ0W+XL9nP0Ql0/lbhFzVt/67t4hvfKHBwTJLtOySWhL7JvP2YGWwC\n/ifxyKJKcDU+/BPawPh0AEwI8C5pxzwqx0YKy/TxbNSSjAZxOZ4QNZUseN4kN/LI\nxyt/9AugAyum0GxDVHkWLtuIKaLkXDkJTCevEylnc6cvBfOAbP6gOMEPGWeO6IvB\n8Uf9u1kKJnUItywIyJyvHeXMGYOFiZwfLX94jdkG34Um2w8vpumF1mvbWgmMSYW6\nUO3fwNlFbas4W7x7afe/OJB+Fi/klseNGX/fZ3wwSkJDVdU8CYN7xnUzkw/CE5t3\nCB8Xpk0hHZgYxTk6HXDkJqyiXAH1YOyyvl8DnLw9B//oDm18yXwucmlYsSuiX/Rb\nmhHBI3+uvCVNIKzTEdDoZuHjHzmeMNQ85KosWmgLzq1RPlUTtjKLG6dRwtXuYZot\nuTTtzEnvErTkJCYBClwlJUnPW0beOUZosm5tdG/iBAzUSv63pjdO3yhcTv1s9bZc\nEEiGkYO3zQgSDkXBjzl5ElL4ZXliiHdDJN0suky9R9F5M1F6+hHO7ctiULbxzxcS\nb8kheBmC6n2pBGkOoFGTDvSVpyo6n6yF/HGY2K3WxodwuWDSkzOLG3fMa8IzwJhF\ngfQE8zpvhnE0DwzSuimQKMUZCtvh28MYRW2yOO7tL3sAmqoKw21Pg1xocFqaYGWP\nZpQvcBL9t0QIg4JUbenN2K9GO3fxSySYjgj02nYeUVb2WcykYfNckCnghrNiCLnF\nApjz51CqhJ0k5e/5krRKE+Lzs8mxgvfhBDnLRrjLD+jPxUKaHhUs7+0tbqOyafbM\nxlGZDaEL2EOGPSzSnu/vtBkCJYOTiVZYF+kwEyTpRahP4o5sSlfOKLrXLfJxIiaR\naCbhTTPbkDA5yW9cZfBjZtNTfZzXBmAmOrwylUn2NkFAsfHpdDv522zGJDeUF1lQ\ntquzdGnfttmPRH2RTwH8EjVCOVe7+neNMWj6VaiFztdZ6b48y3E9WOW8Qcv8pHHJ\nQBWqUTcQi2ZlmSz9PxEeBQ==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2023-09-19T21:45:45.000000Z'
last_seen:
type: string
example: '2024-08-12T01:51:53.000000Z'
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: quo
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: dolores
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.type
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany.type
nullable: false
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2a705b2e-9abb-473c-bd06-f023de02fe1f
company_id: '3638092'
managing_company_id: '3638092'
first_name: Romaine
last_name: Purdy
two_factor_enabled: false
two_factor_configured: false
email: ryder.deckow@hotmail.com
email_verified_at: '2025-07-11T15:34:37Z'
phonenumber: 480.268.3767
phonenumber_verified_at: '2025-07-11T15:34:37Z'
report_interval: weekly
manageable_companies:
-
id: '3638092'
uuid: d2f39ffe-df31-4958-814f-c3dd9aa9a646
name: Hills-McKenzie
count_detections: null
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2025-07-11T15:34:37Z'
sso_provider: null
created_at: '2025-07-11T15:34:37Z'
updated_at: '2025-07-11T15:34:37Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: 2a705b2e-9abb-473c-bd06-f023de02fe1f
company_id:
type: string
example: '3638092'
managing_company_id:
type: string
example: '3638092'
first_name:
type: string
example: Romaine
last_name:
type: string
example: Purdy
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: ryder.deckow@hotmail.com
email_verified_at:
type: string
example: '2025-07-11T15:34:37Z'
phonenumber:
type: string
example: 480.268.3767
phonenumber_verified_at:
type: string
example: '2025-07-11T15:34:37Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '3638092'
uuid: d2f39ffe-df31-4958-814f-c3dd9aa9a646
name: Hills-McKenzie
count_detections: null
items:
type: object
properties:
id:
type: string
example: '3638092'
uuid:
type: string
example: d2f39ffe-df31-4958-814f-c3dd9aa9a646
name:
type: string
example: Hills-McKenzie
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-07-11T15:34:37Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:37Z'
updated_at:
type: string
example: '2025-07-11T15:34:37Z'
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'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Me
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: Doe
nullable: false
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
managing_company_id:
type: string
description: 'Must be a valid company id the user has access to.'
example: '1'
nullable: false
report_interval:
type: string
description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.'
example: weekly
nullable: false
terms_agreed_at:
type: string
description: 'Must be a valid date.'
example: '2025-07-11T15:34:37'
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: non
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: non
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: 9f5db46e-a210-4a1e-a0d4-e5e8f201c4c4
company_id: '2108526'
name: 1214e092-78d6-3867-865f-7d42f7ff4d2f
description: 'Eum enim quis eos sit cum ipsa sapiente. Consectetur voluptatibus necessitatibus ab rerum voluptatem. Repellendus sint illo quasi non perspiciatis.'
business_impact: critical
system_tag: false
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-a510-4fcb-8b7d-0a315d6729c9
company_id: '4783903'
name: f2daa712-3173-3ffe-8da4-66c80e2e16ce
description: 'Et praesentium molestiae voluptatem repellat est ullam. Aut quis voluptate voluptatem necessitatibus nulla. Est corporis magni nihil ut assumenda saepe. In quia sit totam unde quibusdam.'
business_impact: low
system_tag: true
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.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: 9f5db46e-a210-4a1e-a0d4-e5e8f201c4c4
company_id: '2108526'
name: 1214e092-78d6-3867-865f-7d42f7ff4d2f
description: 'Eum enim quis eos sit cum ipsa sapiente. Consectetur voluptatibus necessitatibus ab rerum voluptatem. Repellendus sint illo quasi non perspiciatis.'
business_impact: critical
system_tag: false
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
-
id: 9f5db46e-a510-4fcb-8b7d-0a315d6729c9
company_id: '4783903'
name: f2daa712-3173-3ffe-8da4-66c80e2e16ce
description: 'Et praesentium molestiae voluptatem repellat est ullam. Aut quis voluptate voluptatem necessitatibus nulla. Est corporis magni nihil ut assumenda saepe. In quia sit totam unde quibusdam.'
business_impact: low
system_tag: true
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46e-a210-4a1e-a0d4-e5e8f201c4c4
company_id:
type: string
example: '2108526'
name:
type: string
example: 1214e092-78d6-3867-865f-7d42f7ff4d2f
description:
type: string
example: 'Eum enim quis eos sit cum ipsa sapiente. Consectetur voluptatibus necessitatibus ab rerum voluptatem. Repellendus sint illo quasi non perspiciatis.'
business_impact:
type: string
example: critical
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: 9f5db46e-aae6-4c5e-ab14-9dad3a341fb5
company_id: '1587531'
name: e92fabc4-cdaa-3021-a327-245bd394fb0a
description: 'Voluptatibus aliquam odio tempora eveniet voluptatem aliquam facilis. Rerum optio explicabo vel. Magnam ratione saepe voluptate voluptatem aperiam veniam explicabo.'
business_impact: low
system_tag: true
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-aae6-4c5e-ab14-9dad3a341fb5
company_id:
type: string
example: '1587531'
name:
type: string
example: e92fabc4-cdaa-3021-a327-245bd394fb0a
description:
type: string
example: 'Voluptatibus aliquam odio tempora eveniet voluptatem aliquam facilis. Rerum optio explicabo vel. Magnam ratione saepe voluptate voluptatem aperiam veniam explicabo.'
business_impact:
type: string
example: low
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: agj
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Architecto nulla consequuntur consectetur reprehenderit sunt.'
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: 9f5db46e-af9f-42a2-bd74-bfd46b4b25c6
company_id: '4752896'
name: d2effd91-d95f-3608-b580-8372e654a903
description: 'Quia totam velit neque vel aut cum nostrum dicta. Odio quam debitis illum ad. Sunt minima laudantium nostrum et id hic aut.'
business_impact: critical
system_tag: true
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-af9f-42a2-bd74-bfd46b4b25c6
company_id:
type: string
example: '4752896'
name:
type: string
example: d2effd91-d95f-3608-b580-8372e654a903
description:
type: string
example: 'Quia totam velit neque vel aut cum nostrum dicta. Odio quam debitis illum ad. Sunt minima laudantium nostrum et id hic aut.'
business_impact:
type: string
example: critical
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: 9f5db46e-b4fe-4581-9a45-4c0c4e6f5dd2
company_id: '3920191'
name: c1985553-0365-3d60-a424-195c66168520
description: 'Fuga doloribus qui maiores et. Ratione omnis est in velit illo et vitae. Rem soluta accusantium quod nemo modi sit impedit. Omnis dignissimos porro quasi placeat et incidunt fuga.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2025-07-11T15:34:39.000000Z'
updated_at: '2025-07-11T15:34:39.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-b4fe-4581-9a45-4c0c4e6f5dd2
company_id:
type: string
example: '3920191'
name:
type: string
example: c1985553-0365-3d60-a424-195c66168520
description:
type: string
example: 'Fuga doloribus qui maiores et. Ratione omnis est in velit illo et vitae. Rem soluta accusantium quod nemo modi sit impedit. Omnis dignissimos porro quasi placeat et incidunt fuga.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-07-11T15:34:39.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:39.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: qpilptmchuhoidenlahdnfh
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Totam ad laborum eligendi qui.'
nullable: false
business_impact:
type: string
description: ''
example: low
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: sapiente
required: true
schema:
type: string
/v1/users:
get:
summary: 'List Users'
operationId: listUsers
description: "Retrieve all users for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany
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
-
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: f02bcc55-7a33-4ba2-a995-748174d88f58
company_id: '8424816'
managing_company_id: '8424816'
first_name: Liliana
last_name: Pagac
two_factor_enabled: false
email: zbednar@gmail.com
email_verified_at: '2025-07-11T15:34:38.000000Z'
phonenumber: '(330) 497-9003'
phonenumber_verified_at: '2025-07-11T15:34:38.000000Z'
report_interval: weekly
manageable_companies:
-
id: '8424816'
uuid: 2a23c2d3-165b-4e39-b994-a1f6b76afd78
name: 'Kutch, Koch and Nicolas'
count_detections: null
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-07-11T15:34:38.000000Z'
sso_provider: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
-
id: 27cd76d8-d238-4877-b235-199eb8e89580
company_id: '3705013'
managing_company_id: '3705013'
first_name: Oma
last_name: Kilback
two_factor_enabled: false
email: wjenkins@carter.info
email_verified_at: '2025-07-11T15:34:38.000000Z'
phonenumber: '+12209401206'
phonenumber_verified_at: '2025-07-11T15:34:38.000000Z'
report_interval: weekly
manageable_companies:
-
id: '3705013'
uuid: d45285c9-9d07-4963-9dfc-d3eaddbe7bc6
name: 'Considine, Thiel and Tillman'
count_detections: null
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-07-11T15:34:38.000000Z'
sso_provider: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.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: f02bcc55-7a33-4ba2-a995-748174d88f58
company_id: '8424816'
managing_company_id: '8424816'
first_name: Liliana
last_name: Pagac
two_factor_enabled: false
email: zbednar@gmail.com
email_verified_at: '2025-07-11T15:34:38.000000Z'
phonenumber: '(330) 497-9003'
phonenumber_verified_at: '2025-07-11T15:34:38.000000Z'
report_interval: weekly
manageable_companies:
-
id: '8424816'
uuid: 2a23c2d3-165b-4e39-b994-a1f6b76afd78
name: 'Kutch, Koch and Nicolas'
count_detections: null
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-07-11T15:34:38.000000Z'
sso_provider: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
-
id: 27cd76d8-d238-4877-b235-199eb8e89580
company_id: '3705013'
managing_company_id: '3705013'
first_name: Oma
last_name: Kilback
two_factor_enabled: false
email: wjenkins@carter.info
email_verified_at: '2025-07-11T15:34:38.000000Z'
phonenumber: '+12209401206'
phonenumber_verified_at: '2025-07-11T15:34:38.000000Z'
report_interval: weekly
manageable_companies:
-
id: '3705013'
uuid: d45285c9-9d07-4963-9dfc-d3eaddbe7bc6
name: 'Considine, Thiel and Tillman'
count_detections: null
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-07-11T15:34:38.000000Z'
sso_provider: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
items:
type: object
properties:
id:
type: string
example: f02bcc55-7a33-4ba2-a995-748174d88f58
company_id:
type: string
example: '8424816'
managing_company_id:
type: string
example: '8424816'
first_name:
type: string
example: Liliana
last_name:
type: string
example: Pagac
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: zbednar@gmail.com
email_verified_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
phonenumber:
type: string
example: '(330) 497-9003'
phonenumber_verified_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '8424816'
uuid: 2a23c2d3-165b-4e39-b994-a1f6b76afd78
name: 'Kutch, Koch and Nicolas'
count_detections: null
items:
type: object
properties:
id:
type: string
example: '8424816'
uuid:
type: string
example: 2a23c2d3-165b-4e39-b994-a1f6b76afd78
name:
type: string
example: 'Kutch, Koch and Nicolas'
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-07-11T15:34:38.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.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: dce
nullable: false
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: ahekawqzwkhdwkfoxfsias
nullable: false
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: tabitha.kiehn@example.org
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
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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 62c71989-ca2f-40f7-b422-f356d0b35d4e
company_id: '9947654'
managing_company_id: '9947654'
first_name: Cassie
last_name: Witting
two_factor_enabled: false
email: bednar.billy@hotmail.com
email_verified_at: '2025-07-11T15:34:38.000000Z'
phonenumber: '+1 (254) 297-5342'
phonenumber_verified_at: '2025-07-11T15:34:38.000000Z'
report_interval: weekly
manageable_companies:
-
id: '9947654'
uuid: 29f3630d-1462-444e-9b60-70c769b20e50
name: Mayer-Rice
count_detections: null
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-07-11T15:34:38.000000Z'
sso_provider: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 62c71989-ca2f-40f7-b422-f356d0b35d4e
company_id:
type: string
example: '9947654'
managing_company_id:
type: string
example: '9947654'
first_name:
type: string
example: Cassie
last_name:
type: string
example: Witting
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: bednar.billy@hotmail.com
email_verified_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
phonenumber:
type: string
example: '+1 (254) 297-5342'
phonenumber_verified_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '9947654'
uuid: 29f3630d-1462-444e-9b60-70c769b20e50
name: Mayer-Rice
count_detections: null
items:
type: object
properties:
id:
type: string
example: '9947654'
uuid:
type: string
example: 29f3630d-1462-444e-9b60-70c769b20e50
name:
type: string
example: Mayer-Rice
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-07-11T15:34:38.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.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: e41cb164-e7b2-3570-bf8d-99da10a5a23f
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: Resolved
required: false
schema:
type: 'Filter vulnerabilities by their status'
description: ''
example: Resolved
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: name
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: name
nullable: false
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 9f5db46e-1b81-41d2-8e94-d7e1c0a442f7
asset_id: 9f5db46e-116f-4fb4-9ef3-499d7f171058
company_id: '6959156'
vulnerability_definition_id: 9f5db46e-1ab3-47f4-b084-686157fc0280
vulnerability_definition:
id: 9f5db46e-1ab3-47f4-b084-686157fc0280
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
description: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
solution: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
category: 'Unnecessary Services Enabled'
threat_level: Critical
definition_type: openvas
definition:
id: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves: 'CVE-2015-5505, CVE-2017-8491'
solution_type: WorkAround
solution_description: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority: Critical
qod_type: registry
qod_value: 2
cvss_base_score: 4.5
cvss_base_vector: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
epss: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
host: 241.50.112.132
hostname: schinner.com
port: general/tcp
details: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
status: Unresolved
first_seen: '2024-08-19T06:47:03.000000Z'
last_seen: '2024-09-30T15:23:13.000000Z'
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
description: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
cvss_base_score: 4.5
cvss_base_vector: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
qod_type: registry
qod_value: 2
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves: 'CVE-2015-5505, CVE-2017-8491'
solution_type: WorkAround
solution_description: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority: Critical
qod_type: registry
qod_value: 2
-
id: 9f5db46e-2555-4847-bece-1bc4a6796124
asset_id: 9f5db46e-2023-4761-a988-59789bef366b
company_id: '6204753'
vulnerability_definition_id: 9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8
vulnerability_definition:
id: 9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8
name: 'Integer Heap Overflow in et'
description: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
solution: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
category: 'Heap Overflow'
threat_level: Low
definition_type: openvas
definition:
id: 9f5db46e-22c7-4bac-ace5-9bf0a8f97c24
o_id: dbe52303-5221-32eb-b3cb-c8f4a06f4c5e
name: 'Integer Heap Overflow in et'
family: 'Heap Overflow'
reference_urls: 'http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html'
reference_cves: 'CVE-2021-2567, CVE-2022-5076'
solution_type: 'Configuration Change'
solution_description: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
summary: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
insight: 'Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.'
affected: 'Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.'
impact: 'Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.'
vuldetect: 'Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.'
priority: Low
qod_type: package
qod_value: 63
cvss_base_score: 0.3
cvss_base_vector: 'AV:P/AC:L/Au:N/C:N/I:C/A:C'
epss: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
host: 17.98.28.129
hostname: hermann.net
port: 5432/tcp
details: 'Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.'
status: Accepted
first_seen: '2025-06-17T11:58:51.000000Z'
last_seen: '2025-07-04T02:00:47.000000Z'
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
name: 'Integer Heap Overflow in et'
description: 'Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.'
cvss_base_score: 0.3
cvss_base_vector: 'AV:P/AC:L/Au:N/C:N/I:C/A:C'
qod_type: package
qod_value: 63
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: 9f5db46e-22c7-4bac-ace5-9bf0a8f97c24
o_id: dbe52303-5221-32eb-b3cb-c8f4a06f4c5e
name: 'Integer Heap Overflow in et'
family: 'Heap Overflow'
reference_urls: 'http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html'
reference_cves: 'CVE-2021-2567, CVE-2022-5076'
solution_type: 'Configuration Change'
solution_description: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
summary: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
insight: 'Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.'
affected: 'Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.'
impact: 'Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.'
vuldetect: 'Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.'
priority: Low
qod_type: package
qod_value: 63
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: 9f5db46e-1b81-41d2-8e94-d7e1c0a442f7
asset_id: 9f5db46e-116f-4fb4-9ef3-499d7f171058
company_id: '6959156'
vulnerability_definition_id: 9f5db46e-1ab3-47f4-b084-686157fc0280
vulnerability_definition:
id: 9f5db46e-1ab3-47f4-b084-686157fc0280
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
description: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
solution: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
category: 'Unnecessary Services Enabled'
threat_level: Critical
definition_type: openvas
definition:
id: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves: 'CVE-2015-5505, CVE-2017-8491'
solution_type: WorkAround
solution_description: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority: Critical
qod_type: registry
qod_value: 2
cvss_base_score: 4.5
cvss_base_vector: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
epss: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
host: 241.50.112.132
hostname: schinner.com
port: general/tcp
details: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
status: Unresolved
first_seen: '2024-08-19T06:47:03.000000Z'
last_seen: '2024-09-30T15:23:13.000000Z'
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
description: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
cvss_base_score: 4.5
cvss_base_vector: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
qod_type: registry
qod_value: 2
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name: 'Unnecessary Services Enabled exploitable through enim manipulation'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves: 'CVE-2015-5505, CVE-2017-8491'
solution_type: WorkAround
solution_description: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority: Critical
qod_type: registry
qod_value: 2
-
id: 9f5db46e-2555-4847-bece-1bc4a6796124
asset_id: 9f5db46e-2023-4761-a988-59789bef366b
company_id: '6204753'
vulnerability_definition_id: 9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8
vulnerability_definition:
id: 9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8
name: 'Integer Heap Overflow in et'
description: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
solution: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
category: 'Heap Overflow'
threat_level: Low
definition_type: openvas
definition:
id: 9f5db46e-22c7-4bac-ace5-9bf0a8f97c24
o_id: dbe52303-5221-32eb-b3cb-c8f4a06f4c5e
name: 'Integer Heap Overflow in et'
family: 'Heap Overflow'
reference_urls: 'http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html'
reference_cves: 'CVE-2021-2567, CVE-2022-5076'
solution_type: 'Configuration Change'
solution_description: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
summary: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
insight: 'Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.'
affected: 'Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.'
impact: 'Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.'
vuldetect: 'Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.'
priority: Low
qod_type: package
qod_value: 63
cvss_base_score: 0.3
cvss_base_vector: 'AV:P/AC:L/Au:N/C:N/I:C/A:C'
epss: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
host: 17.98.28.129
hostname: hermann.net
port: 5432/tcp
details: 'Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.'
status: Accepted
first_seen: '2025-06-17T11:58:51.000000Z'
last_seen: '2025-07-04T02:00:47.000000Z'
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
name: 'Integer Heap Overflow in et'
description: 'Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.'
cvss_base_score: 0.3
cvss_base_vector: 'AV:P/AC:L/Au:N/C:N/I:C/A:C'
qod_type: package
qod_value: 63
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: 9f5db46e-22c7-4bac-ace5-9bf0a8f97c24
o_id: dbe52303-5221-32eb-b3cb-c8f4a06f4c5e
name: 'Integer Heap Overflow in et'
family: 'Heap Overflow'
reference_urls: 'http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html'
reference_cves: 'CVE-2021-2567, CVE-2022-5076'
solution_type: 'Configuration Change'
solution_description: 'Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.'
summary: 'Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.'
insight: 'Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.'
affected: 'Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.'
impact: 'Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.'
vuldetect: 'Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.'
priority: Low
qod_type: package
qod_value: 63
items:
type: object
properties:
id:
type: string
example: 9f5db46e-1b81-41d2-8e94-d7e1c0a442f7
asset_id:
type: string
example: 9f5db46e-116f-4fb4-9ef3-499d7f171058
company_id:
type: string
example: '6959156'
vulnerability_definition_id:
type: string
example: 9f5db46e-1ab3-47f4-b084-686157fc0280
vulnerability_definition:
type: object
properties:
id:
type: string
example: 9f5db46e-1ab3-47f4-b084-686157fc0280
name:
type: string
example: 'Unnecessary Services Enabled exploitable through enim manipulation'
description:
type: string
example: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
solution:
type: string
example: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
category:
type: string
example: 'Unnecessary Services Enabled'
threat_level:
type: string
example: Critical
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id:
type: string
example: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name:
type: string
example: 'Unnecessary Services Enabled exploitable through enim manipulation'
family:
type: string
example: 'Unnecessary Services Enabled'
reference_urls:
type: string
example: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves:
type: string
example: 'CVE-2015-5505, CVE-2017-8491'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary:
type: string
example: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight:
type: string
example: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected:
type: string
example: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact:
type: string
example: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect:
type: string
example: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority:
type: string
example: Critical
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 2
cvss_base_score:
type: number
example: 4.5
cvss_base_vector:
type: string
example: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
epss:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
host:
type: string
example: 241.50.112.132
hostname:
type: string
example: schinner.com
port:
type: string
example: general/tcp
details:
type: string
example: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
status:
type: string
example: Unresolved
first_seen:
type: string
example: '2024-08-19T06:47:03.000000Z'
last_seen:
type: string
example: '2024-09-30T15:23:13.000000Z'
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
name:
type: string
example: 'Unnecessary Services Enabled exploitable through enim manipulation'
description:
type: string
example: 'Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.'
cvss_base_score:
type: number
example: 4.5
cvss_base_vector:
type: string
example: 'AV:A/AC:H/Au:M/C:P/I:P/A:N'
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 2
threat:
type: string
example: Critical
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: 9f5db46e-188d-4afb-9475-abad4f8f46d8
o_id:
type: string
example: d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1
name:
type: string
example: 'Unnecessary Services Enabled exploitable through enim manipulation'
family:
type: string
example: 'Unnecessary Services Enabled'
reference_urls:
type: string
example: 'http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo'
reference_cves:
type: string
example: 'CVE-2015-5505, CVE-2017-8491'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.'
summary:
type: string
example: 'Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.'
insight:
type: string
example: 'Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.'
affected:
type: string
example: 'Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.'
impact:
type: string
example: 'Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.'
vuldetect:
type: string
example: 'Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.'
priority:
type: string
example: Critical
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 2
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: jrahdqfovsyhrofqdzrjie
nullable: false
threat_level:
type: string
description: ''
example: Medium
nullable: false
enum:
- Log
- Low
- Medium
- High
- Critical
host:
type: string
description: 'Must not be greater than 255 characters.'
example: baifzmmqtejismyabdiqlussc
nullable: false
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: xofozhkdvddovokvtqond
nullable: false
status:
type: string
description: ''
example: Accepted
nullable: false
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: 06c6a834-2920-3ada-be6c-3498242a9f6b
nullable: false
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 3
nullable: false
'/v1/vulnerabilities/{id}':
get:
summary: 'Retrieve a vulnerability.'
operationId: retrieveAVulnerability
description: " Retrieves a vulnerability by its ID.\n "
parameters: []
responses:
200:
description: 'Successfully retrieved vulnerability'
content:
application/json:
schema:
type: object
example:
data:
id: 9f5db46e-32f1-4a95-874b-b11f4f261f9c
asset_id: 9f5db46e-2e87-4bc7-83cf-29fd91919a9c
company_id: '5531164'
vulnerability_definition_id: 9f5db46e-3265-45fa-a1ad-b707efbd9a1c
vulnerability_definition:
id: 9f5db46e-3265-45fa-a1ad-b707efbd9a1c
name: 'Error-based NoSQL Injection affecting exercitationem functionality'
description: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
solution: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
category: 'NoSQL Injection'
threat_level: Low
definition_type: openvas
definition:
id: 9f5db46e-3112-4e3b-808d-f2eb9adb59a9
o_id: bfd73381-9a69-392d-b708-8387c9d027dc
name: 'Error-based NoSQL Injection affecting exercitationem functionality'
family: 'NoSQL Injection'
reference_urls: 'http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html'
reference_cves: 'CVE-2021-4778, CVE-2015-9271'
solution_type: Mitigation
solution_description: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
summary: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
insight: 'Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.'
affected: 'Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.'
impact: 'Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.'
vuldetect: 'Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.'
priority: Critical
qod_type: exploit
qod_value: 87
cvss_base_score: 7.6
cvss_base_vector: 'AV:N/AC:H/Au:S/C:C/I:N/A:P'
epss: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
host: 157.210.161.125
hostname: tillman.info
port: 443/tcp
details: 'Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.'
status: Expired
first_seen: '2024-11-26T15:32:17.000000Z'
last_seen: '2025-03-04T15:43:13.000000Z'
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
name: 'Error-based NoSQL Injection affecting exercitationem functionality'
description: 'Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.'
cvss_base_score: 7.6
cvss_base_vector: 'AV:N/AC:H/Au:S/C:C/I:N/A:P'
qod_type: exploit
qod_value: 87
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: 9f5db46e-3112-4e3b-808d-f2eb9adb59a9
o_id: bfd73381-9a69-392d-b708-8387c9d027dc
name: 'Error-based NoSQL Injection affecting exercitationem functionality'
family: 'NoSQL Injection'
reference_urls: 'http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html'
reference_cves: 'CVE-2021-4778, CVE-2015-9271'
solution_type: Mitigation
solution_description: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
summary: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
insight: 'Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.'
affected: 'Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.'
impact: 'Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.'
vuldetect: 'Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.'
priority: Critical
qod_type: exploit
qod_value: 87
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46e-32f1-4a95-874b-b11f4f261f9c
asset_id:
type: string
example: 9f5db46e-2e87-4bc7-83cf-29fd91919a9c
company_id:
type: string
example: '5531164'
vulnerability_definition_id:
type: string
example: 9f5db46e-3265-45fa-a1ad-b707efbd9a1c
vulnerability_definition:
type: object
properties:
id:
type: string
example: 9f5db46e-3265-45fa-a1ad-b707efbd9a1c
name:
type: string
example: 'Error-based NoSQL Injection affecting exercitationem functionality'
description:
type: string
example: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
solution:
type: string
example: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
category:
type: string
example: 'NoSQL Injection'
threat_level:
type: string
example: Low
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: 9f5db46e-3112-4e3b-808d-f2eb9adb59a9
o_id:
type: string
example: bfd73381-9a69-392d-b708-8387c9d027dc
name:
type: string
example: 'Error-based NoSQL Injection affecting exercitationem functionality'
family:
type: string
example: 'NoSQL Injection'
reference_urls:
type: string
example: 'http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html'
reference_cves:
type: string
example: 'CVE-2021-4778, CVE-2015-9271'
solution_type:
type: string
example: Mitigation
solution_description:
type: string
example: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
summary:
type: string
example: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
insight:
type: string
example: 'Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.'
affected:
type: string
example: 'Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.'
impact:
type: string
example: 'Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.'
vuldetect:
type: string
example: 'Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.'
priority:
type: string
example: Critical
qod_type:
type: string
example: exploit
qod_value:
type: integer
example: 87
cvss_base_score:
type: number
example: 7.6
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:S/C:C/I:N/A:P'
epss:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
host:
type: string
example: 157.210.161.125
hostname:
type: string
example: tillman.info
port:
type: string
example: 443/tcp
details:
type: string
example: 'Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.'
status:
type: string
example: Expired
first_seen:
type: string
example: '2024-11-26T15:32:17.000000Z'
last_seen:
type: string
example: '2025-03-04T15:43:13.000000Z'
created_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.000000Z'
name:
type: string
example: 'Error-based NoSQL Injection affecting exercitationem functionality'
description:
type: string
example: 'Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.'
cvss_base_score:
type: number
example: 7.6
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:S/C:C/I:N/A:P'
qod_type:
type: string
example: exploit
qod_value:
type: integer
example: 87
threat:
type: string
example: Low
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: 9f5db46e-3112-4e3b-808d-f2eb9adb59a9
o_id:
type: string
example: bfd73381-9a69-392d-b708-8387c9d027dc
name:
type: string
example: 'Error-based NoSQL Injection affecting exercitationem functionality'
family:
type: string
example: 'NoSQL Injection'
reference_urls:
type: string
example: 'http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html'
reference_cves:
type: string
example: 'CVE-2021-4778, CVE-2015-9271'
solution_type:
type: string
example: Mitigation
solution_description:
type: string
example: 'Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.'
summary:
type: string
example: 'Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.'
insight:
type: string
example: 'Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.'
affected:
type: string
example: 'Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.'
impact:
type: string
example: 'Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.'
vuldetect:
type: string
example: 'Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.'
priority:
type: string
example: Critical
qod_type:
type: string
example: exploit
qod_value:
type: integer
example: 87
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: sed
required: true
schema:
type: string
/v1/webhook-events:
get:
summary: 'List all webhook events'
operationId: listAllWebhookEvents
description: "Lists all webhook events for the authenticated user's company.\n"
parameters:
-
in: query
name: sort
description: 'Sort the results by column(s) (comma separated).'
example: event
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: event
nullable: false
enum:
- webhook_id
- event
- status
- next_retry_at
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: status
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: status
nullable: false
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 9f5db46c-c12f-40b3-8ae9-eccf4824c5e1
webhook_id: 9f5db46c-c073-4182-b1af-6d288d5660ef
event: rerum
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
-
id: 9f5db46c-c4ea-4799-b2ee-517be0f587d0
webhook_id: 9f5db46c-c40a-482d-94e6-65c602b96227
event: cupiditate
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.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: 9f5db46c-c12f-40b3-8ae9-eccf4824c5e1
webhook_id: 9f5db46c-c073-4182-b1af-6d288d5660ef
event: rerum
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
-
id: 9f5db46c-c4ea-4799-b2ee-517be0f587d0
webhook_id: 9f5db46c-c40a-482d-94e6-65c602b96227
event: cupiditate
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46c-c12f-40b3-8ae9-eccf4824c5e1
webhook_id:
type: string
example: 9f5db46c-c073-4182-b1af-6d288d5660ef
event:
type: string
example: rerum
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-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.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: 9f5db46c-d0c6-4672-9d17-401e5be67372
webhook_id: 9f5db46c-cfec-4d78-9b6c-bf1d7822419b
event: nobis
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-07-11T15:34:38.000000Z'
updated_at: '2025-07-11T15:34:38.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46c-d0c6-4672-9d17-401e5be67372
webhook_id:
type: string
example: 9f5db46c-cfec-4d78-9b6c-bf1d7822419b
event:
type: string
example: nobis
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-07-11T15:34:38.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:38.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: 9f5db46c-c12f-40b3-8ae9-eccf4824c5e1
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: 9f5db46c-a451-4316-87de-b35931447360
company_id: d577cef5-ab91-41c5-b656-1f50bea577b0
url: 'https://orn.org'
description: null
events: []
secret: 685f419ec6729b1632e4179e38ce3e9c13921f8c88eeff1a6a700e5c4dd7a0dc
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
-
id: 9f5db46c-a883-4689-9ac8-0035125a9275
company_id: 0a33bbf0-4791-48fe-b373-1573adef4f03
url: 'https://bednar.biz'
description: null
events: []
secret: ea2e0775a17daf2fd89af0d94fba9079aacd8c7b2d6ab3fc4c10a98987355b49
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
properties:
data:
type: array
example:
-
id: 9f5db46c-a451-4316-87de-b35931447360
company_id: d577cef5-ab91-41c5-b656-1f50bea577b0
url: 'https://orn.org'
description: null
events: []
secret: 685f419ec6729b1632e4179e38ce3e9c13921f8c88eeff1a6a700e5c4dd7a0dc
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
-
id: 9f5db46c-a883-4689-9ac8-0035125a9275
company_id: 0a33bbf0-4791-48fe-b373-1573adef4f03
url: 'https://bednar.biz'
description: null
events: []
secret: ea2e0775a17daf2fd89af0d94fba9079aacd8c7b2d6ab3fc4c10a98987355b49
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
items:
type: object
properties:
id:
type: string
example: 9f5db46c-a451-4316-87de-b35931447360
company_id:
type: string
example: d577cef5-ab91-41c5-b656-1f50bea577b0
url:
type: string
example: 'https://orn.org'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 685f419ec6729b1632e4179e38ce3e9c13921f8c88eeff1a6a700e5c4dd7a0dc
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:37.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:37.000000Z'
tags:
- Webhooks
post:
summary: 'Create Webhook'
operationId: createWebhook
description: "Create a new webhook for the current company.\n"
parameters: []
responses:
201:
description: 'webhook created'
content:
application/json:
schema:
type: object
example:
data:
id: 00000000-0000-0000-0000-000000000000
properties:
data:
type: object
properties:
id:
type: string
example: 00000000-0000-0000-0000-000000000000
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'url is already used by company'
type: object
example:
message: 'The url has already been taken.'
properties:
message:
type: string
example: 'The url has already been taken.'
-
description: 'validation error'
type: object
example:
message: 'invalid url'
properties:
message:
type: string
example: 'invalid url'
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL. Must not be greater than 2048 characters.'
example: 'http://medhurst.org/explicabo-ea-et-velit-deserunt-officia'
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Inventore quia modi temporibus eius voluptatum soluta accusantium.'
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: 9f5db46c-b0c7-4805-9e6c-0009022f494d
company_id: 2a22ce05-074e-4b8b-b29d-d2d3f453502c
url: 'https://vonrueden.info'
description: null
events: []
secret: 128627eec4898cdc16cf56512e649eea63550d57535e7f6b0562db452fb92289
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46c-b0c7-4805-9e6c-0009022f494d
company_id:
type: string
example: 2a22ce05-074e-4b8b-b29d-d2d3f453502c
url:
type: string
example: 'https://vonrueden.info'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 128627eec4898cdc16cf56512e649eea63550d57535e7f6b0562db452fb92289
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:37.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:37.000000Z'
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
tags:
- Webhooks
patch:
summary: 'Update a webhook'
operationId: updateAWebhook
description: "Updates a webhook for the current company.\n"
parameters: []
responses:
200:
description: 'update successful'
content:
text/plain:
schema:
type: string
example: ''
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'url is already used by company'
type: object
example:
message: 'The url has already been taken.'
properties:
message:
type: string
example: 'The url has already been taken.'
-
description: 'validation error'
type: object
example:
message: 'invalid url'
properties:
message:
type: string
example: 'invalid url'
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL.'
example: 'http://www.pagac.org/'
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Non nisi cumque assumenda non ullam qui.'
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: 9f5db46c-a451-4316-87de-b35931447360
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: 9f5db46c-b5d4-42b4-8f15-f0808735899e
company_id: d9a220bf-3fc7-481f-bf7e-9057143b6bdc
url: 'https://lueilwitz.info'
description: null
events: []
secret: 06c7eda4cb849efeb06f80d5ef4f035730da95bd02d5f709a5caca1697062697
last_sent_at: null
created_at: '2025-07-11T15:34:37.000000Z'
updated_at: '2025-07-11T15:34:37.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 9f5db46c-b5d4-42b4-8f15-f0808735899e
company_id:
type: string
example: d9a220bf-3fc7-481f-bf7e-9057143b6bdc
url:
type: string
example: 'https://lueilwitz.info'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 06c7eda4cb849efeb06f80d5ef4f035730da95bd02d5f709a5caca1697062697
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-07-11T15:34:37.000000Z'
updated_at:
type: string
example: '2025-07-11T15:34:37.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: 9f5db46c-a451-4316-87de-b35931447360
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: 9f5db46c-a451-4316-87de-b35931447360
required: true
schema:
type: string