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: cpe
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: cpe
nullable: false
enum:
- cpe
- vendor
- product
- version
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
nullable: false
enum:
- assets
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a04676c8-d859-4956-8536-ed25a5ad54ed
cpe: 'cpe:2.3:a:adobe:indesign:*:*:*:*:*:*:*:*'
vendor: Adobe
product: InDesign
version: 8.25.9147
update: sp2
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-d9d4-4144-8e18-3943c89c4d9e
cpe: 'cpe:2.3:a:adobe:acrobat:*:*:*:*:*:*:*:*'
vendor: Adobe
product: Acrobat
version: 13.48.2741
update: hotfix1
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-d859-4956-8536-ed25a5ad54ed
cpe: 'cpe:2.3:a:adobe:indesign:*:*:*:*:*:*:*:*'
vendor: Adobe
product: InDesign
version: 8.25.9147
update: sp2
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-d9d4-4144-8e18-3943c89c4d9e
cpe: 'cpe:2.3:a:adobe:acrobat:*:*:*:*:*:*:*:*'
vendor: Adobe
product: Acrobat
version: 13.48.2741
update: hotfix1
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-d859-4956-8536-ed25a5ad54ed
cpe:
type: string
example: 'cpe:2.3:a:adobe:indesign:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Adobe
product:
type: string
example: InDesign
version:
type: string
example: 8.25.9147
update:
type: string
example: sp2
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Applications
/v1/applications/export:
get:
summary: 'Export applications.'
operationId: exportApplications
description: " Export all applications for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: csv
required: true
schema:
type: 'The type of export to generate'
description: ''
example: csv
nullable: false
enum:
- csv
- xlsx
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
nullable: false
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
nullable: false
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
nullable: false
-
in: query
name: sort
description: ''
example: product
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: product
nullable: false
enum:
- cpe
- vendor
- product
- version
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: ''
example: csv
nullable: false
enum:
- csv
- xlsx
required:
- type
'/v1/applications/{id}':
get:
summary: 'Retrieve an application.'
operationId: retrieveAnApplication
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
nullable: false
enum:
- assets
responses:
200:
description: 'Successfully retrieved application'
content:
application/json:
schema:
type: object
example:
data:
id: a04676c8-de28-4cf2-a963-00dbe5722014
cpe: 'cpe:2.3:a:ibm:spss:*:*:*:*:*:*:*:*'
vendor: IBM
product: SPSS
version: 3.35.5733
update: build9858
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-de28-4cf2-a963-00dbe5722014
cpe:
type: string
example: 'cpe:2.3:a:ibm:spss:*:*:*:*:*:*:*:*'
vendor:
type: string
example: IBM
product:
type: string
example: SPSS
version:
type: string
example: 3.35.5733
update:
type: string
example: build9858
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: fugiat
required: true
schema:
type: string
/v1/assets:
get:
summary: 'List assets.'
operationId: listAssets
description: " Retrieve all assets for the current company. Look at the 'Retrieve an asset' endpoint for more details on the asset object.\n "
parameters:
-
in: query
name: 'filter[name]'
description: ''
example: Laptop-1
required: false
schema:
type: 'Filter assets by name.'
description: ''
example: Laptop-1
nullable: false
-
in: query
name: 'filter[host]'
description: ''
example: 192.168.1.1
required: false
schema:
type: 'Filter assets by their IP-address.'
description: ''
example: 192.168.1.1
nullable: false
-
in: query
name: 'filter[mac_address]'
description: ''
example: '3A:5E:D6:95:BF'
required: false
schema:
type: 'Filter assets by their MAC-address.'
description: ''
example: '3A:5E:D6:95:BF'
nullable: false
-
in: query
name: 'filter[hostname]'
description: ''
example: laptop-1.local
required: false
schema:
type: 'Filter assets by their hostname.'
description: ''
example: laptop-1.local
nullable: false
-
in: query
name: 'filter[tags][]'
description: ''
example: 'New,Old'
required: false
schema:
type: 'Filter assets by their tags.'
description: ''
example: 'New,Old'
nullable: false
-
in: query
name: 'filter[licensed]'
description: ''
example: 'true,false'
required: false
schema:
type: 'Filter assets by licensed status.'
description: ''
example: 'true,false'
nullable: false
-
in: query
name: sort
description: ''
example: licensed
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: licensed
nullable: false
enum:
- name
- host
- last_seen
- licensed
-
in: query
name: include
description: ''
example: tags
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: tags
nullable: false
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a04676c8-9074-447f-8ff6-da58b04fe189
company_id: '4963690'
name: 'Michel Heidenreich'
identifier: 'F2:93:C6:57:E0:FF'
host: 99.13.8.245
mac_address: 'F2:93:C6:57:E0:FF'
hostname: labadie.com
operating_system: hic
operating_system_name: fuga
first_seen: '2006-03-20T15:05:28.000000Z'
last_seen: '2002-06-05T11:23:31.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: null
-
id: a04676c8-93fd-4250-a720-b472c3e98342
company_id: '4492034'
name: 'Barbara Auer'
identifier: 'CD:5F:D6:1B:42:A8'
host: 10.128.219.4
mac_address: 'CD:5F:D6:1B:42:A8'
hostname: von.com
operating_system: dolorem
operating_system_name: est
first_seen: '2024-07-20T12:46:12.000000Z'
last_seen: '1982-04-13T23:31:28.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2025-11-09T08:45:34.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-9074-447f-8ff6-da58b04fe189
company_id: '4963690'
name: 'Michel Heidenreich'
identifier: 'F2:93:C6:57:E0:FF'
host: 99.13.8.245
mac_address: 'F2:93:C6:57:E0:FF'
hostname: labadie.com
operating_system: hic
operating_system_name: fuga
first_seen: '2006-03-20T15:05:28.000000Z'
last_seen: '2002-06-05T11:23:31.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: null
-
id: a04676c8-93fd-4250-a720-b472c3e98342
company_id: '4492034'
name: 'Barbara Auer'
identifier: 'CD:5F:D6:1B:42:A8'
host: 10.128.219.4
mac_address: 'CD:5F:D6:1B:42:A8'
hostname: von.com
operating_system: dolorem
operating_system_name: est
first_seen: '2024-07-20T12:46:12.000000Z'
last_seen: '1982-04-13T23:31:28.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2025-11-09T08:45:34.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-9074-447f-8ff6-da58b04fe189
company_id:
type: string
example: '4963690'
name:
type: string
example: 'Michel Heidenreich'
identifier:
type: string
example: 'F2:93:C6:57:E0:FF'
host:
type: string
example: 99.13.8.245
mac_address:
type: string
example: 'F2:93:C6:57:E0:FF'
hostname:
type: string
example: labadie.com
operating_system:
type: string
example: hic
operating_system_name:
type: string
example: fuga
first_seen:
type: string
example: '2006-03-20T15:05:28.000000Z'
last_seen:
type: string
example: '2002-06-05T11:23:31.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: null
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Assets
post:
summary: 'Create asset.'
operationId: createAsset
description: "Will create a new asset for the current company. \n "
parameters: []
responses:
200:
description: 'Successfully created asset'
content:
application/json:
schema:
type: object
example:
data:
id: a04676c8-9c6b-4230-9d27-257398bce9ae
company_id: '6427674'
name: 'Kari Kub'
identifier: '44:06:13:EE:99:4F'
host: 108.87.96.61
mac_address: '44:06:13:EE:99:4F'
hostname: breitenberg.com
operating_system: iure
operating_system_name: numquam
first_seen: '1970-10-08T17:27:53.000000Z'
last_seen: '1976-02-04T23:53:27.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2025-11-18T11:48:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-9c6b-4230-9d27-257398bce9ae
company_id:
type: string
example: '6427674'
name:
type: string
example: 'Kari Kub'
identifier:
type: string
example: '44:06:13:EE:99:4F'
host:
type: string
example: 108.87.96.61
mac_address:
type: string
example: '44:06:13:EE:99:4F'
hostname:
type: string
example: breitenberg.com
operating_system:
type: string
example: iure
operating_system_name:
type: string
example: numquam
first_seen:
type: string
example: '1970-10-08T17:27:53.000000Z'
last_seen:
type: string
example: '1976-02-04T23:53:27.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2025-11-18T11:48:28.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: saotlmnbgsteyurplcd
nullable: false
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: consequuntur
nullable: false
licensed:
type: boolean
description: ''
example: true
nullable: false
required:
- name
- host
/v1/assets/actions:
patch:
summary: 'Bulk asset action.'
operationId: bulkAssetAction
description: "Will perform a bulk action on assets (Add Tags, Remove Tags or delete). \n "
parameters: []
responses:
204:
description: 'bulk action performed successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Assets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: 'Must have at least 1 items.'
example:
- []
items:
type: object
properties:
action:
type: string
description: ''
example: removeTags
nullable: false
enum:
- addTags
- removeTags
- delete
- assignLicense
- removeLicense
id:
type: string
description: ''
example: et
nullable: false
data:
type: object
description: ''
example: []
nullable: false
properties:
tags:
type: object
description: ''
example: null
nullable: false
properties: { }
required:
- action
- id
required:
- data
'/v1/assets/{id}':
get:
summary: 'Retrieve an asset.'
operationId: retrieveAnAsset
description: " Retrieves an asset by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: 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: a04676c8-a2ad-4fa6-b84d-73a09369a45f
company_id: '3406096'
name: 'Mrs. Alverta Maggio'
identifier: 'B9:7A:FC:57:55:65'
host: 76.97.215.193
mac_address: 'B9:7A:FC:57:55:65'
hostname: feeney.info
operating_system: molestiae
operating_system_name: dolor
first_seen: '1997-09-10T18:39:50.000000Z'
last_seen: '2007-03-15T15:43:18.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2025-11-30T02:07:17.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-a2ad-4fa6-b84d-73a09369a45f
company_id:
type: string
example: '3406096'
name:
type: string
example: 'Mrs. Alverta Maggio'
identifier:
type: string
example: 'B9:7A:FC:57:55:65'
host:
type: string
example: 76.97.215.193
mac_address:
type: string
example: 'B9:7A:FC:57:55:65'
hostname:
type: string
example: feeney.info
operating_system:
type: string
example: molestiae
operating_system_name:
type: string
example: dolor
first_seen:
type: string
example: '1997-09-10T18:39:50.000000Z'
last_seen:
type: string
example: '2007-03-15T15:43: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
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2025-11-30T02:07:17.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: a04676c8-a79c-4379-9031-fc866b195a63
company_id: '8577504'
name: 'Destini Wehner'
identifier: '46:4E:B9:87:A4:DF'
host: 149.49.236.16
mac_address: '46:4E:B9:87:A4:DF'
hostname: fay.com
operating_system: est
operating_system_name: et
first_seen: '2024-08-27T03:02:21.000000Z'
last_seen: '1989-08-02T15:26:14.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: '2025-11-22T21:36:57.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-a79c-4379-9031-fc866b195a63
company_id:
type: string
example: '8577504'
name:
type: string
example: 'Destini Wehner'
identifier:
type: string
example: '46:4E:B9:87:A4:DF'
host:
type: string
example: 149.49.236.16
mac_address:
type: string
example: '46:4E:B9:87:A4:DF'
hostname:
type: string
example: fay.com
operating_system:
type: string
example: est
operating_system_name:
type: string
example: et
first_seen:
type: string
example: '2024-08-27T03:02:21.000000Z'
last_seen:
type: string
example: '1989-08-02T15:26:14.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2025-11-22T21:36:57.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: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: dglidrmm
nullable: false
licensed:
type: boolean
description: ''
example: false
nullable: false
delete:
summary: 'Delete asset.'
operationId: deleteAsset
description: "Will delete an existing asset \n "
parameters: []
responses:
204:
description: 'asset deleted successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Assets
parameters:
-
in: path
name: id
description: 'The ID of the asset.'
example: quaerat
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: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
nullable: false
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a04676c8-b09f-407c-accc-deee4d4bb578
company_id: '1259221'
common_name: hartmann.com
organization: null
organizational_unit: Ltd
locality: 'North Marina'
state: Wisconsin
country: TK
serial: QNACP4WQQGWFQ8AKEBKW92AOLSCSHTJE
not_valid_before: 20231115T192944Z
not_valid_after: 20251110T155819Z
value: "-----BEGIN CERTIFICATE-----\nenzDdlql+ltiK2hl/53Jl4hHgiFQ3N7PgyVmRZUN+RV4u5JKqrHzRo20IipGnsSX\nd7zwzKCWV0DfNSSuvpo9Cu1seHk7onHSdONhLnTbtim0g+jMMRpRGsMmZ+05LqXc\n9XUPGqd24G/JrdButwAatMgS3usniw2Y2yl0InNQouT5WhO6o2jaCOSGs+LAT+9o\nmCA0aJ+pmXh5e4oYWGeWJmBf4LeKs5T/yXuzfSAaghWL46axgFe2vNERM0ire6jl\nUsOls748T1N7FMcPHSOGwJNJwuqGa3tYVKgkAx8sXSs4d8mQz63fBanP2VVYU+1w\nqnsrphTQwWv99hhJ/X/NhqVzWijpqiYHY6/DSWzX8gOLkQRtKD5Lc8q/IkNH3RJn\nxgFIploo8PPetEsJY3/lgccCgUrhhPJsmxWhkIetHPuqpp2qVIe6fQBfyx3R+7qL\nxbD8+XDgCAiKlzkIVU0goDMyF/uYjmfNV0aSgHwOoxl4mdyTwbGgAfadnbQhz+ga\nie/QzkufezWUO1OLpZviHL3KCBmwSbUoACTOLy9naiWxkoitMuQTx7TF6ZHLLcRh\nOX158pKEGGyKjwtAk5IILdvfbuSDpB4YZS2vAgvtBSDuO1vEt46xfzEDNXrGN2zy\ngGnT3CnIMvJxDbH9cLNTJ1VMKv42X8A0WB6sr1Fo2+vlsR7wC+/l5WBjWR/3SbvP\nIT2yeSAhnoHyOyQctHN46WYP8nf8qXAph/9hZ0PX3kHsjF3Ie7Rhu0FlROrp/cri\nq6Zi5B9QMNzdIAURgNdvtNG+hERCybk2gyCVh1F0FhPO1I/c7FHJqSarl/tEc5/O\nU6s2E8qgex+r1saIekn6Wws4yeEsulsZ/zQ9aLkxTvIdDn65YsZ2JKWj1zXK97wL\nJa/6R1HqX+IW7S/pDu+FgodNdhMXPsoTG1AUk+wKpOC6o3l0gWcEUhtelF/orIzL\nKldSIUpGEb8tsXLsmSc2wH+Rou8PRgJbJIVCIs5Jy+PV/NJIX3HkdZ/dQGBYdVNf\nH2T4oDWWEqt7KIOHe/arbjJfOohI6VKycIKuFD+tgZklS80AtZwIyUnaMS1gezHh\nAn4tydXVfurMJp5ijSxvAAtHCVna9GIeTZdYmqJtQagpv0kq3C4VCFIsIVk0enPT\nL+3NptBCTk+7kSsAkjvDxxzuzepA9EuiW8gpMsWEHeQrHIh4Ibr5thTf8MLNcphQ\nnvOE8uTEUTWVbo2U6Yj1YiLDH/fB5nkKEZqEHjGFIR67HbnTJ3iYpFxQE20eSDO5\nqXTRNjxwmVkiz2aBXVa9+mLyAgXvBkZRUsddQIB73ipmLJxYzTI3c6rZKHzEk4YE\nq0lpV0bw23EQ97MyGkLBuQ==\n\n-----END CERTIFICATE-----"
first_seen: '2024-03-14T00:56:20.000000Z'
last_seen: '2024-08-08T02:18:24.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-b3b2-444d-9d32-fa9ee4cb7fb4
company_id: '6555194'
common_name: will.com
organization: 'Bergstrom PLC'
organizational_unit: Group
locality: Erikview
state: null
country: PH
serial: N8MRBLTZDTDDIW3KC2EG1FBIYV4SZTLX
not_valid_before: 20241026T094638Z
not_valid_after: 20271016T224202Z
value: "-----BEGIN CERTIFICATE-----\nZKMTajmMFWf5yweczfoJG1Fu26FhZrxXubU97icn1wRhfne/QsbP67NX7aEPPyHi\nihakLkwe6fRxQsfkZS7RvugUY8KH9MZcTjhGIHABl0e59qxHlQuYlNpDC2JDlh7u\nJcLrq0mlx6FP2J+pS5c7SvJTDV+CP2qN3bPBVoGR4jkWLnGYg5CHWGq8Z2MBrKUT\nOBvMbQpixn4hsFVxfH0ALMdZUVRbLLoy1JWrKqen3Q+rcW81YFJ++6rgw49VnOQn\n0cOHbCH6o2/5DnwMySpuV8GeE1wNvHSmVZ7sCDlc6t5Yz3h+9vDxM3/8ILC86f2A\nmK8XiWIYDjyxcP+RNMEokNtaWtIlR8taJJuXJGaHJxervmHcBrgtiDdDeO+frjyk\ntN7G3hhfQUkwSDqCMXgCZdhpCEFC8mtk+doCHM2qgomSXMhEBDq0IgaigaS77YoL\nP85TLC8XAHj21/D8ctSZqJ1FHR3LSkrxsKtusfmpL1m+lB8dEHs1WttDIzs5mUVx\nYiWo7ULwrw33c4lI1UwtW0cobeB2mE7S1UYvA6YzaoWxDkEiTVjqhSMcnEqlBDZ6\nUl4uqpuy0I+LFa4VMcxMEylopYfyEWmZU+68POpMivLgLrm6zEvYxMMydvvCsUYp\nDDn2qlfXbKEeMeWVplNuo8QDIZtEo4hJHbChPxdGV6/dqgI4IkRoSbZL1ShSKHVo\nLxyJxxxDfhRkKOz4KVBikf3se2fIg3/QPywMjnRevUcT09rk3H7pxPnRX7gy9rbe\nXeax07xoDZAw8QrfaCO5LSwvhXfnzW7GYWnXNXwIhEIzZlNgNNHvQeDFJFwaETkQ\nfK6AqU8rBzrbg2JrtORDDWdsQETGjKtI6L35u0VGIvphYsmYnSTVln0ACa+79cRp\nlxFWhk+iihlmlTUzQLuMx+Kn6zBqkoWKMWL0rAzdRH1zIBLzlDFxZCcAoajyg6/Z\n5hexXeKIgzUt0W02foRS6clD/K2Vb/TewZBK0a24+ZLgU7IqZWhva28D//xKWtv/\n2ZkTiz1afn+aMVwsIcCMBE+LDLRjKvlOMTl/3vtGVGtP0ErSPKCwEp3oTQXfSEn4\nkA8iODqR3rlUcAJsvtE4AQrqQZuVEdZs7xJ14TkiA97yjjeSuZsqlTQ7vuKcRjJ5\nSJF/TmpcHDRDaYxsGpEucu9hUg3LmZSFGtdzkNKibEA3RyV6ibObeYzNi4C2c80Y\nkTgDa0ecI5qTdyGhQriJImwEQoYjYgrdZVO/gIB1iLOChqmanguTFwOYJTD5vGJb\nua9TlJijhsCz0GuLr4u9afq6g75rC/fIG/1GXg/Akt+lxxntgn+MaOjpUnjyfVJj\nO+xc+4QoLZzsqjalYH0PqA==\n\n-----END CERTIFICATE-----"
first_seen: '2024-11-22T20:03:14.000000Z'
last_seen: '2024-11-30T17:52:58.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-b09f-407c-accc-deee4d4bb578
company_id: '1259221'
common_name: hartmann.com
organization: null
organizational_unit: Ltd
locality: 'North Marina'
state: Wisconsin
country: TK
serial: QNACP4WQQGWFQ8AKEBKW92AOLSCSHTJE
not_valid_before: 20231115T192944Z
not_valid_after: 20251110T155819Z
value: "-----BEGIN CERTIFICATE-----\nenzDdlql+ltiK2hl/53Jl4hHgiFQ3N7PgyVmRZUN+RV4u5JKqrHzRo20IipGnsSX\nd7zwzKCWV0DfNSSuvpo9Cu1seHk7onHSdONhLnTbtim0g+jMMRpRGsMmZ+05LqXc\n9XUPGqd24G/JrdButwAatMgS3usniw2Y2yl0InNQouT5WhO6o2jaCOSGs+LAT+9o\nmCA0aJ+pmXh5e4oYWGeWJmBf4LeKs5T/yXuzfSAaghWL46axgFe2vNERM0ire6jl\nUsOls748T1N7FMcPHSOGwJNJwuqGa3tYVKgkAx8sXSs4d8mQz63fBanP2VVYU+1w\nqnsrphTQwWv99hhJ/X/NhqVzWijpqiYHY6/DSWzX8gOLkQRtKD5Lc8q/IkNH3RJn\nxgFIploo8PPetEsJY3/lgccCgUrhhPJsmxWhkIetHPuqpp2qVIe6fQBfyx3R+7qL\nxbD8+XDgCAiKlzkIVU0goDMyF/uYjmfNV0aSgHwOoxl4mdyTwbGgAfadnbQhz+ga\nie/QzkufezWUO1OLpZviHL3KCBmwSbUoACTOLy9naiWxkoitMuQTx7TF6ZHLLcRh\nOX158pKEGGyKjwtAk5IILdvfbuSDpB4YZS2vAgvtBSDuO1vEt46xfzEDNXrGN2zy\ngGnT3CnIMvJxDbH9cLNTJ1VMKv42X8A0WB6sr1Fo2+vlsR7wC+/l5WBjWR/3SbvP\nIT2yeSAhnoHyOyQctHN46WYP8nf8qXAph/9hZ0PX3kHsjF3Ie7Rhu0FlROrp/cri\nq6Zi5B9QMNzdIAURgNdvtNG+hERCybk2gyCVh1F0FhPO1I/c7FHJqSarl/tEc5/O\nU6s2E8qgex+r1saIekn6Wws4yeEsulsZ/zQ9aLkxTvIdDn65YsZ2JKWj1zXK97wL\nJa/6R1HqX+IW7S/pDu+FgodNdhMXPsoTG1AUk+wKpOC6o3l0gWcEUhtelF/orIzL\nKldSIUpGEb8tsXLsmSc2wH+Rou8PRgJbJIVCIs5Jy+PV/NJIX3HkdZ/dQGBYdVNf\nH2T4oDWWEqt7KIOHe/arbjJfOohI6VKycIKuFD+tgZklS80AtZwIyUnaMS1gezHh\nAn4tydXVfurMJp5ijSxvAAtHCVna9GIeTZdYmqJtQagpv0kq3C4VCFIsIVk0enPT\nL+3NptBCTk+7kSsAkjvDxxzuzepA9EuiW8gpMsWEHeQrHIh4Ibr5thTf8MLNcphQ\nnvOE8uTEUTWVbo2U6Yj1YiLDH/fB5nkKEZqEHjGFIR67HbnTJ3iYpFxQE20eSDO5\nqXTRNjxwmVkiz2aBXVa9+mLyAgXvBkZRUsddQIB73ipmLJxYzTI3c6rZKHzEk4YE\nq0lpV0bw23EQ97MyGkLBuQ==\n\n-----END CERTIFICATE-----"
first_seen: '2024-03-14T00:56:20.000000Z'
last_seen: '2024-08-08T02:18:24.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-b3b2-444d-9d32-fa9ee4cb7fb4
company_id: '6555194'
common_name: will.com
organization: 'Bergstrom PLC'
organizational_unit: Group
locality: Erikview
state: null
country: PH
serial: N8MRBLTZDTDDIW3KC2EG1FBIYV4SZTLX
not_valid_before: 20241026T094638Z
not_valid_after: 20271016T224202Z
value: "-----BEGIN CERTIFICATE-----\nZKMTajmMFWf5yweczfoJG1Fu26FhZrxXubU97icn1wRhfne/QsbP67NX7aEPPyHi\nihakLkwe6fRxQsfkZS7RvugUY8KH9MZcTjhGIHABl0e59qxHlQuYlNpDC2JDlh7u\nJcLrq0mlx6FP2J+pS5c7SvJTDV+CP2qN3bPBVoGR4jkWLnGYg5CHWGq8Z2MBrKUT\nOBvMbQpixn4hsFVxfH0ALMdZUVRbLLoy1JWrKqen3Q+rcW81YFJ++6rgw49VnOQn\n0cOHbCH6o2/5DnwMySpuV8GeE1wNvHSmVZ7sCDlc6t5Yz3h+9vDxM3/8ILC86f2A\nmK8XiWIYDjyxcP+RNMEokNtaWtIlR8taJJuXJGaHJxervmHcBrgtiDdDeO+frjyk\ntN7G3hhfQUkwSDqCMXgCZdhpCEFC8mtk+doCHM2qgomSXMhEBDq0IgaigaS77YoL\nP85TLC8XAHj21/D8ctSZqJ1FHR3LSkrxsKtusfmpL1m+lB8dEHs1WttDIzs5mUVx\nYiWo7ULwrw33c4lI1UwtW0cobeB2mE7S1UYvA6YzaoWxDkEiTVjqhSMcnEqlBDZ6\nUl4uqpuy0I+LFa4VMcxMEylopYfyEWmZU+68POpMivLgLrm6zEvYxMMydvvCsUYp\nDDn2qlfXbKEeMeWVplNuo8QDIZtEo4hJHbChPxdGV6/dqgI4IkRoSbZL1ShSKHVo\nLxyJxxxDfhRkKOz4KVBikf3se2fIg3/QPywMjnRevUcT09rk3H7pxPnRX7gy9rbe\nXeax07xoDZAw8QrfaCO5LSwvhXfnzW7GYWnXNXwIhEIzZlNgNNHvQeDFJFwaETkQ\nfK6AqU8rBzrbg2JrtORDDWdsQETGjKtI6L35u0VGIvphYsmYnSTVln0ACa+79cRp\nlxFWhk+iihlmlTUzQLuMx+Kn6zBqkoWKMWL0rAzdRH1zIBLzlDFxZCcAoajyg6/Z\n5hexXeKIgzUt0W02foRS6clD/K2Vb/TewZBK0a24+ZLgU7IqZWhva28D//xKWtv/\n2ZkTiz1afn+aMVwsIcCMBE+LDLRjKvlOMTl/3vtGVGtP0ErSPKCwEp3oTQXfSEn4\nkA8iODqR3rlUcAJsvtE4AQrqQZuVEdZs7xJ14TkiA97yjjeSuZsqlTQ7vuKcRjJ5\nSJF/TmpcHDRDaYxsGpEucu9hUg3LmZSFGtdzkNKibEA3RyV6ibObeYzNi4C2c80Y\nkTgDa0ecI5qTdyGhQriJImwEQoYjYgrdZVO/gIB1iLOChqmanguTFwOYJTD5vGJb\nua9TlJijhsCz0GuLr4u9afq6g75rC/fIG/1GXg/Akt+lxxntgn+MaOjpUnjyfVJj\nO+xc+4QoLZzsqjalYH0PqA==\n\n-----END CERTIFICATE-----"
first_seen: '2024-11-22T20:03:14.000000Z'
last_seen: '2024-11-30T17:52:58.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-b09f-407c-accc-deee4d4bb578
company_id:
type: string
example: '1259221'
common_name:
type: string
example: hartmann.com
organization:
type: string
example: null
organizational_unit:
type: string
example: Ltd
locality:
type: string
example: 'North Marina'
state:
type: string
example: Wisconsin
country:
type: string
example: TK
serial:
type: string
example: QNACP4WQQGWFQ8AKEBKW92AOLSCSHTJE
not_valid_before:
type: string
example: 20231115T192944Z
not_valid_after:
type: string
example: 20251110T155819Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nenzDdlql+ltiK2hl/53Jl4hHgiFQ3N7PgyVmRZUN+RV4u5JKqrHzRo20IipGnsSX\nd7zwzKCWV0DfNSSuvpo9Cu1seHk7onHSdONhLnTbtim0g+jMMRpRGsMmZ+05LqXc\n9XUPGqd24G/JrdButwAatMgS3usniw2Y2yl0InNQouT5WhO6o2jaCOSGs+LAT+9o\nmCA0aJ+pmXh5e4oYWGeWJmBf4LeKs5T/yXuzfSAaghWL46axgFe2vNERM0ire6jl\nUsOls748T1N7FMcPHSOGwJNJwuqGa3tYVKgkAx8sXSs4d8mQz63fBanP2VVYU+1w\nqnsrphTQwWv99hhJ/X/NhqVzWijpqiYHY6/DSWzX8gOLkQRtKD5Lc8q/IkNH3RJn\nxgFIploo8PPetEsJY3/lgccCgUrhhPJsmxWhkIetHPuqpp2qVIe6fQBfyx3R+7qL\nxbD8+XDgCAiKlzkIVU0goDMyF/uYjmfNV0aSgHwOoxl4mdyTwbGgAfadnbQhz+ga\nie/QzkufezWUO1OLpZviHL3KCBmwSbUoACTOLy9naiWxkoitMuQTx7TF6ZHLLcRh\nOX158pKEGGyKjwtAk5IILdvfbuSDpB4YZS2vAgvtBSDuO1vEt46xfzEDNXrGN2zy\ngGnT3CnIMvJxDbH9cLNTJ1VMKv42X8A0WB6sr1Fo2+vlsR7wC+/l5WBjWR/3SbvP\nIT2yeSAhnoHyOyQctHN46WYP8nf8qXAph/9hZ0PX3kHsjF3Ie7Rhu0FlROrp/cri\nq6Zi5B9QMNzdIAURgNdvtNG+hERCybk2gyCVh1F0FhPO1I/c7FHJqSarl/tEc5/O\nU6s2E8qgex+r1saIekn6Wws4yeEsulsZ/zQ9aLkxTvIdDn65YsZ2JKWj1zXK97wL\nJa/6R1HqX+IW7S/pDu+FgodNdhMXPsoTG1AUk+wKpOC6o3l0gWcEUhtelF/orIzL\nKldSIUpGEb8tsXLsmSc2wH+Rou8PRgJbJIVCIs5Jy+PV/NJIX3HkdZ/dQGBYdVNf\nH2T4oDWWEqt7KIOHe/arbjJfOohI6VKycIKuFD+tgZklS80AtZwIyUnaMS1gezHh\nAn4tydXVfurMJp5ijSxvAAtHCVna9GIeTZdYmqJtQagpv0kq3C4VCFIsIVk0enPT\nL+3NptBCTk+7kSsAkjvDxxzuzepA9EuiW8gpMsWEHeQrHIh4Ibr5thTf8MLNcphQ\nnvOE8uTEUTWVbo2U6Yj1YiLDH/fB5nkKEZqEHjGFIR67HbnTJ3iYpFxQE20eSDO5\nqXTRNjxwmVkiz2aBXVa9+mLyAgXvBkZRUsddQIB73ipmLJxYzTI3c6rZKHzEk4YE\nq0lpV0bw23EQ97MyGkLBuQ==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2024-03-14T00:56:20.000000Z'
last_seen:
type: string
example: '2024-08-08T02:18:24.000000Z'
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Certificates
/v1/certificates/export:
get:
summary: 'Export certificates.'
operationId: exportCertificates
description: " Export all certificates for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: csv
required: true
schema:
type: 'The type of export to generate'
description: ''
example: csv
nullable: false
enum:
- csv
- xlsx
-
in: query
name: 'filter[common_name]'
description: ''
example: test.nl
required: false
schema:
type: 'Filter certificates by their common name.'
description: ''
example: test.nl
nullable: false
-
in: query
name: 'filter[organization]'
description: ''
example: 'Test B.V.'
required: false
schema:
type: 'Filter certificates by their organization name.'
description: ''
example: 'Test B.V.'
nullable: false
-
in: query
name: sort
description: ''
example: not_valid_after
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before'
description: ''
example: not_valid_after
nullable: false
enum:
- not_valid_after
-
in: query
name: filter
description: ''
example: common_name
required: false
schema:
type: 'The column(s) to filter by. Eg filter=common_name:test.nl'
description: ''
example: common_name
nullable: false
enum:
- common_name
- organization
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Certificates
'/v1/certificates/{id}':
get:
summary: 'Retrieve a certificate.'
operationId: retrieveACertificate
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
nullable: false
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: 'Successfully retrieved certificate'
content:
application/json:
schema:
type: object
example:
data:
id: a04676c8-ba1a-4dd4-b262-0f10e4e58eda
company_id: '6673776'
common_name: rogahn.com
organization: null
organizational_unit: null
locality: null
state: Montana
country: null
serial: ZV6CXWOLRHXQ0ZKQLMQBSKKN0BMMQLSS
not_valid_before: 20250406T012258Z
not_valid_after: 20260915T155330Z
value: "-----BEGIN CERTIFICATE-----\nX16Btex2sVfN+I7ESSTsPHeQ8TQsJgpVt1dT0vrDNABKIQ9dhPs2JmMXUplEd8ij\nkZzkOokO/Dkh2xqT92/gjeMGfTnOP4oYGZBx9Kkdn6m7MtdUJze71KlY9fU2uJuF\ncR30VvI+X1H1qdCivD5NAdwM2yJDy2Arno84jZY1uiLExiK7vwKa/1MobFJ+++/o\nHg0Ct9JVPht1gcK74fWO5TCW5IsQYuMcqNHhl+rAlNwYCq3wmSIw8m1z3eu5f2Eu\ntrknsG4J5/LLuhkKV6Ka4Goe9sWi1Qx6GSDCBHVzV3w1lbGM+BYlS+y8y4Qku+Le\njqjSr8sAphPsXLauP8an0nBnO2BdAySZFSIYVLhQn9g8RYbJJpQN88RKrf7VwwCb\npsxwabyK5FqaL+xInWMUAfvL+Xaey13NPP/egLU5OUJwe13eep8xu7phSPleUEAf\nOToMmDLxOff6sOSzVgAGspQagYercDzQ/0bagQaUAS25TMKItVLfFD1M3kDMqw57\ng97JpOAoNFWHD5jgb07FVi2rrndH6ZiG+1lXukap1lu6ZkLizgBR+2EaPrnqTlQQ\nlZYvuCqKK96zTTWezlh/LBbw/m8EGHbmIt3S2IXeiY2H47eMq6k7VNWDcubM7hMK\n/arss040KbW1+cgiAV4l6kxLkehpP4uYyOVkbPqSRV8ts7T3XFH7NYulS5mFik+8\nxvfQfJvIL1ZHNbiiBBWeX9MldnHEl3cSRzGI4oexDOkLV9pC1jpisWuh6LKPxeOW\nf3QRlxm+DvmAsIEe6PLW4y7qrHidgt5z1X0Jwk/8hL8dDweh3haonhgxPL8n3jYq\nGXwGm3CxQjEr09ISEg+22vPtE1H8RaJLcIOWvQws17B/z7PeD0tX8CEU6gIcxvcx\neNmPQGfz+7AxutaqUOb389alkMzt0W2ohXjUByFQ48cWRWAZhgRkghoqTgLbiBEu\nwjjk6upfwvrz+11AMLCC/rxBBE9aiwATnsJv6pm1WWPEQTS9lNZjMulGB4WmGeqX\nDQg9sL5GNilrcMLLSBFJdM5lEOSUOEU4qDO343FyAtq3K0lcwQEJXIP/c+h02qcM\nT8613Wrj8MD1zQzT5xlYKTDwkSF3a8YgvAgzQcbLkFmw1TiS5m8APdUyiuWHsqZI\nnl1PczwFXqEu9b2SmOi6v8DlSiko7nw+79tzqiSKME5MVtSkn++ABV6S0Jw07BK0\njYEgQLAjYHg42W/IxJZpRBdTJEnPZGu9Fd0Fjt6c9On62RTxYfhPaq4frGlhQoOZ\narUJXJkjOwyFh2lLezPThxo1PyLJi8XnD1YIKvJU6Jbprd+k2zxuww9hoKPXspWp\nQayn7FOpQkRBunuuzr5+ZQ==\n\n-----END CERTIFICATE-----"
first_seen: '2025-06-30T22:24:14.000000Z'
last_seen: '2025-09-03T12:22:08.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-ba1a-4dd4-b262-0f10e4e58eda
company_id:
type: string
example: '6673776'
common_name:
type: string
example: rogahn.com
organization:
type: string
example: null
organizational_unit:
type: string
example: null
locality:
type: string
example: null
state:
type: string
example: Montana
country:
type: string
example: null
serial:
type: string
example: ZV6CXWOLRHXQ0ZKQLMQBSKKN0BMMQLSS
not_valid_before:
type: string
example: 20250406T012258Z
not_valid_after:
type: string
example: 20260915T155330Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nX16Btex2sVfN+I7ESSTsPHeQ8TQsJgpVt1dT0vrDNABKIQ9dhPs2JmMXUplEd8ij\nkZzkOokO/Dkh2xqT92/gjeMGfTnOP4oYGZBx9Kkdn6m7MtdUJze71KlY9fU2uJuF\ncR30VvI+X1H1qdCivD5NAdwM2yJDy2Arno84jZY1uiLExiK7vwKa/1MobFJ+++/o\nHg0Ct9JVPht1gcK74fWO5TCW5IsQYuMcqNHhl+rAlNwYCq3wmSIw8m1z3eu5f2Eu\ntrknsG4J5/LLuhkKV6Ka4Goe9sWi1Qx6GSDCBHVzV3w1lbGM+BYlS+y8y4Qku+Le\njqjSr8sAphPsXLauP8an0nBnO2BdAySZFSIYVLhQn9g8RYbJJpQN88RKrf7VwwCb\npsxwabyK5FqaL+xInWMUAfvL+Xaey13NPP/egLU5OUJwe13eep8xu7phSPleUEAf\nOToMmDLxOff6sOSzVgAGspQagYercDzQ/0bagQaUAS25TMKItVLfFD1M3kDMqw57\ng97JpOAoNFWHD5jgb07FVi2rrndH6ZiG+1lXukap1lu6ZkLizgBR+2EaPrnqTlQQ\nlZYvuCqKK96zTTWezlh/LBbw/m8EGHbmIt3S2IXeiY2H47eMq6k7VNWDcubM7hMK\n/arss040KbW1+cgiAV4l6kxLkehpP4uYyOVkbPqSRV8ts7T3XFH7NYulS5mFik+8\nxvfQfJvIL1ZHNbiiBBWeX9MldnHEl3cSRzGI4oexDOkLV9pC1jpisWuh6LKPxeOW\nf3QRlxm+DvmAsIEe6PLW4y7qrHidgt5z1X0Jwk/8hL8dDweh3haonhgxPL8n3jYq\nGXwGm3CxQjEr09ISEg+22vPtE1H8RaJLcIOWvQws17B/z7PeD0tX8CEU6gIcxvcx\neNmPQGfz+7AxutaqUOb389alkMzt0W2ohXjUByFQ48cWRWAZhgRkghoqTgLbiBEu\nwjjk6upfwvrz+11AMLCC/rxBBE9aiwATnsJv6pm1WWPEQTS9lNZjMulGB4WmGeqX\nDQg9sL5GNilrcMLLSBFJdM5lEOSUOEU4qDO343FyAtq3K0lcwQEJXIP/c+h02qcM\nT8613Wrj8MD1zQzT5xlYKTDwkSF3a8YgvAgzQcbLkFmw1TiS5m8APdUyiuWHsqZI\nnl1PczwFXqEu9b2SmOi6v8DlSiko7nw+79tzqiSKME5MVtSkn++ABV6S0Jw07BK0\njYEgQLAjYHg42W/IxJZpRBdTJEnPZGu9Fd0Fjt6c9On62RTxYfhPaq4frGlhQoOZ\narUJXJkjOwyFh2lLezPThxo1PyLJi8XnD1YIKvJU6Jbprd+k2zxuww9hoKPXspWp\nQayn7FOpQkRBunuuzr5+ZQ==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2025-06-30T22:24:14.000000Z'
last_seen:
type: string
example: '2025-09-03T12:22:08.000000Z'
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
tags:
- Certificates
delete:
summary: 'Delete certificate.'
operationId: deleteCertificate
description: " Will delete an existing certificate \n "
parameters: []
responses:
204:
description: 'certificate deleted successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Certificates
parameters:
-
in: path
name: id
description: 'The ID of the certificate.'
example: architecto
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: illo
required: true
schema:
type: string
/v1/integrations:
get:
summary: 'List Integrations'
operationId: listIntegrations
description: "Retrieve all enabled integrations for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '[{"autotask": {...}, "another_integration": {...}}]'
tags:
- Integrations
'/v1/integrations/{integration}':
post:
summary: 'Enable Integration'
operationId: enableIntegration
description: "Enable a new integration for the current company.\n"
parameters: []
responses:
201:
description: 'integration enabled'
content:
application/json:
schema:
type: object
example:
message: 'Integration enabled successfully'
properties:
message:
type: string
example: 'Integration enabled successfully'
400:
description: 'enable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to enable integration'
properties:
error:
type: string
example: 'Failed to enable integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
get:
summary: 'Show Integration'
operationId: showIntegration
description: "Retrieve details of a specific enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'integration not found'
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
-
description: 'integration not enabled'
type: object
example:
error: 'Integration not enabled'
properties:
error:
type: string
example: 'Integration not enabled'
tags:
- Integrations
patch:
summary: 'Update Integration'
operationId: updateIntegration
description: "Update the configuration of an enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
message: 'Integration updated successfully'
properties:
message:
type: string
example: 'Integration updated successfully'
400:
description: 'update failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to update integration'
properties:
error:
type: string
example: 'Failed to update integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
delete:
summary: 'Disable Integration'
operationId: disableIntegration
description: "Disable a specific integration for the current company.\n"
parameters: []
responses:
204:
description: 'disable successful'
content:
text/plain:
schema:
type: string
example: ''
400:
description: 'disable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to disable integration'
properties:
error:
type: string
example: 'Failed to disable integration'
tags:
- Integrations
parameters:
-
in: path
name: integration
description: 'The name of the integration to enable.'
example: autotask
required: true
schema:
type: string
/v1/me:
get:
summary: 'Retrieve the authenticated user'
operationId: retrieveTheAuthenticatedUser
description: 'Retrieves the authenticated user and its metadata.'
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany.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: 3d287c42-5b95-4c33-b8a2-9b07ffe24624
company_id: '4758549'
managing_company_id: '4758549'
first_name: Paolo
last_name: Mayert
two_factor_enabled: false
two_factor_configured: false
email: yesenia52@yahoo.com
email_verified_at: '2025-11-04T08:30:09Z'
phonenumber: +1-470-741-2420
phonenumber_verified_at: '2025-11-04T08:30:09Z'
report_interval: weekly
manageable_companies:
-
id: '4758549'
uuid: 53fdacd5-46fc-41de-b6c3-216172089b99
name: Corwin-Breitenberg
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2025-11-04T08:30:09Z'
sso_provider: null
created_at: '2025-11-04T08:30:09Z'
updated_at: '2025-11-04T08:30:09Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: 3d287c42-5b95-4c33-b8a2-9b07ffe24624
company_id:
type: string
example: '4758549'
managing_company_id:
type: string
example: '4758549'
first_name:
type: string
example: Paolo
last_name:
type: string
example: Mayert
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: yesenia52@yahoo.com
email_verified_at:
type: string
example: '2025-11-04T08:30:09Z'
phonenumber:
type: string
example: +1-470-741-2420
phonenumber_verified_at:
type: string
example: '2025-11-04T08:30:09Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '4758549'
uuid: 53fdacd5-46fc-41de-b6c3-216172089b99
name: Corwin-Breitenberg
items:
type: object
properties:
id:
type: string
example: '4758549'
uuid:
type: string
example: 53fdacd5-46fc-41de-b6c3-216172089b99
name:
type: string
example: Corwin-Breitenberg
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-11-04T08:30:09Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:09Z'
updated_at:
type: string
example: '2025-11-04T08:30:09Z'
links:
type: object
properties:
self:
type: string
example: 'http://api.securityhive.io/v1/me'
tags:
- Me
patch:
summary: 'Update the authenticated user'
operationId: updateTheAuthenticatedUser
description: 'Updates the authenticated user'
parameters: []
responses:
204:
description: 'update successful'
content:
text/plain:
schema:
type: string
example: ''
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Me
requestBody:
required: 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
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-11-04T08:30:09'
nullable: false
role:
type: string
description: 'Must be a valid role name.'
example: admin
nullable: false
/v1/tags:
get:
summary: 'List tags.'
operationId: listTags
description: " Retrieve all tags for the current company. Look at the 'Retrieve a tag' endpoint for more details on the tag object.\n "
parameters:
-
in: query
name: 'filter[name]'
description: ''
example: illum
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: illum
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: a04676c8-c218-4296-85a1-d46478182c79
company_id: '4210491'
name: 71f35649-4ae0-3c64-8da0-3e138ab33b65
description: 'Quos amet sunt praesentium harum enim. Cumque nisi voluptatem dolor ullam incidunt.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-c4ec-4170-8011-25a669471052
company_id: '8452048'
name: 591e9dec-429c-3c5d-8f69-8b7d4b1929ba
description: 'Dicta qui dignissimos voluptas voluptate dolorem aut. Dolores omnis autem et. Quae odit ut natus consequuntur quam accusamus facere.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-c218-4296-85a1-d46478182c79
company_id: '4210491'
name: 71f35649-4ae0-3c64-8da0-3e138ab33b65
description: 'Quos amet sunt praesentium harum enim. Cumque nisi voluptatem dolor ullam incidunt.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: a04676c8-c4ec-4170-8011-25a669471052
company_id: '8452048'
name: 591e9dec-429c-3c5d-8f69-8b7d4b1929ba
description: 'Dicta qui dignissimos voluptas voluptate dolorem aut. Dolores omnis autem et. Quae odit ut natus consequuntur quam accusamus facere.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-c218-4296-85a1-d46478182c79
company_id:
type: string
example: '4210491'
name:
type: string
example: 71f35649-4ae0-3c64-8da0-3e138ab33b65
description:
type: string
example: 'Quos amet sunt praesentium harum enim. Cumque nisi voluptatem dolor ullam incidunt.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Tags
post:
summary: 'Create tag.'
operationId: createTag
description: "Will create a new tag for the current company. \n "
parameters: []
responses:
201:
description: 'Successfully created tag'
content:
application/json:
schema:
type: object
example:
data:
id: a04676c8-c9ed-4081-8402-fea962f9195b
company_id: '6535756'
name: 885b4239-f24e-3d1c-bd50-68770e1a732a
description: 'Maxime ea harum assumenda labore ut explicabo. Est nihil asperiores vel quos eius. Quasi sit repellendus corrupti voluptas facere possimus. Ut rerum ut esse rerum.'
business_impact: low
system_tag: true
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-c9ed-4081-8402-fea962f9195b
company_id:
type: string
example: '6535756'
name:
type: string
example: 885b4239-f24e-3d1c-bd50-68770e1a732a
description:
type: string
example: 'Maxime ea harum assumenda labore ut explicabo. Est nihil asperiores vel quos eius. Quasi sit repellendus corrupti voluptas facere possimus. Ut rerum ut esse rerum.'
business_impact:
type: string
example: low
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.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: msuifpruyh
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Voluptatem repellat voluptatibus tempore modi aut error velit.'
nullable: false
business_impact:
type: string
description: ''
example: critical
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: a04676c8-cdc6-4aa3-84d8-65468d460354
company_id: '2061220'
name: c7aa7009-f056-3164-bd23-eda9b3cda287
description: 'Atque ipsa suscipit distinctio illum molestiae. Sequi neque recusandae ullam accusantium cumque assumenda magnam. Atque quis nesciunt aut aut. Nostrum est ut sapiente vel sunt error provident.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-cdc6-4aa3-84d8-65468d460354
company_id:
type: string
example: '2061220'
name:
type: string
example: c7aa7009-f056-3164-bd23-eda9b3cda287
description:
type: string
example: 'Atque ipsa suscipit distinctio illum molestiae. Sequi neque recusandae ullam accusantium cumque assumenda magnam. Atque quis nesciunt aut aut. Nostrum est ut sapiente vel sunt error provident.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.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: a04676c8-d25b-491f-b42d-a8107e57acd7
company_id: '1234653'
name: 4fad6282-7f49-3aa1-80e2-91fb016b06b1
description: 'Et ratione consequatur delectus dolores aliquam sit. Sapiente cumque eum itaque. Inventore fuga quaerat tempore consequatur temporibus.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-d25b-491f-b42d-a8107e57acd7
company_id:
type: string
example: '1234653'
name:
type: string
example: 4fad6282-7f49-3aa1-80e2-91fb016b06b1
description:
type: string
example: 'Et ratione consequatur delectus dolores aliquam sit. Sapiente cumque eum itaque. Inventore fuga quaerat tempore consequatur temporibus.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.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: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: wtqyric
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Eum atque alias distinctio sunt expedita similique quae.'
nullable: false
business_impact:
type: string
description: ''
example: low
nullable: false
enum:
- low
- medium
- high
- critical
delete:
summary: 'Delete tag.'
operationId: deleteTag
description: "Will delete an existing tag \n "
parameters: []
responses:
204:
description: 'tag deleted successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Tags
parameters:
-
in: path
name: id
description: 'The ID of the tag.'
example: sed
required: true
schema:
type: string
/v1/users:
get:
summary: 'List Users'
operationId: listUsers
description: "Retrieve all users for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany.type
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany.type
nullable: false
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
-
in: query
name: sort
description: 'Sort the results by column(s) (comma separated).'
example: 'first_name,-last_name'
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: 'first_name,-last_name'
nullable: false
enum:
- first_name
- last_name
- email
- phonenumber
- report_interval
- created_at
- two_factor_enabled
- role.title
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: 'first_name:John,last_name:Doe'
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: 'first_name:John,last_name:Doe'
nullable: false
enum:
- first_name
- last_name
- email
- phonenumber
- report_interval
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 5da34a37-c3fe-44ba-8445-a196897e4cf6
company_id: '881024'
managing_company_id: '881024'
first_name: Anabel
last_name: Schamberger
two_factor_enabled: false
email: rwisozk@hackett.com
email_verified_at: '2025-11-04T08:30:10.000000Z'
phonenumber: 1-231-271-0549
phonenumber_verified_at: '2025-11-04T08:30:10.000000Z'
report_interval: weekly
manageable_companies:
-
id: '881024'
uuid: 5a3a6dbb-a4dc-450a-a405-17771149c131
name: 'Stracke PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-11-04T08:30:10.000000Z'
sso_provider: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: 686bee89-b31a-442e-acf6-06bece8a374b
company_id: '9660208'
managing_company_id: '9660208'
first_name: Liliane
last_name: Blanda
two_factor_enabled: false
email: jannie.gottlieb@mcclure.com
email_verified_at: '2025-11-04T08:30:10.000000Z'
phonenumber: +1.928.994.3595
phonenumber_verified_at: '2025-11-04T08:30:10.000000Z'
report_interval: weekly
manageable_companies:
-
id: '9660208'
uuid: bb1aeae7-62d0-42e1-bb4a-ef74b926edee
name: 'Schneider PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-11-04T08:30:10.000000Z'
sso_provider: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: 5da34a37-c3fe-44ba-8445-a196897e4cf6
company_id: '881024'
managing_company_id: '881024'
first_name: Anabel
last_name: Schamberger
two_factor_enabled: false
email: rwisozk@hackett.com
email_verified_at: '2025-11-04T08:30:10.000000Z'
phonenumber: 1-231-271-0549
phonenumber_verified_at: '2025-11-04T08:30:10.000000Z'
report_interval: weekly
manageable_companies:
-
id: '881024'
uuid: 5a3a6dbb-a4dc-450a-a405-17771149c131
name: 'Stracke PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-11-04T08:30:10.000000Z'
sso_provider: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
-
id: 686bee89-b31a-442e-acf6-06bece8a374b
company_id: '9660208'
managing_company_id: '9660208'
first_name: Liliane
last_name: Blanda
two_factor_enabled: false
email: jannie.gottlieb@mcclure.com
email_verified_at: '2025-11-04T08:30:10.000000Z'
phonenumber: +1.928.994.3595
phonenumber_verified_at: '2025-11-04T08:30:10.000000Z'
report_interval: weekly
manageable_companies:
-
id: '9660208'
uuid: bb1aeae7-62d0-42e1-bb4a-ef74b926edee
name: 'Schneider PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-11-04T08:30:10.000000Z'
sso_provider: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
items:
type: object
properties:
id:
type: string
example: 5da34a37-c3fe-44ba-8445-a196897e4cf6
company_id:
type: string
example: '881024'
managing_company_id:
type: string
example: '881024'
first_name:
type: string
example: Anabel
last_name:
type: string
example: Schamberger
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: rwisozk@hackett.com
email_verified_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
phonenumber:
type: string
example: 1-231-271-0549
phonenumber_verified_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '881024'
uuid: 5a3a6dbb-a4dc-450a-a405-17771149c131
name: 'Stracke PLC'
items:
type: object
properties:
id:
type: string
example: '881024'
uuid:
type: string
example: 5a3a6dbb-a4dc-450a-a405-17771149c131
name:
type: string
example: 'Stracke PLC'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Users
post:
summary: 'Create User'
operationId: createUser
description: "Create a new user for the current company.\n"
parameters: []
responses:
201:
description: 'user created'
content:
application/json:
schema:
type: object
example:
data:
id: 1
uuid: 00000000-0000-0000-0000-000000000000
properties:
data:
type: object
properties:
id:
type: integer
example: 1
uuid:
type: string
example: 00000000-0000-0000-0000-000000000000
404:
description: 'role not found'
content:
application/json:
schema:
type: object
example:
message: 'role not found'
properties:
message:
type: string
example: 'role not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Must not be greater than 100 characters.'
example: yanqog
nullable: false
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: mmhxmdkkrzmvfvryqudhnnhf
nullable: false
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: edgar93@example.com
nullable: false
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: ''
example: monthly
nullable: false
enum:
- disabled
- weekly
- monthly
- quarterly
role:
type: required
description: 'string Must be a valid role name.'
example: admin
nullable: false
required:
- first_name
- last_name
- email
'/v1/users/{user_uuid}':
get:
summary: 'Retrieve an user'
operationId: retrieveAnUser
description: "Retrieves an user for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany
nullable: false
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: d7686498-61fe-4a10-9189-d8174d8e092c
company_id: '685242'
managing_company_id: '685242'
first_name: Estefania
last_name: Gleichner
two_factor_enabled: false
email: vmiller@huels.com
email_verified_at: '2025-11-04T08:30:10.000000Z'
phonenumber: 1-651-279-5479
phonenumber_verified_at: '2025-11-04T08:30:10.000000Z'
report_interval: weekly
manageable_companies:
-
id: '685242'
uuid: 12d6c2f7-de19-4cf8-b6fc-0294803b140d
name: 'Wolff, Sipes and Block'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2025-11-04T08:30:10.000000Z'
sso_provider: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:11.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: d7686498-61fe-4a10-9189-d8174d8e092c
company_id:
type: string
example: '685242'
managing_company_id:
type: string
example: '685242'
first_name:
type: string
example: Estefania
last_name:
type: string
example: Gleichner
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: vmiller@huels.com
email_verified_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
phonenumber:
type: string
example: 1-651-279-5479
phonenumber_verified_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '685242'
uuid: 12d6c2f7-de19-4cf8-b6fc-0294803b140d
name: 'Wolff, Sipes and Block'
items:
type: object
properties:
id:
type: string
example: '685242'
uuid:
type: string
example: 12d6c2f7-de19-4cf8-b6fc-0294803b140d
name:
type: string
example: 'Wolff, Sipes and Block'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:11.000000Z'
404:
description: 'user not found'
content:
application/json:
schema:
type: object
example:
message: 'user not found'
properties:
message:
type: string
example: 'user not found'
tags:
- Users
patch:
summary: 'Update an user'
operationId: updateAnUser
description: "Updates an user for the current company.\n"
parameters: []
responses:
204:
description: 'update successful'
content:
text/plain:
schema:
type: string
example: ''
403:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'invalid password'
type: object
example:
message: 'The old password is incorrect.'
properties:
message:
type: string
example: 'The old password is incorrect.'
-
description: 'change password of other user'
type: object
example:
message: 'You are not allowed to change the password of another user.'
properties:
message:
type: string
example: 'You are not allowed to change the password of another user.'
404:
description: 'user not found'
content:
application/json:
schema:
type: object
example:
message: 'user not found'
properties:
message:
type: string
example: 'user not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Users
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Must not be greater than 100 characters.'
example: John
nullable: false
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: Doe
nullable: false
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: john@doe.com
nullable: false
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.'
example: weekly
nullable: false
role:
type: string
description: 'Must be a valid role name.'
example: admin
nullable: false
parameters:
-
in: path
name: user_uuid
description: 'string The id of the user'
example: 56865b71-d015-3e1a-90cb-a82723132d54
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: Expired
required: false
schema:
type: 'Filter vulnerabilities by their status'
description: ''
example: Expired
nullable: false
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
-
in: query
name: 'filter[threat]'
description: ''
example: Low
required: false
schema:
type: 'Filter vulnerabilities by their threat level'
description: ''
example: Low
nullable: false
enum:
- Log
- Low
- Medium
- High
- Critical
-
in: query
name: 'filter[scan_id]'
description: ''
example: '123'
required: false
schema:
type: 'Filter vulnerabilities found by given scan_id'
description: ''
example: '123'
nullable: false
-
in: query
name: 'filter[family]'
description: ''
example: 'SQL Injection'
required: false
schema:
type: 'Filter vulnerabilities by their family'
description: ''
example: 'SQL Injection'
nullable: false
-
in: query
name: sort
description: ''
example: port
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: port
nullable: false
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a04676c8-6d56-4b0b-a35f-9e1c919c1b5c
asset_id: a04676c8-625e-40fb-96f1-cb21d82e813d
company_id: '3182423'
vulnerability_definition_id: a04676c8-6c84-4daf-964f-a1bfe0198a0c
vulnerability_definition:
id: a04676c8-6c84-4daf-964f-a1bfe0198a0c
name: 'Remote File Inclusion affecting voluptate functionality'
description: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
solution: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
category: 'Remote File Inclusion'
threat_level: Medium
definition_type: openvas
definition:
id: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name: 'Remote File Inclusion affecting voluptate functionality'
family: 'Remote File Inclusion'
reference_urls: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves: 'CVE-2017-6038, CVE-2015-1275'
solution_type: WorkAround
solution_description: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority: Low
qod_type: registry
qod_value: 2
cvss_base_score: 9
cvss_base_vector: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
epss: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
host: 194.65.255.148
hostname: quitzon.com
port: 5432/tcp
details: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
status: Expired
first_seen: '2025-05-29T08:26:26.000000Z'
last_seen: '2025-11-02T20:45:59.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
name: 'Remote File Inclusion affecting voluptate functionality'
description: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
cvss_base_score: 9
cvss_base_vector: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
qod_type: registry
qod_value: 2
threat: Medium
scanner_id: null
scanner_hostname: null
plugin:
id: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name: 'Remote File Inclusion affecting voluptate functionality'
family: 'Remote File Inclusion'
reference_urls: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves: 'CVE-2017-6038, CVE-2015-1275'
solution_type: WorkAround
solution_description: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority: Low
qod_type: registry
qod_value: 2
-
id: a04676c8-76f3-43a1-a532-e0ddd2ed55f8
asset_id: a04676c8-724a-4721-8399-0754259e7c1a
company_id: '2290927'
vulnerability_definition_id: a04676c8-766a-4fce-a0f8-9300caae1b21
vulnerability_definition:
id: a04676c8-766a-4fce-a0f8-9300caae1b21
name: '2 in quia'
description: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
solution: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
category: '2'
threat_level: Critical
definition_type: openvas
definition:
id: a04676c8-750b-4d0f-8c1b-e8e63218c6bb
o_id: 86b6d791-b8ea-3410-9e78-5847efa684c0
name: '2 in quia'
family: '2'
reference_urls: 'http://www.lesch.info/, https://www.moen.biz/doloremque-sit-autem-mollitia-aut'
reference_cves: 'CVE-2017-9436, CVE-2019-9314'
solution_type: 'Configuration Change'
solution_description: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
summary: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
insight: 'Nemo aut aut vitae odio. Qui rerum omnis laborum vel voluptas dolores consequatur.'
affected: 'Id vero repellendus ipsum dolor consequatur error. Ut quae aut eaque recusandae aut. Ut ut illum sed aut architecto iste. Voluptatem repellendus nihil beatae corrupti quo.'
impact: 'Quis sint ducimus exercitationem dolorem eum numquam. Repudiandae ut voluptas nisi non odit est numquam. Eos tenetur dolores consequatur in reprehenderit quis et.'
vuldetect: 'Eius laborum ad quia quas. Est soluta id aut est voluptas.'
priority: Low
qod_type: exploit
qod_value: 46
cvss_base_score: 5.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:N/I:P/A:P'
epss: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
host: 150.64.116.63
hostname: denesik.com
port: general/tcp
details: 'Eum odio occaecati omnis quos cumque est. Consequuntur veniam est sequi reprehenderit architecto debitis doloribus vel. Error omnis ipsa nulla qui iure consectetur. Aspernatur praesentium aut accusantium quos nesciunt.'
status: Accepted
first_seen: '2025-09-05T19:04:42.000000Z'
last_seen: '2025-09-23T20:43:54.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
name: '2 in quia'
description: 'Eum odio occaecati omnis quos cumque est. Consequuntur veniam est sequi reprehenderit architecto debitis doloribus vel. Error omnis ipsa nulla qui iure consectetur. Aspernatur praesentium aut accusantium quos nesciunt.'
cvss_base_score: 5.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:N/I:P/A:P'
qod_type: exploit
qod_value: 46
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a04676c8-750b-4d0f-8c1b-e8e63218c6bb
o_id: 86b6d791-b8ea-3410-9e78-5847efa684c0
name: '2 in quia'
family: '2'
reference_urls: 'http://www.lesch.info/, https://www.moen.biz/doloremque-sit-autem-mollitia-aut'
reference_cves: 'CVE-2017-9436, CVE-2019-9314'
solution_type: 'Configuration Change'
solution_description: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
summary: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
insight: 'Nemo aut aut vitae odio. Qui rerum omnis laborum vel voluptas dolores consequatur.'
affected: 'Id vero repellendus ipsum dolor consequatur error. Ut quae aut eaque recusandae aut. Ut ut illum sed aut architecto iste. Voluptatem repellendus nihil beatae corrupti quo.'
impact: 'Quis sint ducimus exercitationem dolorem eum numquam. Repudiandae ut voluptas nisi non odit est numquam. Eos tenetur dolores consequatur in reprehenderit quis et.'
vuldetect: 'Eius laborum ad quia quas. Est soluta id aut est voluptas.'
priority: Low
qod_type: exploit
qod_value: 46
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-6d56-4b0b-a35f-9e1c919c1b5c
asset_id: a04676c8-625e-40fb-96f1-cb21d82e813d
company_id: '3182423'
vulnerability_definition_id: a04676c8-6c84-4daf-964f-a1bfe0198a0c
vulnerability_definition:
id: a04676c8-6c84-4daf-964f-a1bfe0198a0c
name: 'Remote File Inclusion affecting voluptate functionality'
description: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
solution: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
category: 'Remote File Inclusion'
threat_level: Medium
definition_type: openvas
definition:
id: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name: 'Remote File Inclusion affecting voluptate functionality'
family: 'Remote File Inclusion'
reference_urls: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves: 'CVE-2017-6038, CVE-2015-1275'
solution_type: WorkAround
solution_description: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority: Low
qod_type: registry
qod_value: 2
cvss_base_score: 9
cvss_base_vector: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
epss: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
host: 194.65.255.148
hostname: quitzon.com
port: 5432/tcp
details: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
status: Expired
first_seen: '2025-05-29T08:26:26.000000Z'
last_seen: '2025-11-02T20:45:59.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
name: 'Remote File Inclusion affecting voluptate functionality'
description: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
cvss_base_score: 9
cvss_base_vector: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
qod_type: registry
qod_value: 2
threat: Medium
scanner_id: null
scanner_hostname: null
plugin:
id: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name: 'Remote File Inclusion affecting voluptate functionality'
family: 'Remote File Inclusion'
reference_urls: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves: 'CVE-2017-6038, CVE-2015-1275'
solution_type: WorkAround
solution_description: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority: Low
qod_type: registry
qod_value: 2
-
id: a04676c8-76f3-43a1-a532-e0ddd2ed55f8
asset_id: a04676c8-724a-4721-8399-0754259e7c1a
company_id: '2290927'
vulnerability_definition_id: a04676c8-766a-4fce-a0f8-9300caae1b21
vulnerability_definition:
id: a04676c8-766a-4fce-a0f8-9300caae1b21
name: '2 in quia'
description: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
solution: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
category: '2'
threat_level: Critical
definition_type: openvas
definition:
id: a04676c8-750b-4d0f-8c1b-e8e63218c6bb
o_id: 86b6d791-b8ea-3410-9e78-5847efa684c0
name: '2 in quia'
family: '2'
reference_urls: 'http://www.lesch.info/, https://www.moen.biz/doloremque-sit-autem-mollitia-aut'
reference_cves: 'CVE-2017-9436, CVE-2019-9314'
solution_type: 'Configuration Change'
solution_description: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
summary: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
insight: 'Nemo aut aut vitae odio. Qui rerum omnis laborum vel voluptas dolores consequatur.'
affected: 'Id vero repellendus ipsum dolor consequatur error. Ut quae aut eaque recusandae aut. Ut ut illum sed aut architecto iste. Voluptatem repellendus nihil beatae corrupti quo.'
impact: 'Quis sint ducimus exercitationem dolorem eum numquam. Repudiandae ut voluptas nisi non odit est numquam. Eos tenetur dolores consequatur in reprehenderit quis et.'
vuldetect: 'Eius laborum ad quia quas. Est soluta id aut est voluptas.'
priority: Low
qod_type: exploit
qod_value: 46
cvss_base_score: 5.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:N/I:P/A:P'
epss: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
host: 150.64.116.63
hostname: denesik.com
port: general/tcp
details: 'Eum odio occaecati omnis quos cumque est. Consequuntur veniam est sequi reprehenderit architecto debitis doloribus vel. Error omnis ipsa nulla qui iure consectetur. Aspernatur praesentium aut accusantium quos nesciunt.'
status: Accepted
first_seen: '2025-09-05T19:04:42.000000Z'
last_seen: '2025-09-23T20:43:54.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
name: '2 in quia'
description: 'Eum odio occaecati omnis quos cumque est. Consequuntur veniam est sequi reprehenderit architecto debitis doloribus vel. Error omnis ipsa nulla qui iure consectetur. Aspernatur praesentium aut accusantium quos nesciunt.'
cvss_base_score: 5.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:N/I:P/A:P'
qod_type: exploit
qod_value: 46
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a04676c8-750b-4d0f-8c1b-e8e63218c6bb
o_id: 86b6d791-b8ea-3410-9e78-5847efa684c0
name: '2 in quia'
family: '2'
reference_urls: 'http://www.lesch.info/, https://www.moen.biz/doloremque-sit-autem-mollitia-aut'
reference_cves: 'CVE-2017-9436, CVE-2019-9314'
solution_type: 'Configuration Change'
solution_description: 'Iure dolores ea tenetur ratione officia eos et atque. Eum deserunt dignissimos et porro. Necessitatibus ipsum qui asperiores et quo.'
summary: 'Quo fugiat nisi impedit dolorum. Voluptas non est et nisi. Quis maiores consectetur veritatis non. Quasi et fugit quia voluptatum veritatis odit eos.'
insight: 'Nemo aut aut vitae odio. Qui rerum omnis laborum vel voluptas dolores consequatur.'
affected: 'Id vero repellendus ipsum dolor consequatur error. Ut quae aut eaque recusandae aut. Ut ut illum sed aut architecto iste. Voluptatem repellendus nihil beatae corrupti quo.'
impact: 'Quis sint ducimus exercitationem dolorem eum numquam. Repudiandae ut voluptas nisi non odit est numquam. Eos tenetur dolores consequatur in reprehenderit quis et.'
vuldetect: 'Eius laborum ad quia quas. Est soluta id aut est voluptas.'
priority: Low
qod_type: exploit
qod_value: 46
items:
type: object
properties:
id:
type: string
example: a04676c8-6d56-4b0b-a35f-9e1c919c1b5c
asset_id:
type: string
example: a04676c8-625e-40fb-96f1-cb21d82e813d
company_id:
type: string
example: '3182423'
vulnerability_definition_id:
type: string
example: a04676c8-6c84-4daf-964f-a1bfe0198a0c
vulnerability_definition:
type: object
properties:
id:
type: string
example: a04676c8-6c84-4daf-964f-a1bfe0198a0c
name:
type: string
example: 'Remote File Inclusion affecting voluptate functionality'
description:
type: string
example: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
solution:
type: string
example: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
category:
type: string
example: 'Remote File Inclusion'
threat_level:
type: string
example: Medium
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id:
type: string
example: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name:
type: string
example: 'Remote File Inclusion affecting voluptate functionality'
family:
type: string
example: 'Remote File Inclusion'
reference_urls:
type: string
example: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves:
type: string
example: 'CVE-2017-6038, CVE-2015-1275'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary:
type: string
example: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight:
type: string
example: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected:
type: string
example: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact:
type: string
example: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect:
type: string
example: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority:
type: string
example: Low
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 2
cvss_base_score:
type: integer
example: 9
cvss_base_vector:
type: string
example: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
epss:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
host:
type: string
example: 194.65.255.148
hostname:
type: string
example: quitzon.com
port:
type: string
example: 5432/tcp
details:
type: string
example: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
status:
type: string
example: Expired
first_seen:
type: string
example: '2025-05-29T08:26:26.000000Z'
last_seen:
type: string
example: '2025-11-02T20:45:59.000000Z'
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
name:
type: string
example: 'Remote File Inclusion affecting voluptate functionality'
description:
type: string
example: 'Assumenda eius commodi et a aliquid quos odit. Quo quidem ducimus dolorum error possimus numquam. Quisquam aliquid velit laudantium odio nesciunt illo.'
cvss_base_score:
type: integer
example: 9
cvss_base_vector:
type: string
example: 'AV:A/AC:L/Au:M/C:P/I:P/A:N'
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 2
threat:
type: string
example: Medium
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: a04676c8-6a05-4a87-9405-134d8d0b6548
o_id:
type: string
example: 04ebfc49-3753-3cb7-9b3f-afc2bde91e8e
name:
type: string
example: 'Remote File Inclusion affecting voluptate functionality'
family:
type: string
example: 'Remote File Inclusion'
reference_urls:
type: string
example: 'http://johnston.biz/temporibus-id-sed-laboriosam-illo-ut-et-exercitationem, http://www.powlowski.biz/'
reference_cves:
type: string
example: 'CVE-2017-6038, CVE-2015-1275'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Distinctio quam et excepturi ad. Aperiam reprehenderit cum quam consequuntur. Impedit nihil dolores tempore qui dolor dicta. Soluta omnis temporibus soluta.'
summary:
type: string
example: 'Autem nihil ut qui non. Tempora ea magnam inventore animi et non. Praesentium consequatur facilis qui temporibus veritatis est tenetur. Debitis sit quis facilis amet. Rerum eos ut ipsam sint quae. Molestiae iusto sed fugiat quis facilis.'
insight:
type: string
example: 'Aut iste beatae aut fuga occaecati reprehenderit. Consequatur ut voluptas vero iusto. Excepturi et culpa est ut molestias itaque perspiciatis. Debitis asperiores et qui numquam perspiciatis explicabo natus rerum.'
affected:
type: string
example: 'Error nobis et dolor in aut. Qui sunt in explicabo impedit sed optio. Animi molestias quisquam cum et hic.'
impact:
type: string
example: 'Veritatis adipisci tempora omnis rem temporibus. Officiis architecto porro recusandae ab sequi.'
vuldetect:
type: string
example: 'Officiis aut adipisci officiis est quo ratione ab voluptatum. Ut qui qui velit dolor. Omnis explicabo et aut est. Tempore omnis eos sed fuga ut nulla non.'
priority:
type: string
example: Low
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'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Vulnerabilities
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
nullable: false
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: nkdbaimlvvwga
nullable: false
threat_level:
type: string
description: ''
example: Low
nullable: false
enum:
- Log
- Low
- Medium
- High
- Critical
host:
type: string
description: 'Must not be greater than 255 characters.'
example: focdqxxjqehaqawp
nullable: false
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: wblqyjlxfiu
nullable: false
status:
type: string
description: ''
example: Expired
nullable: false
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: 450b6fad-4e7c-36ba-bea6-d7dacb8774f8
nullable: false
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 11
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: a04676c8-84e3-4a01-9e28-d85ea7372a94
asset_id: a04676c8-8052-42c7-84b4-993b09db45df
company_id: '184263'
vulnerability_definition_id: a04676c8-845b-4e60-b462-c5886f9f058d
vulnerability_definition:
id: a04676c8-845b-4e60-b462-c5886f9f058d
name: 'Insecure Direct Object References in laudantium'
description: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
solution: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
category: 'Insecure Direct Object References'
threat_level: Low
definition_type: openvas
definition:
id: a04676c8-8326-446a-9382-8f845fa1a3b5
o_id: f775abb2-8c18-3dee-a697-7d9caf085d66
name: 'Insecure Direct Object References in laudantium'
family: 'Insecure Direct Object References'
reference_urls: 'http://schiller.net/sint-quisquam-magni-maxime-nesciunt-nulla-tempora.html, http://www.labadie.com/beatae-reiciendis-inventore-est-velit.html'
reference_cves: 'CVE-2019-7937, CVE-2020-8887'
solution_type: 'Configuration Change'
solution_description: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
summary: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
insight: 'Laudantium debitis magnam impedit officiis. Sapiente error accusantium officia error quisquam quidem. Qui nisi eius fuga nesciunt ipsa ea a.'
affected: 'Et quia corporis id optio vitae eaque. Atque enim dolor recusandae vero eligendi illo quasi. Beatae enim facilis quo reiciendis dicta iure. Dolores laboriosam aut impedit in ex et similique. Est aut inventore sapiente molestiae.'
impact: 'Qui odio laborum dignissimos illum reprehenderit consequatur possimus. Impedit veniam doloremque necessitatibus aliquam et. Et nam delectus voluptatem repellat quia et quia.'
vuldetect: 'Nam magni tempore aut cum dolorem omnis odit. Aut perferendis adipisci cum qui. Doloribus nemo nihil accusamus. Necessitatibus neque consequatur autem non.'
priority: Critical
qod_type: remote_banner
qod_value: 22
cvss_base_score: 2.1
cvss_base_vector: 'AV:L/AC:L/Au:S/C:C/I:C/A:N'
epss: null
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
host: 197.42.118.23
hostname: dooley.info
port: 25/tcp
details: 'Quis et et dignissimos et illum est ipsam. Id nobis accusamus laborum voluptatem dolorum soluta voluptas. Voluptas quo aspernatur occaecati dolorum.'
status: Detected
first_seen: '2025-09-18T03:06:21.000000Z'
last_seen: '2025-09-20T07:37:24.000000Z'
created_at: '2025-11-04T08:30:10.000000Z'
updated_at: '2025-11-04T08:30:10.000000Z'
name: 'Insecure Direct Object References in laudantium'
description: 'Quis et et dignissimos et illum est ipsam. Id nobis accusamus laborum voluptatem dolorum soluta voluptas. Voluptas quo aspernatur occaecati dolorum.'
cvss_base_score: 2.1
cvss_base_vector: 'AV:L/AC:L/Au:S/C:C/I:C/A:N'
qod_type: remote_banner
qod_value: 22
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a04676c8-8326-446a-9382-8f845fa1a3b5
o_id: f775abb2-8c18-3dee-a697-7d9caf085d66
name: 'Insecure Direct Object References in laudantium'
family: 'Insecure Direct Object References'
reference_urls: 'http://schiller.net/sint-quisquam-magni-maxime-nesciunt-nulla-tempora.html, http://www.labadie.com/beatae-reiciendis-inventore-est-velit.html'
reference_cves: 'CVE-2019-7937, CVE-2020-8887'
solution_type: 'Configuration Change'
solution_description: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
summary: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
insight: 'Laudantium debitis magnam impedit officiis. Sapiente error accusantium officia error quisquam quidem. Qui nisi eius fuga nesciunt ipsa ea a.'
affected: 'Et quia corporis id optio vitae eaque. Atque enim dolor recusandae vero eligendi illo quasi. Beatae enim facilis quo reiciendis dicta iure. Dolores laboriosam aut impedit in ex et similique. Est aut inventore sapiente molestiae.'
impact: 'Qui odio laborum dignissimos illum reprehenderit consequatur possimus. Impedit veniam doloremque necessitatibus aliquam et. Et nam delectus voluptatem repellat quia et quia.'
vuldetect: 'Nam magni tempore aut cum dolorem omnis odit. Aut perferendis adipisci cum qui. Doloribus nemo nihil accusamus. Necessitatibus neque consequatur autem non.'
priority: Critical
qod_type: remote_banner
qod_value: 22
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-84e3-4a01-9e28-d85ea7372a94
asset_id:
type: string
example: a04676c8-8052-42c7-84b4-993b09db45df
company_id:
type: string
example: '184263'
vulnerability_definition_id:
type: string
example: a04676c8-845b-4e60-b462-c5886f9f058d
vulnerability_definition:
type: object
properties:
id:
type: string
example: a04676c8-845b-4e60-b462-c5886f9f058d
name:
type: string
example: 'Insecure Direct Object References in laudantium'
description:
type: string
example: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
solution:
type: string
example: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
category:
type: string
example: 'Insecure Direct Object References'
threat_level:
type: string
example: Low
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a04676c8-8326-446a-9382-8f845fa1a3b5
o_id:
type: string
example: f775abb2-8c18-3dee-a697-7d9caf085d66
name:
type: string
example: 'Insecure Direct Object References in laudantium'
family:
type: string
example: 'Insecure Direct Object References'
reference_urls:
type: string
example: 'http://schiller.net/sint-quisquam-magni-maxime-nesciunt-nulla-tempora.html, http://www.labadie.com/beatae-reiciendis-inventore-est-velit.html'
reference_cves:
type: string
example: 'CVE-2019-7937, CVE-2020-8887'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
summary:
type: string
example: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
insight:
type: string
example: 'Laudantium debitis magnam impedit officiis. Sapiente error accusantium officia error quisquam quidem. Qui nisi eius fuga nesciunt ipsa ea a.'
affected:
type: string
example: 'Et quia corporis id optio vitae eaque. Atque enim dolor recusandae vero eligendi illo quasi. Beatae enim facilis quo reiciendis dicta iure. Dolores laboriosam aut impedit in ex et similique. Est aut inventore sapiente molestiae.'
impact:
type: string
example: 'Qui odio laborum dignissimos illum reprehenderit consequatur possimus. Impedit veniam doloremque necessitatibus aliquam et. Et nam delectus voluptatem repellat quia et quia.'
vuldetect:
type: string
example: 'Nam magni tempore aut cum dolorem omnis odit. Aut perferendis adipisci cum qui. Doloribus nemo nihil accusamus. Necessitatibus neque consequatur autem non.'
priority:
type: string
example: Critical
qod_type:
type: string
example: remote_banner
qod_value:
type: integer
example: 22
cvss_base_score:
type: number
example: 2.1
cvss_base_vector:
type: string
example: 'AV:L/AC:L/Au:S/C:C/I:C/A:N'
epss:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
host:
type: string
example: 197.42.118.23
hostname:
type: string
example: dooley.info
port:
type: string
example: 25/tcp
details:
type: string
example: 'Quis et et dignissimos et illum est ipsam. Id nobis accusamus laborum voluptatem dolorum soluta voluptas. Voluptas quo aspernatur occaecati dolorum.'
status:
type: string
example: Detected
first_seen:
type: string
example: '2025-09-18T03:06:21.000000Z'
last_seen:
type: string
example: '2025-09-20T07:37:24.000000Z'
created_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:10.000000Z'
name:
type: string
example: 'Insecure Direct Object References in laudantium'
description:
type: string
example: 'Quis et et dignissimos et illum est ipsam. Id nobis accusamus laborum voluptatem dolorum soluta voluptas. Voluptas quo aspernatur occaecati dolorum.'
cvss_base_score:
type: number
example: 2.1
cvss_base_vector:
type: string
example: 'AV:L/AC:L/Au:S/C:C/I:C/A:N'
qod_type:
type: string
example: remote_banner
qod_value:
type: integer
example: 22
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: a04676c8-8326-446a-9382-8f845fa1a3b5
o_id:
type: string
example: f775abb2-8c18-3dee-a697-7d9caf085d66
name:
type: string
example: 'Insecure Direct Object References in laudantium'
family:
type: string
example: 'Insecure Direct Object References'
reference_urls:
type: string
example: 'http://schiller.net/sint-quisquam-magni-maxime-nesciunt-nulla-tempora.html, http://www.labadie.com/beatae-reiciendis-inventore-est-velit.html'
reference_cves:
type: string
example: 'CVE-2019-7937, CVE-2020-8887'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Rerum exercitationem asperiores possimus est dolor. Reiciendis quia harum vitae ut sapiente. Quasi ad ratione error et ut ut voluptatem. Et est labore animi et illo rerum.'
summary:
type: string
example: 'Repudiandae hic possimus assumenda deleniti. Doloribus et voluptate aliquid error sit inventore. Minima cum dolores temporibus id eos. Totam dolores iure omnis eveniet eos architecto animi nostrum.'
insight:
type: string
example: 'Laudantium debitis magnam impedit officiis. Sapiente error accusantium officia error quisquam quidem. Qui nisi eius fuga nesciunt ipsa ea a.'
affected:
type: string
example: 'Et quia corporis id optio vitae eaque. Atque enim dolor recusandae vero eligendi illo quasi. Beatae enim facilis quo reiciendis dicta iure. Dolores laboriosam aut impedit in ex et similique. Est aut inventore sapiente molestiae.'
impact:
type: string
example: 'Qui odio laborum dignissimos illum reprehenderit consequatur possimus. Impedit veniam doloremque necessitatibus aliquam et. Et nam delectus voluptatem repellat quia et quia.'
vuldetect:
type: string
example: 'Nam magni tempore aut cum dolorem omnis odit. Aut perferendis adipisci cum qui. Doloribus nemo nihil accusamus. Necessitatibus neque consequatur autem non.'
priority:
type: string
example: Critical
qod_type:
type: string
example: remote_banner
qod_value:
type: integer
example: 22
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: atque
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: webhook_id
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: webhook_id
nullable: false
enum:
- webhook_id
- event
- status
- next_retry_at
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: webhook_id
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: webhook_id
nullable: false
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a04676c8-4343-4569-99c6-c6429b1c0aa2
webhook_id: a04676c8-4231-479c-ab4e-c1fc5ebe6767
event: sed
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
-
id: a04676c8-4735-4887-bb92-99a98c2a1a74
webhook_id: a04676c8-467c-442f-b488-3a4d692e9f4c
event: distinctio
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
path: /
per_page: 10
to: 2
total: 2
properties:
data:
type: array
example:
-
id: a04676c8-4343-4569-99c6-c6429b1c0aa2
webhook_id: a04676c8-4231-479c-ab4e-c1fc5ebe6767
event: sed
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
-
id: a04676c8-4735-4887-bb92-99a98c2a1a74
webhook_id: a04676c8-467c-442f-b488-3a4d692e9f4c
event: distinctio
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-4343-4569-99c6-c6429b1c0aa2
webhook_id:
type: string
example: a04676c8-4231-479c-ab4e-c1fc5ebe6767
event:
type: string
example: sed
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-11-04T08:30:09.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:09.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- 'Webhook Events'
/v1/webhook-events/types:
get:
summary: 'List all available webhook event types'
operationId: listAllAvailableWebhookEventTypes
description: "Lists all webhook event types that can be used.\n"
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Webhook Events'
'/v1/webhook-events/{webhookEvent_id}':
get:
summary: 'Retrieve an webhook event'
operationId: retrieveAnWebhookEvent
description: "Retrieves an webhook event for the current company.\n"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: a04676c8-5421-4876-940c-c31ef8afec8a
webhook_id: a04676c8-5367-4a7a-83b4-a905ef109902
event: dicta
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-5421-4876-940c-c31ef8afec8a
webhook_id:
type: string
example: a04676c8-5367-4a7a-83b4-a905ef109902
event:
type: string
example: dicta
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-11-04T08:30:09.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:09.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: a04676c8-4343-4569-99c6-c6429b1c0aa2
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: a04676c8-2558-4852-9dd2-cf857634a794
company_id: 1c475e6c-d7e2-4369-a177-2f53227ec9c1
url: 'https://sporer.com'
description: null
events: []
secret: a17cc08c575397a4e0cfe0180789988ef99b3a2d16a8ac6ee187b3d57d4af253
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
-
id: a04676c8-29f4-4093-a8d0-618e0d7bc36b
company_id: ba07a76b-73a7-4747-9027-b4c4d64dcaeb
url: 'https://keebler.com'
description: null
events: []
secret: d3c05835995b20440af0b088fb7fa067141dc0513eba3795c2cad3162b19c673
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
properties:
data:
type: array
example:
-
id: a04676c8-2558-4852-9dd2-cf857634a794
company_id: 1c475e6c-d7e2-4369-a177-2f53227ec9c1
url: 'https://sporer.com'
description: null
events: []
secret: a17cc08c575397a4e0cfe0180789988ef99b3a2d16a8ac6ee187b3d57d4af253
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
-
id: a04676c8-29f4-4093-a8d0-618e0d7bc36b
company_id: ba07a76b-73a7-4747-9027-b4c4d64dcaeb
url: 'https://keebler.com'
description: null
events: []
secret: d3c05835995b20440af0b088fb7fa067141dc0513eba3795c2cad3162b19c673
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
items:
type: object
properties:
id:
type: string
example: a04676c8-2558-4852-9dd2-cf857634a794
company_id:
type: string
example: 1c475e6c-d7e2-4369-a177-2f53227ec9c1
url:
type: string
example: 'https://sporer.com'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: a17cc08c575397a4e0cfe0180789988ef99b3a2d16a8ac6ee187b3d57d4af253
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:09.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:09.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: 'https://www.botsford.biz/ab-perferendis-explicabo-perferendis-pariatur'
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Nam et veritatis quasi illum voluptatem nobis nihil.'
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: a04676c8-31db-4fd4-aa3a-f35aa5d727f9
company_id: c42a733e-8b38-4f72-a755-0d926d602cc3
url: 'https://lehner.com'
description: null
events: []
secret: d48d356db657af86592fe096f1cbbbe4b92023416ae8380ce6b861734faa18cf
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-31db-4fd4-aa3a-f35aa5d727f9
company_id:
type: string
example: c42a733e-8b38-4f72-a755-0d926d602cc3
url:
type: string
example: 'https://lehner.com'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: d48d356db657af86592fe096f1cbbbe4b92023416ae8380ce6b861734faa18cf
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:09.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:09.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: false
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL.'
example: 'http://www.kemmer.com/inventore-doloribus-magni-dolores-ipsam.html'
nullable: false
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Ut voluptas laborum explicabo exercitationem amet.'
nullable: true
events:
type: array
description: ''
example: null
items:
type: string
delete:
summary: 'Delete an webhook'
operationId: deleteAnWebhook
description: "Deletes an webhook for the current company.\n"
parameters: []
responses:
204:
description: 'delete successful'
content:
text/plain:
schema:
type: string
example: ''
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
tags:
- Webhooks
parameters:
-
in: path
name: webhook_id
description: 'The ID of the webhook.'
example: a04676c8-2558-4852-9dd2-cf857634a794
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: a04676c8-3628-42cd-b4a2-0f4aa4491bc7
company_id: 11f3859a-04bf-42d0-8182-5176dbc166ac
url: 'https://ernser.com'
description: null
events: []
secret: 7281377d5b27d1cd183c1999c242d569dda62192318bb8b56d2e4d297ccb0b28
last_sent_at: null
created_at: '2025-11-04T08:30:09.000000Z'
updated_at: '2025-11-04T08:30:09.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a04676c8-3628-42cd-b4a2-0f4aa4491bc7
company_id:
type: string
example: 11f3859a-04bf-42d0-8182-5176dbc166ac
url:
type: string
example: 'https://ernser.com'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 7281377d5b27d1cd183c1999c242d569dda62192318bb8b56d2e4d297ccb0b28
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2025-11-04T08:30:09.000000Z'
updated_at:
type: string
example: '2025-11-04T08:30:09.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: a04676c8-2558-4852-9dd2-cf857634a794
required: true
schema:
type: string
'/v1/webhooks/{webhook_id}/test':
post:
summary: 'Test a webhook'
operationId: testAWebhook
description: "Tests the webhook by sending a test event.\n"
parameters: []
responses:
204:
description: 'dispatched test event'
content:
text/plain:
schema:
type: string
example: ''
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
tags:
- Webhooks
parameters:
-
in: path
name: webhook_id
description: 'The ID of the webhook.'
example: a04676c8-2558-4852-9dd2-cf857634a794
required: true
schema:
type: string