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: Detections
description: 'Manage your honeypot detections'
-
name: Endpoints
description: ''
-
name: Honeypots
description: 'Manage your honeypots.'
-
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
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
-
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
enum:
- cpe
- vendor
- product
- version
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
enum:
- assets
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-f233-44c5-ae3f-ca3660c46046
cpe: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*'
vendor: Oracle
product: Database
version: 16.8.2957
update: build6585
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-f3a4-4988-bf19-e7c2e637711d
cpe: 'cpe:2.3:a:apple:macos:*:*:*:*:*:*:*:*'
vendor: Apple
product: macOS
version: 1.50.6183
update: patch1
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.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: a0c96b86-f233-44c5-ae3f-ca3660c46046
cpe: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*'
vendor: Oracle
product: Database
version: 16.8.2957
update: build6585
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-f3a4-4988-bf19-e7c2e637711d
cpe: 'cpe:2.3:a:apple:macos:*:*:*:*:*:*:*:*'
vendor: Apple
product: macOS
version: 1.50.6183
update: patch1
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b86-f233-44c5-ae3f-ca3660c46046
cpe:
type: string
example: 'cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Oracle
product:
type: string
example: Database
version:
type: string
example: 16.8.2957
update:
type: string
example: build6585
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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
enum:
- csv
- xlsx
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
-
in: query
name: sort
description: ''
example: vendor
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: vendor
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
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
enum:
- assets
responses:
200:
description: 'Successfully retrieved application'
content:
application/json:
schema:
type: object
example:
data:
id: a0c96b86-f7b3-469d-b92c-ceef4a70c8da
cpe: 'cpe:2.3:a:cisco:webex:*:*:*:*:*:*:*:*'
vendor: Cisco
product: Webex
version: 6.3.3900
update: sp2
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-f7b3-469d-b92c-ceef4a70c8da
cpe:
type: string
example: 'cpe:2.3:a:cisco:webex:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Cisco
product:
type: string
example: Webex
version:
type: string
example: 6.3.3900
update:
type: string
example: sp2
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: dolorem
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
-
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
-
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'
-
in: query
name: 'filter[hostname]'
description: ''
example: laptop-1.local
required: false
schema:
type: 'Filter assets by their hostname.'
description: ''
example: laptop-1.local
-
in: query
name: 'filter[tags][]'
description: ''
example: 'New,Old'
required: false
schema:
type: 'Filter assets by their tags.'
description: ''
example: 'New,Old'
-
in: query
name: 'filter[licensed]'
description: ''
example: 'true,false'
required: false
schema:
type: 'Filter assets by licensed status.'
description: ''
example: 'true,false'
-
in: query
name: sort
description: ''
example: last_seen
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: last_seen
enum:
- name
- host
- last_seen
- licensed
-
in: query
name: include
description: ''
example: software
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: software
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-a95d-44e6-ae71-55e8456d7a80
company_id: '7357567'
name: 'Macey Dooley'
identifier: 'C3:E8:01:1B:B6:19'
host: 175.154.27.235
mac_address: 'C3:E8:01:1B:B6:19'
hostname: friesen.net
operating_system: inventore
operating_system_name: laudantium
first_seen: '2022-06-01T12:50:09.000000Z'
last_seen: '1994-08-12T04:51:42.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2026-01-13T13:57:13.000000Z'
-
id: a0c96b86-ac98-4b85-879f-6542d5fe33d1
company_id: '2160525'
name: 'Clyde Gaylord IV'
identifier: 'F4:BA:64:9B:8D:39'
host: 239.118.104.164
mac_address: 'F4:BA:64:9B:8D:39'
hostname: damore.com
operating_system: sunt
operating_system_name: itaque
first_seen: '2007-12-16T10:55:23.000000Z'
last_seen: '2005-12-20T12:51:50.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: '2026-01-14T20:35: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: a0c96b86-a95d-44e6-ae71-55e8456d7a80
company_id: '7357567'
name: 'Macey Dooley'
identifier: 'C3:E8:01:1B:B6:19'
host: 175.154.27.235
mac_address: 'C3:E8:01:1B:B6:19'
hostname: friesen.net
operating_system: inventore
operating_system_name: laudantium
first_seen: '2022-06-01T12:50:09.000000Z'
last_seen: '1994-08-12T04:51:42.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2026-01-13T13:57:13.000000Z'
-
id: a0c96b86-ac98-4b85-879f-6542d5fe33d1
company_id: '2160525'
name: 'Clyde Gaylord IV'
identifier: 'F4:BA:64:9B:8D:39'
host: 239.118.104.164
mac_address: 'F4:BA:64:9B:8D:39'
hostname: damore.com
operating_system: sunt
operating_system_name: itaque
first_seen: '2007-12-16T10:55:23.000000Z'
last_seen: '2005-12-20T12:51:50.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: '2026-01-14T20:35:09.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b86-a95d-44e6-ae71-55e8456d7a80
company_id:
type: string
example: '7357567'
name:
type: string
example: 'Macey Dooley'
identifier:
type: string
example: 'C3:E8:01:1B:B6:19'
host:
type: string
example: 175.154.27.235
mac_address:
type: string
example: 'C3:E8:01:1B:B6:19'
hostname:
type: string
example: friesen.net
operating_system:
type: string
example: inventore
operating_system_name:
type: string
example: laudantium
first_seen:
type: string
example: '2022-06-01T12:50:09.000000Z'
last_seen:
type: string
example: '1994-08-12T04:51:42.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: '2026-01-13T13:57:13.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:
- 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: a0c96b86-b526-422f-b7a9-774f68c3a030
company_id: '9577072'
name: 'Bonita Wilderman DDS'
identifier: '70:3A:EF:BC:F8:BB'
host: 149.238.91.192
mac_address: '70:3A:EF:BC:F8:BB'
hostname: champlin.net
operating_system: labore
operating_system_name: vitae
first_seen: '2013-07-17T22:43:01.000000Z'
last_seen: '2019-12-10T19:42:41.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2026-02-08T02:41:36.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-b526-422f-b7a9-774f68c3a030
company_id:
type: string
example: '9577072'
name:
type: string
example: 'Bonita Wilderman DDS'
identifier:
type: string
example: '70:3A:EF:BC:F8:BB'
host:
type: string
example: 149.238.91.192
mac_address:
type: string
example: '70:3A:EF:BC:F8:BB'
hostname:
type: string
example: champlin.net
operating_system:
type: string
example: labore
operating_system_name:
type: string
example: vitae
first_seen:
type: string
example: '2013-07-17T22:43:01.000000Z'
last_seen:
type: string
example: '2019-12-10T19:42:41.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: '2026-02-08T02:41:36.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: ghwqcxnhnzrgixovqh
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: error
licensed:
type: boolean
description: ''
example: 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: delete
enum:
- addTags
- removeTags
- delete
- assignLicense
- removeLicense
id:
type: string
description: ''
example: porro
data:
type: object
description: ''
example: []
properties:
tags:
type: object
description: ''
example: null
properties: { }
required:
- action
- id
required:
- data
'/v1/assets/{id}':
get:
summary: 'Retrieve an asset.'
operationId: retrieveAnAsset
description: " Retrieves an asset by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: tags
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: tags
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: 'Successfully retrieved asset'
content:
application/json:
schema:
type: object
example:
data:
id: a0c96b86-b93a-421d-ba6e-bbe3ca112b34
company_id: '6920306'
name: 'Jaclyn Klocko'
identifier: '07:8F:2A:3E:58:4A'
host: 174.128.96.72
mac_address: '07:8F:2A:3E:58:4A'
hostname: renner.com
operating_system: dignissimos
operating_system_name: libero
first_seen: '1995-03-08T15:43:00.000000Z'
last_seen: '1992-11-27T21:52:08.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: '2026-02-05T11:44:02.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-b93a-421d-ba6e-bbe3ca112b34
company_id:
type: string
example: '6920306'
name:
type: string
example: 'Jaclyn Klocko'
identifier:
type: string
example: '07:8F:2A:3E:58:4A'
host:
type: string
example: 174.128.96.72
mac_address:
type: string
example: '07:8F:2A:3E:58:4A'
hostname:
type: string
example: renner.com
operating_system:
type: string
example: dignissimos
operating_system_name:
type: string
example: libero
first_seen:
type: string
example: '1995-03-08T15:43:00.000000Z'
last_seen:
type: string
example: '1992-11-27T21:52:08.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: '2026-02-05T11:44:02.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: a0c96b86-c0a8-4d4e-9e5a-52deb00a85a8
company_id: '1352365'
name: 'Anabel Batz'
identifier: '79:AC:75:A7:4B:E3'
host: 108.125.182.126
mac_address: '79:AC:75:A7:4B:E3'
hostname: russel.com
operating_system: eum
operating_system_name: voluptatem
first_seen: '1981-05-23T20:48:29.000000Z'
last_seen: '2000-05-22T03:51:58.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
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-c0a8-4d4e-9e5a-52deb00a85a8
company_id:
type: string
example: '1352365'
name:
type: string
example: 'Anabel Batz'
identifier:
type: string
example: '79:AC:75:A7:4B:E3'
host:
type: string
example: 108.125.182.126
mac_address:
type: string
example: '79:AC:75:A7:4B:E3'
hostname:
type: string
example: russel.com
operating_system:
type: string
example: eum
operating_system_name:
type: string
example: voluptatem
first_seen:
type: string
example: '1981-05-23T20:48:29.000000Z'
last_seen:
type: string
example: '2000-05-22T03:51:58.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
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: fyzwfjbxpxbla
licensed:
type: boolean
description: ''
example: true
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: corrupti
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
-
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.'
-
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
enum:
- not_valid_after
-
in: query
name: include
description: ''
example: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-c8a1-44cd-820b-0c7df6554c18
company_id: '8218649'
common_name: braun.com
organization: 'Hermiston LLC'
organizational_unit: null
locality: null
state: Tennessee
country: null
serial: 2CH36C9AEE8H2C9WRF6BJR6JKLSOO8YU
not_valid_before: 20241202T144747Z
not_valid_after: 20270416T200827Z
value: "-----BEGIN CERTIFICATE-----\nc2wdHjjxT3zHqZd8kqQ4h8iWvURD+96NBBC77ojIrKiJrvV2CcLvtYdKuSbWDgIw\nyNn6Wu4cx+AzSrTSXowLuzIpIETmLElv+5GOr/IBfx65k5D1GR0yea+HHv8Lz6p1\nBFHmht/09LO9f1fhPZ0RMLMiWtaDaxiySBx+LmbrbdI5Uh3MeKfo4raNoXNhY9sQ\n4xEwiRVPGRNVF2AFWJTpAXvmxAdiAIVmnog5Scjrq8gMDH+LN6F6r9TTnOCsNOsh\nHz2Mm0ItKDtiKS+fowykgY215qzhgEktGMLlybnyB/BzvdDYK8X3d/hQfOparFVY\nuWyLj/O4Q72FzO08PkBY06der1Y6q373THhG4m30xwDpy9+35BmYVAXlGbVWecP+\nTp4A5AopJNebtz/kPUVTMkjwkfXStugEmI96G2gaATMy5N65bLjTgxRzM+I6xo4N\nH4E1aoKJI8mSxwi2CIj/+PI7CGt6V7zBA9OFgomU2ctUaaYKcQBvRPKvhqf/U+Kb\n1iomVCAmjpEvi4V0aRMPwX2oq8RDMFthPJIySO4w+LobQ4/b2JetRsakfV4S2xcm\nHPwpcI5wE3IjXvYeSC0ZB7JbxOGAQAqXkS/PzMclwO8sK6Oc4NcujmtJw0AccECx\n8t/TwIV5iT3mg4NhgCGL4bIDdB2qa9DbU6npiHxsdpPFmj2eKf+1ZB7dTF5AeVPo\nVpouJB/JkyBBsqEpMNM2DVx8Nq3LpYTbqkowOw0XwxQAQaME9m8M3EI90bg7d6Ou\n0hsPIqQvmlwzLSHFnLDeOAjlTCX5o6SsISBWAKQFx8gsuU+XL2AylcmMnIHtyEbE\nqx+0YOQ7v+w9UzyLtzyJktct6Ng9URCY12mz0Ph7oB7R3NMDIpaJ179XpEnxjHER\n7TnhDtUSHkqdK5Y9csPbI7W780yXjQKiJwK96QhfxpboiNsMvT1jyD/uBI7fNvqS\neMm0OAkwcx7XIXXzBQ2ZRT4Eap1UacxBznSgvxAzeysp8YT7OBAdZrAdD3I6XJLQ\n02IFhtUPGXjLCu2xpJGp1pGgRaGgPe52mRsrcpiUnpgaVL13rCxLazWwPrtL9hDx\nhf8tLNZRwok7lEpXfPrBq3DjBuB1kXnW5Q6m6LsNu16WdcfR1+bZ+9sAIJ3LjQQs\nmsP5QP7NRwjdG60ohKIDEteKNulQVBkxfwJ2TKGIoERppO2H5aqfuIwOud5U0QXo\nwrI8feopyZhWI8CWHoMEJfTMvtoMzWXYJP6BTstZw+igtCbWJCN9Lc0WASCpEH48\ns9k0eGkZUmVG/O3mwojLxyMVYBBg1HiF0rsHaXkENd6v5UuMwutQjHeyiHyZe0NZ\ntskONI2bYPMxQXIcMYavvg==\n\n-----END CERTIFICATE-----"
first_seen: '2025-01-01T12:36:56.000000Z'
last_seen: '2026-01-05T02:35:23.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-ccbe-4dd6-96f8-832b6ab28537
company_id: '8364334'
common_name: cartwright.com
organization: Schroeder-Wilkinson
organizational_unit: null
locality: 'Lake Mae'
state: 'South Carolina'
country: PT
serial: OHXVB1ZRY2HSOOI6ZGETPYQBOGYDFCJS
not_valid_before: 20240219T002957Z
not_valid_after: 20261118T181320Z
value: "-----BEGIN CERTIFICATE-----\nI1kkfL7IHvsfbWBU2JiEcKuQEcp9HmadcJ1SuA0DtkJcpa5hgHKYxiZmaXhAdeGX\netcHKF0agkgwqN9e+8uJ33KzxOc6AwGk5qdP9uThHVw4xo6fkJTMPtoXUu6uMz2S\n0sI73fDwY7s1aQDNS3HS4QY3kgpLtR8bieT0iS9+LkMIL80GOfCP999yNcrr3Crw\ngNhG1xQwCoX5HpEjj2/f5sBfy5oCg+9WmvfNSPEkyVxwlW7wyLWYZJLrtToC9jo2\nwniRed/QTeisGviIYmi3Ly0mA1NqVDswJBS3fa3I5yS4Srk1Zt36rYexN2pMVceA\nq3wN8mAUIW5BSnhFvL7u1O9qnYqxxucmNt3EPF1tcUcW1RTTEo2lw2kZKI/Nk9Sq\neBq12oDygfItQEZD9UEunS2VEEyA0R5Fyp2wwrTESnqdk8vtD+FNH7id4gV2aqlM\n0iUZxsuTV5Ihout1xfohFzw9jPiyfn4GAZoy7m0OUDOpoorcB2sLPehtCuy6N7+J\n5wAY3oL6i4iKyiws1BUcN1EyP3pqSsJ2HhYRkcXucgPl9fsBVLrNQ13UNS4GpwPF\n7m/vsfQqR9mbVeYtdErXuzjz5IWnLW5vYO8p4yBHcoBMmOpfAyuo9pp89bPiy5YF\nM7jce/KDa9nviYXhBLtJtx54YPP14XiB3v1OIFAfJMbEoHURsKYo80sE0HpVq4LG\nhY7mohiBkrNyd4BjI4n3hlJ/s5tanC1Xulb4O3EhkSWMADu1M8jnneEe5WHGTNiU\n22/kbKHwhlQzIDHyG1lfK2XkpGTsANbcopkUS4ubrRL92dzPxnAoCwspK7FaOqso\n06qnOxhlLEgSuzFFrzlmNV2QLhPC65kg2nKW/uwcWEI5n7/zTgO6P9jiuoOlUdkx\nSRjMJ1LKMUMu8ZI3Ur1/iqcYS16fC2l748WS1JfuLfNLaAWLsLY7YCJVKBIdh0+j\nmILK8EJokfEOui0RVsLhlIptvGtjzxhXSjS0hQqZwrjdUAR6ImwXim3iWphF7a1Y\nwx3HaBhR9UHsfX528QMK6XrNzAVZCaeIOFhdUEEysXxTJqcv8mT+Ub+kLffoLsrk\nvySp2py7y5Yh9E3ixUJQMCd/fsTDwYqfqpeGWgPxsola3bG19OuslRF26fFDzGwz\nBNPyrqAfdsr8j3mFthFejzQXyu8NkWCtKR/eHSmesJsfPsFEyAYtg23qze19LlwK\nYPEMZL9b0nTJSdh4HECQn0uHh+417dwJZ8/OpT2yHkRcW8pIXoN6MZXR+fPN5Qns\nN9UOED9TJmzvQL6ISXvH9pxVqgrwifRKOszf/3fLM9AJp80NSv87xWhlj453se50\nKmEuplhRInW0/VStywQktA==\n\n-----END CERTIFICATE-----"
first_seen: '2024-08-24T00:30:44.000000Z'
last_seen: '2025-11-03T10:47:08.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.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: a0c96b86-c8a1-44cd-820b-0c7df6554c18
company_id: '8218649'
common_name: braun.com
organization: 'Hermiston LLC'
organizational_unit: null
locality: null
state: Tennessee
country: null
serial: 2CH36C9AEE8H2C9WRF6BJR6JKLSOO8YU
not_valid_before: 20241202T144747Z
not_valid_after: 20270416T200827Z
value: "-----BEGIN CERTIFICATE-----\nc2wdHjjxT3zHqZd8kqQ4h8iWvURD+96NBBC77ojIrKiJrvV2CcLvtYdKuSbWDgIw\nyNn6Wu4cx+AzSrTSXowLuzIpIETmLElv+5GOr/IBfx65k5D1GR0yea+HHv8Lz6p1\nBFHmht/09LO9f1fhPZ0RMLMiWtaDaxiySBx+LmbrbdI5Uh3MeKfo4raNoXNhY9sQ\n4xEwiRVPGRNVF2AFWJTpAXvmxAdiAIVmnog5Scjrq8gMDH+LN6F6r9TTnOCsNOsh\nHz2Mm0ItKDtiKS+fowykgY215qzhgEktGMLlybnyB/BzvdDYK8X3d/hQfOparFVY\nuWyLj/O4Q72FzO08PkBY06der1Y6q373THhG4m30xwDpy9+35BmYVAXlGbVWecP+\nTp4A5AopJNebtz/kPUVTMkjwkfXStugEmI96G2gaATMy5N65bLjTgxRzM+I6xo4N\nH4E1aoKJI8mSxwi2CIj/+PI7CGt6V7zBA9OFgomU2ctUaaYKcQBvRPKvhqf/U+Kb\n1iomVCAmjpEvi4V0aRMPwX2oq8RDMFthPJIySO4w+LobQ4/b2JetRsakfV4S2xcm\nHPwpcI5wE3IjXvYeSC0ZB7JbxOGAQAqXkS/PzMclwO8sK6Oc4NcujmtJw0AccECx\n8t/TwIV5iT3mg4NhgCGL4bIDdB2qa9DbU6npiHxsdpPFmj2eKf+1ZB7dTF5AeVPo\nVpouJB/JkyBBsqEpMNM2DVx8Nq3LpYTbqkowOw0XwxQAQaME9m8M3EI90bg7d6Ou\n0hsPIqQvmlwzLSHFnLDeOAjlTCX5o6SsISBWAKQFx8gsuU+XL2AylcmMnIHtyEbE\nqx+0YOQ7v+w9UzyLtzyJktct6Ng9URCY12mz0Ph7oB7R3NMDIpaJ179XpEnxjHER\n7TnhDtUSHkqdK5Y9csPbI7W780yXjQKiJwK96QhfxpboiNsMvT1jyD/uBI7fNvqS\neMm0OAkwcx7XIXXzBQ2ZRT4Eap1UacxBznSgvxAzeysp8YT7OBAdZrAdD3I6XJLQ\n02IFhtUPGXjLCu2xpJGp1pGgRaGgPe52mRsrcpiUnpgaVL13rCxLazWwPrtL9hDx\nhf8tLNZRwok7lEpXfPrBq3DjBuB1kXnW5Q6m6LsNu16WdcfR1+bZ+9sAIJ3LjQQs\nmsP5QP7NRwjdG60ohKIDEteKNulQVBkxfwJ2TKGIoERppO2H5aqfuIwOud5U0QXo\nwrI8feopyZhWI8CWHoMEJfTMvtoMzWXYJP6BTstZw+igtCbWJCN9Lc0WASCpEH48\ns9k0eGkZUmVG/O3mwojLxyMVYBBg1HiF0rsHaXkENd6v5UuMwutQjHeyiHyZe0NZ\ntskONI2bYPMxQXIcMYavvg==\n\n-----END CERTIFICATE-----"
first_seen: '2025-01-01T12:36:56.000000Z'
last_seen: '2026-01-05T02:35:23.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-ccbe-4dd6-96f8-832b6ab28537
company_id: '8364334'
common_name: cartwright.com
organization: Schroeder-Wilkinson
organizational_unit: null
locality: 'Lake Mae'
state: 'South Carolina'
country: PT
serial: OHXVB1ZRY2HSOOI6ZGETPYQBOGYDFCJS
not_valid_before: 20240219T002957Z
not_valid_after: 20261118T181320Z
value: "-----BEGIN CERTIFICATE-----\nI1kkfL7IHvsfbWBU2JiEcKuQEcp9HmadcJ1SuA0DtkJcpa5hgHKYxiZmaXhAdeGX\netcHKF0agkgwqN9e+8uJ33KzxOc6AwGk5qdP9uThHVw4xo6fkJTMPtoXUu6uMz2S\n0sI73fDwY7s1aQDNS3HS4QY3kgpLtR8bieT0iS9+LkMIL80GOfCP999yNcrr3Crw\ngNhG1xQwCoX5HpEjj2/f5sBfy5oCg+9WmvfNSPEkyVxwlW7wyLWYZJLrtToC9jo2\nwniRed/QTeisGviIYmi3Ly0mA1NqVDswJBS3fa3I5yS4Srk1Zt36rYexN2pMVceA\nq3wN8mAUIW5BSnhFvL7u1O9qnYqxxucmNt3EPF1tcUcW1RTTEo2lw2kZKI/Nk9Sq\neBq12oDygfItQEZD9UEunS2VEEyA0R5Fyp2wwrTESnqdk8vtD+FNH7id4gV2aqlM\n0iUZxsuTV5Ihout1xfohFzw9jPiyfn4GAZoy7m0OUDOpoorcB2sLPehtCuy6N7+J\n5wAY3oL6i4iKyiws1BUcN1EyP3pqSsJ2HhYRkcXucgPl9fsBVLrNQ13UNS4GpwPF\n7m/vsfQqR9mbVeYtdErXuzjz5IWnLW5vYO8p4yBHcoBMmOpfAyuo9pp89bPiy5YF\nM7jce/KDa9nviYXhBLtJtx54YPP14XiB3v1OIFAfJMbEoHURsKYo80sE0HpVq4LG\nhY7mohiBkrNyd4BjI4n3hlJ/s5tanC1Xulb4O3EhkSWMADu1M8jnneEe5WHGTNiU\n22/kbKHwhlQzIDHyG1lfK2XkpGTsANbcopkUS4ubrRL92dzPxnAoCwspK7FaOqso\n06qnOxhlLEgSuzFFrzlmNV2QLhPC65kg2nKW/uwcWEI5n7/zTgO6P9jiuoOlUdkx\nSRjMJ1LKMUMu8ZI3Ur1/iqcYS16fC2l748WS1JfuLfNLaAWLsLY7YCJVKBIdh0+j\nmILK8EJokfEOui0RVsLhlIptvGtjzxhXSjS0hQqZwrjdUAR6ImwXim3iWphF7a1Y\nwx3HaBhR9UHsfX528QMK6XrNzAVZCaeIOFhdUEEysXxTJqcv8mT+Ub+kLffoLsrk\nvySp2py7y5Yh9E3ixUJQMCd/fsTDwYqfqpeGWgPxsola3bG19OuslRF26fFDzGwz\nBNPyrqAfdsr8j3mFthFejzQXyu8NkWCtKR/eHSmesJsfPsFEyAYtg23qze19LlwK\nYPEMZL9b0nTJSdh4HECQn0uHh+417dwJZ8/OpT2yHkRcW8pIXoN6MZXR+fPN5Qns\nN9UOED9TJmzvQL6ISXvH9pxVqgrwifRKOszf/3fLM9AJp80NSv87xWhlj453se50\nKmEuplhRInW0/VStywQktA==\n\n-----END CERTIFICATE-----"
first_seen: '2024-08-24T00:30:44.000000Z'
last_seen: '2025-11-03T10:47:08.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b86-c8a1-44cd-820b-0c7df6554c18
company_id:
type: string
example: '8218649'
common_name:
type: string
example: braun.com
organization:
type: string
example: 'Hermiston LLC'
organizational_unit:
type: string
example: null
locality:
type: string
example: null
state:
type: string
example: Tennessee
country:
type: string
example: null
serial:
type: string
example: 2CH36C9AEE8H2C9WRF6BJR6JKLSOO8YU
not_valid_before:
type: string
example: 20241202T144747Z
not_valid_after:
type: string
example: 20270416T200827Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nc2wdHjjxT3zHqZd8kqQ4h8iWvURD+96NBBC77ojIrKiJrvV2CcLvtYdKuSbWDgIw\nyNn6Wu4cx+AzSrTSXowLuzIpIETmLElv+5GOr/IBfx65k5D1GR0yea+HHv8Lz6p1\nBFHmht/09LO9f1fhPZ0RMLMiWtaDaxiySBx+LmbrbdI5Uh3MeKfo4raNoXNhY9sQ\n4xEwiRVPGRNVF2AFWJTpAXvmxAdiAIVmnog5Scjrq8gMDH+LN6F6r9TTnOCsNOsh\nHz2Mm0ItKDtiKS+fowykgY215qzhgEktGMLlybnyB/BzvdDYK8X3d/hQfOparFVY\nuWyLj/O4Q72FzO08PkBY06der1Y6q373THhG4m30xwDpy9+35BmYVAXlGbVWecP+\nTp4A5AopJNebtz/kPUVTMkjwkfXStugEmI96G2gaATMy5N65bLjTgxRzM+I6xo4N\nH4E1aoKJI8mSxwi2CIj/+PI7CGt6V7zBA9OFgomU2ctUaaYKcQBvRPKvhqf/U+Kb\n1iomVCAmjpEvi4V0aRMPwX2oq8RDMFthPJIySO4w+LobQ4/b2JetRsakfV4S2xcm\nHPwpcI5wE3IjXvYeSC0ZB7JbxOGAQAqXkS/PzMclwO8sK6Oc4NcujmtJw0AccECx\n8t/TwIV5iT3mg4NhgCGL4bIDdB2qa9DbU6npiHxsdpPFmj2eKf+1ZB7dTF5AeVPo\nVpouJB/JkyBBsqEpMNM2DVx8Nq3LpYTbqkowOw0XwxQAQaME9m8M3EI90bg7d6Ou\n0hsPIqQvmlwzLSHFnLDeOAjlTCX5o6SsISBWAKQFx8gsuU+XL2AylcmMnIHtyEbE\nqx+0YOQ7v+w9UzyLtzyJktct6Ng9URCY12mz0Ph7oB7R3NMDIpaJ179XpEnxjHER\n7TnhDtUSHkqdK5Y9csPbI7W780yXjQKiJwK96QhfxpboiNsMvT1jyD/uBI7fNvqS\neMm0OAkwcx7XIXXzBQ2ZRT4Eap1UacxBznSgvxAzeysp8YT7OBAdZrAdD3I6XJLQ\n02IFhtUPGXjLCu2xpJGp1pGgRaGgPe52mRsrcpiUnpgaVL13rCxLazWwPrtL9hDx\nhf8tLNZRwok7lEpXfPrBq3DjBuB1kXnW5Q6m6LsNu16WdcfR1+bZ+9sAIJ3LjQQs\nmsP5QP7NRwjdG60ohKIDEteKNulQVBkxfwJ2TKGIoERppO2H5aqfuIwOud5U0QXo\nwrI8feopyZhWI8CWHoMEJfTMvtoMzWXYJP6BTstZw+igtCbWJCN9Lc0WASCpEH48\ns9k0eGkZUmVG/O3mwojLxyMVYBBg1HiF0rsHaXkENd6v5UuMwutQjHeyiHyZe0NZ\ntskONI2bYPMxQXIcMYavvg==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2025-01-01T12:36:56.000000Z'
last_seen:
type: string
example: '2026-01-05T02:35:23.000000Z'
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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
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
-
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.'
-
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
enum:
- not_valid_after
-
in: query
name: filter
description: ''
example: organization
required: false
schema:
type: 'The column(s) to filter by. Eg filter=common_name:test.nl'
description: ''
example: organization
enum:
- common_name
- organization
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Certificates
'/v1/certificates/{id}':
get:
summary: 'Retrieve a certificate.'
operationId: retrieveACertificate
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: 'Successfully retrieved certificate'
content:
application/json:
schema:
type: object
example:
data:
id: a0c96b86-d338-49b8-a29f-7379e29298b2
company_id: '9903690'
common_name: jones.com
organization: 'Buckridge, Powlowski and Muller'
organizational_unit: LLC
locality: Steubertown
state: 'North Dakota'
country: GT
serial: C2CRSGA6SLVSDH2FXAD8GDXLR5IALCUZ
not_valid_before: 20250707T164034Z
not_valid_after: 20270723T204357Z
value: "-----BEGIN CERTIFICATE-----\nKlbvusK4k7eKmIY8czkkjr80TUAaWaZTEp6dnw2vkR5DSGf0HIRR1TY5xCGAjpws\nsV4C9vWWSc4M3uKH9pJR43wmC+FIZlb1tJuHc7P4QoTarkqLDbst1JsbbBYvpZBU\n55Z789LdbpO5EAA1UtYkkF+lgmQSYP6nzRdeR6CK/Ug2U87Ym1NWMILkJwFTLO8h\nPJolRDnPzytILy4nnXrl2kMgsT+1XOqFRy/r7OZycruj9rt+YXRZSSDP3GWPhoS4\nyyWCzbuP2iKP9RxXDneqUu9s+ApuZuCVhLZn9FNYm265wpVEsrrqnfu/lRCv8ScB\nOllYxfuDH/2chxowpcCmer6Bs9CPrqCxt3jjtR8bp23T4nLud6/f7jyG0P5Dzphz\nMyAZhU81LKx7v5nht4+Fm+ih6EvOdakBb8KlLP/OswNOQTVweq3GTot+H72pzM2X\nf3QhWBCG8M92iXK+EJ7q9kIuN6fVhXh9HrsdGB95dVDKDWcyLiGpdMGJ+QXpc37o\nH0j5UXl895dHswiSooDZwMpCk/JDMwzwhjDAgfaUTEFBJKU58G1gkusx0Iu96G2s\n//RvOWNJIeXTrAghMJ95bG+rwNrxkXQwSMbV+5esIDd9QgbZPiGgAAbtXdT5KQXc\nTy8sRbfFKhQqH6ch6m3n2X9mf/9IasrKle9XVsUQB+y/DLJH8okEjNZFGSeqCzvN\nvp0zfluShoEacaZ8Uw81SXyx3UwoBNNDh9TkdDrGx8hlAAsolcuMJ85ntxig5/kE\nPRao65KNQNcSlz3lzBafAXDkDEhx1mfB8Y5LUTRUs5p/vHqd16b71YyCV8yHlye+\ncQwbjG5TUgSiMMmZUmNUSHCm5OGXNdf6j7eoPOGkQWoTBAtohrKkgh7RLDR73dJl\nsdgxUptb8liRqG3yIcdbh0xqPem2mKT8w/UX1VjWplHVyo/XjN5ZFWNRZS/GpsWE\nAo6v361I8Jzl3S8cqTK4VR+mNtd6kGGKlGkYilXUk7QoDy4//koWOqU0BFKXps1D\nO8LmmTaVieiJvGMANhwCSLPNDD4tySOOkUODiBWHEGXdxfP7qE+FPa0ehr5tOLLy\njF7MAr5n9K7LoWQAFtwfAq9RbBhpuSqfxh06309kD8bXyEDmdXx4qbu3g1qEHPe8\nuMgRx47ZjKJfsjz04vNdWb8JZk6MJYXmHpSK6mfJt7ac4n5F+zk21SRcA/Rf+4+6\nbKPeNtSPdLcfmAUlTIHTOB3HqWMvi5RX8o6KwEpdYBdtsVn1HTkE2wMhkIYDMkEo\ngQTriExYQvHXUnCDboEWN8huJjZS3E1RIpIX8vwHOHbHdHEymMUNjS0y1uQ2xLq4\n19rDZm+Q72GO25dA4mYyPA==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-10T15:04:17.000000Z'
last_seen: '2025-07-23T23:17:49.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-d338-49b8-a29f-7379e29298b2
company_id:
type: string
example: '9903690'
common_name:
type: string
example: jones.com
organization:
type: string
example: 'Buckridge, Powlowski and Muller'
organizational_unit:
type: string
example: LLC
locality:
type: string
example: Steubertown
state:
type: string
example: 'North Dakota'
country:
type: string
example: GT
serial:
type: string
example: C2CRSGA6SLVSDH2FXAD8GDXLR5IALCUZ
not_valid_before:
type: string
example: 20250707T164034Z
not_valid_after:
type: string
example: 20270723T204357Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nKlbvusK4k7eKmIY8czkkjr80TUAaWaZTEp6dnw2vkR5DSGf0HIRR1TY5xCGAjpws\nsV4C9vWWSc4M3uKH9pJR43wmC+FIZlb1tJuHc7P4QoTarkqLDbst1JsbbBYvpZBU\n55Z789LdbpO5EAA1UtYkkF+lgmQSYP6nzRdeR6CK/Ug2U87Ym1NWMILkJwFTLO8h\nPJolRDnPzytILy4nnXrl2kMgsT+1XOqFRy/r7OZycruj9rt+YXRZSSDP3GWPhoS4\nyyWCzbuP2iKP9RxXDneqUu9s+ApuZuCVhLZn9FNYm265wpVEsrrqnfu/lRCv8ScB\nOllYxfuDH/2chxowpcCmer6Bs9CPrqCxt3jjtR8bp23T4nLud6/f7jyG0P5Dzphz\nMyAZhU81LKx7v5nht4+Fm+ih6EvOdakBb8KlLP/OswNOQTVweq3GTot+H72pzM2X\nf3QhWBCG8M92iXK+EJ7q9kIuN6fVhXh9HrsdGB95dVDKDWcyLiGpdMGJ+QXpc37o\nH0j5UXl895dHswiSooDZwMpCk/JDMwzwhjDAgfaUTEFBJKU58G1gkusx0Iu96G2s\n//RvOWNJIeXTrAghMJ95bG+rwNrxkXQwSMbV+5esIDd9QgbZPiGgAAbtXdT5KQXc\nTy8sRbfFKhQqH6ch6m3n2X9mf/9IasrKle9XVsUQB+y/DLJH8okEjNZFGSeqCzvN\nvp0zfluShoEacaZ8Uw81SXyx3UwoBNNDh9TkdDrGx8hlAAsolcuMJ85ntxig5/kE\nPRao65KNQNcSlz3lzBafAXDkDEhx1mfB8Y5LUTRUs5p/vHqd16b71YyCV8yHlye+\ncQwbjG5TUgSiMMmZUmNUSHCm5OGXNdf6j7eoPOGkQWoTBAtohrKkgh7RLDR73dJl\nsdgxUptb8liRqG3yIcdbh0xqPem2mKT8w/UX1VjWplHVyo/XjN5ZFWNRZS/GpsWE\nAo6v361I8Jzl3S8cqTK4VR+mNtd6kGGKlGkYilXUk7QoDy4//koWOqU0BFKXps1D\nO8LmmTaVieiJvGMANhwCSLPNDD4tySOOkUODiBWHEGXdxfP7qE+FPa0ehr5tOLLy\njF7MAr5n9K7LoWQAFtwfAq9RbBhpuSqfxh06309kD8bXyEDmdXx4qbu3g1qEHPe8\nuMgRx47ZjKJfsjz04vNdWb8JZk6MJYXmHpSK6mfJt7ac4n5F+zk21SRcA/Rf+4+6\nbKPeNtSPdLcfmAUlTIHTOB3HqWMvi5RX8o6KwEpdYBdtsVn1HTkE2wMhkIYDMkEo\ngQTriExYQvHXUnCDboEWN8huJjZS3E1RIpIX8vwHOHbHdHEymMUNjS0y1uQ2xLq4\n19rDZm+Q72GO25dA4mYyPA==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2025-07-10T15:04:17.000000Z'
last_seen:
type: string
example: '2025-07-23T23:17:49.000000Z'
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: quod
required: true
schema:
type: string
/v1/detections:
get:
summary: 'List detections.'
operationId: listDetections
description: " Retrieve all detections for the current company. \n "
parameters:
-
in: query
name: 'filter[search]'
description: 'Search across multiple fields (src_ip, src_hostname, src_mac, dst_ip, sensor, honeypot alias)'
example: '192.168'
required: false
schema:
type: string
description: 'Search across multiple fields (src_ip, src_hostname, src_mac, dst_ip, sensor, honeypot alias)'
example: '192.168'
-
in: query
name: 'filter[sensor]'
description: 'Filter by sensor type'
example: MySQL
required: false
schema:
type: string
description: 'Filter by sensor type'
example: MySQL
enum:
- SSH
- MSSQL
- Blackhole
- MySQL
- SMB
- FTP
- UPnP
- HTTP
- Ping
- Portscan
- Modbus
-
in: query
name: 'filter[honeypot_id]'
description: 'Filter by honeypot UUID'
example: 550e8400-e29b-41d4-a716-446655440000
required: false
schema:
type: string
description: 'Filter by honeypot UUID'
example: 550e8400-e29b-41d4-a716-446655440000
-
in: query
name: 'filter[honeypot_alias]'
description: 'Filter by honeypot alias (partial match)'
example: Production
required: false
schema:
type: string
description: 'Filter by honeypot alias (partial match)'
example: Production
-
in: query
name: 'filter[src_ip]'
description: 'Filter by source IP (partial match)'
example: '192.168'
required: false
schema:
type: string
description: 'Filter by source IP (partial match)'
example: '192.168'
-
in: query
name: 'filter[src_hostname]'
description: 'Filter by reverse DNS hostname (partial match)'
example: attacker.example.com
required: false
schema:
type: string
description: 'Filter by reverse DNS hostname (partial match)'
example: attacker.example.com
-
in: query
name: 'filter[marked_as_seen]'
description: 'Filter by seen status'
example: 'true'
required: false
schema:
type: string
description: 'Filter by seen status'
example: 'true'
enum:
- 'true'
- 'false'
-
in: query
name: include
description: 'Include related resources'
example: events
required: false
schema:
type: string
description: 'Include related resources'
example: events
enum:
- events
-
in: query
name: sort
description: 'Sort by field (prefix with - for descending)'
example: '-timestamp'
required: false
schema:
type: string
description: 'Sort by field (prefix with - for descending)'
example: '-timestamp'
enum:
- timestamp
- '-timestamp'
-
in: query
name: page
description: 'Page number'
example: 1
required: false
schema:
type: integer
description: 'Page number'
example: 1
-
in: query
name: per_page
description: 'Results per page (max 20)'
example: 10
required: false
schema:
type: integer
description: 'Results per page (max 20)'
example: 10
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-65f8-4278-a1e2-7051d4cf2d85
company_id: b6b4b103-cff4-4f5a-9d2c-3a13b14e8ccb
src_ip: 209.237.44.81
dst_ip: 33.60.182.65
sensor: Modbus
timestamp: '2024-09-11T22:43:19.000000Z'
marked_as_seen: false
honeypot_id: null
honeypot_alias: null
src_port: 54412
src_hostname: null
src_mac: null
dst_port: 22506
-
id: a0c96b86-6ac5-4a31-9291-6062c8af0426
company_id: a9d23ba2-acbf-4f5f-a1ec-9ce3eeb8be91
src_ip: 9.221.230.127
dst_ip: 157.200.46.72
sensor: Modbus
timestamp: '2025-06-07T12:04:39.000000Z'
marked_as_seen: true
honeypot_id: null
honeypot_alias: null
src_port: 14269
src_hostname: null
src_mac: null
dst_port: 22038
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: a0c96b86-65f8-4278-a1e2-7051d4cf2d85
company_id: b6b4b103-cff4-4f5a-9d2c-3a13b14e8ccb
src_ip: 209.237.44.81
dst_ip: 33.60.182.65
sensor: Modbus
timestamp: '2024-09-11T22:43:19.000000Z'
marked_as_seen: false
honeypot_id: null
honeypot_alias: null
src_port: 54412
src_hostname: null
src_mac: null
dst_port: 22506
-
id: a0c96b86-6ac5-4a31-9291-6062c8af0426
company_id: a9d23ba2-acbf-4f5f-a1ec-9ce3eeb8be91
src_ip: 9.221.230.127
dst_ip: 157.200.46.72
sensor: Modbus
timestamp: '2025-06-07T12:04:39.000000Z'
marked_as_seen: true
honeypot_id: null
honeypot_alias: null
src_port: 14269
src_hostname: null
src_mac: null
dst_port: 22038
items:
type: object
properties:
id:
type: string
example: a0c96b86-65f8-4278-a1e2-7051d4cf2d85
company_id:
type: string
example: b6b4b103-cff4-4f5a-9d2c-3a13b14e8ccb
src_ip:
type: string
example: 209.237.44.81
dst_ip:
type: string
example: 33.60.182.65
sensor:
type: string
example: Modbus
timestamp:
type: string
example: '2024-09-11T22:43:19.000000Z'
marked_as_seen:
type: boolean
example: false
honeypot_id:
type: string
example: null
honeypot_alias:
type: string
example: null
src_port:
type: integer
example: 54412
src_hostname:
type: string
example: null
src_mac:
type: string
example: null
dst_port:
type: integer
example: 22506
required:
- id
- company_id
- src_ip
- dst_ip
- sensor
- timestamp
- marked_as_seen
- honeypot_id
- honeypot_alias
- src_port
- src_hostname
- src_mac
- dst_port
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:
- Detections
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
properties:
search:
type: string
description: 'Must not be greater than 255 characters.'
example: sr
sensor:
type: string
description: ''
example: null
honeypot_id:
type: string
description: 'Must be a valid UUID.'
example: 9c5d0541-4efe-3267-a306-a3687a893f34
honeypot_alias:
type: string
description: 'Must not be greater than 255 characters.'
example: tporblwpkcqowpmy
src_ip:
type: string
description: 'Must not be greater than 255 characters.'
example: o
src_hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: poqsxi
marked_as_seen:
type: string
description: ''
example: 'true'
enum:
- 'true'
- 'false'
include:
type: string
description: ''
example: events
enum:
- events
page:
type: integer
description: 'Must be at least 1.'
example: 51
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 20.'
example: 3
sort:
type: string
description: ''
example: timestamp
enum:
- timestamp
- '-timestamp'
'/v1/detections/{detection_id}/seen':
patch:
summary: 'Mark a detection as seen.'
operationId: markADetectionAsSeen
description: " Mark a single detection as seen. Idempotent - marking an already seen detection will succeed without side effects.\n "
parameters: []
responses:
204:
description: 'Detection marked as seen successfully'
content:
application/json:
schema:
type: object
nullable: true
404:
description: 'Detection not found or not accessible'
content:
application/json:
schema:
type: object
nullable: true
tags:
- Detections
parameters:
-
in: path
name: detection_id
description: 'The ID of the detection.'
example: a0c96b86-65f8-4278-a1e2-7051d4cf2d85
required: true
schema:
type: string
-
in: path
name: detection
description: 'The UUID of the detection to mark as seen'
example: 550e8400-e29b-41d4-a716-446655440000
required: true
schema:
type: string
/v1/detections/mark-multiple-seen:
post:
summary: 'Mark multiple detections as seen.'
operationId: markMultipleDetectionsAsSeen
description: " Mark multiple detections as seen in a single request. If no detection IDs are provided, all unseen detections for the company will be marked as seen.\n "
parameters: []
responses:
204:
description: 'Detections marked as seen successfully'
content:
application/json:
schema:
type: object
nullable: true
422:
description: 'Validation error - invalid UUIDs or detections not found'
content:
application/json:
schema:
type: object
nullable: true
tags:
- Detections
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
detection_ids:
type: array
description: 'Array of detection UUIDs to mark as seen. If omitted, all unseen detections will be marked.'
example: '["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"]'
items:
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: laudantium
required: true
schema:
type: string
/v1/honeypots:
post:
summary: 'Create honeypot.'
operationId: createHoneypot
description: "Will create a new honeypot for the current company. \n "
parameters: []
responses:
200:
description: 'Successfully created honeypot'
content:
application/json:
schema:
type: object
example:
data:
id: e21861c9-f2cb-489f-8c89-5ca519d3216b
alias: Honeypot-Office-32
status: 5
activation_status: 1
hostname: honeypot-vgze-548.example.com
slane_enabled: true
slane_connected: false
paired: true
provisioned: true
dns1: 252.54.19.127
dns2: 15.91.233.54
configured_as: null
notes: null
checked_at: '2025-11-07T14:00:24.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: e21861c9-f2cb-489f-8c89-5ca519d3216b
alias:
type: string
example: Honeypot-Office-32
status:
type: integer
example: 5
activation_status:
type: integer
example: 1
hostname:
type: string
example: honeypot-vgze-548.example.com
slane_enabled:
type: boolean
example: true
slane_connected:
type: boolean
example: false
paired:
type: boolean
example: true
provisioned:
type: boolean
example: true
dns1:
type: string
example: 252.54.19.127
dns2:
type: string
example: 15.91.233.54
configured_as:
type: string
example: null
notes:
type: string
example: null
checked_at:
type: string
example: '2025-11-07T14:00:24.000000Z'
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
required:
- id
- alias
- status
- activation_status
- hostname
- slane_enabled
- slane_connected
- paired
- provisioned
- dns1
- dns2
- configured_as
- notes
- checked_at
- created_at
- updated_at
tags:
- Honeypots
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
alias:
type: string
description: 'Alias is used to identify the Honeypot (not visible to the attacker).'
example: 'Internal Honeypot'
required:
- alias
/v1/integrations:
get:
summary: 'List Integrations'
operationId: listIntegrations
description: "Retrieve all enabled integrations for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '[{"autotask": {...}, "another_integration": {...}}]'
tags:
- Integrations
'/v1/integrations/{integration}':
post:
summary: 'Enable Integration'
operationId: enableIntegration
description: "Enable a new integration for the current company.\n"
parameters: []
responses:
201:
description: 'integration enabled'
content:
application/json:
schema:
type: object
example:
message: 'Integration enabled successfully'
properties:
message:
type: string
example: 'Integration enabled successfully'
400:
description: 'enable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to enable integration'
properties:
error:
type: string
example: 'Failed to enable integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
get:
summary: 'Show Integration'
operationId: showIntegration
description: "Retrieve details of a specific enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'integration not found'
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
-
description: 'integration not enabled'
type: object
example:
error: 'Integration not enabled'
properties:
error:
type: string
example: 'Integration not enabled'
tags:
- Integrations
patch:
summary: 'Update Integration'
operationId: updateIntegration
description: "Update the configuration of an enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
message: 'Integration updated successfully'
properties:
message:
type: string
example: 'Integration updated successfully'
400:
description: 'update failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to update integration'
properties:
error:
type: string
example: 'Failed to update integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
delete:
summary: 'Disable Integration'
operationId: disableIntegration
description: "Disable a specific integration for the current company.\n"
parameters: []
responses:
204:
description: 'disable successful'
content:
text/plain:
schema:
type: string
example: ''
400:
description: 'disable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to disable integration'
properties:
error:
type: string
example: 'Failed to disable integration'
tags:
- Integrations
parameters:
-
in: path
name: integration
description: 'The name of the integration to enable.'
example: autotask
required: true
schema:
type: string
/v1/me:
get:
summary: 'Retrieve the authenticated user'
operationId: retrieveTheAuthenticatedUser
description: 'Retrieves the authenticated user and its metadata.'
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: d484f6d3-28bf-420b-a05d-48105418de2c
company_id: '2358872'
managing_company_id: '2358872'
first_name: Nikki
last_name: Ledner
two_factor_enabled: false
two_factor_configured: false
email: joanne83@murphy.biz
email_verified_at: '2026-01-08T10:52:07Z'
phonenumber: '(325) 365-8088'
phonenumber_verified_at: '2026-01-08T10:52:07Z'
report_interval: weekly
manageable_companies:
-
id: '2358872'
uuid: 159b1495-49a6-4a55-804a-9e6354a3ff6f
name: 'Daniel Group'
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2026-01-08T10:52:07Z'
sso_provider: null
created_at: '2026-01-08T10:52:07Z'
updated_at: '2026-01-08T10:52:07Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: d484f6d3-28bf-420b-a05d-48105418de2c
company_id:
type: string
example: '2358872'
managing_company_id:
type: string
example: '2358872'
first_name:
type: string
example: Nikki
last_name:
type: string
example: Ledner
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: joanne83@murphy.biz
email_verified_at:
type: string
example: '2026-01-08T10:52:07Z'
phonenumber:
type: string
example: '(325) 365-8088'
phonenumber_verified_at:
type: string
example: '2026-01-08T10:52:07Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '2358872'
uuid: 159b1495-49a6-4a55-804a-9e6354a3ff6f
name: 'Daniel Group'
items:
type: object
properties:
id:
type: string
example: '2358872'
uuid:
type: string
example: 159b1495-49a6-4a55-804a-9e6354a3ff6f
name:
type: string
example: 'Daniel Group'
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: '2026-01-08T10:52:07Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:07Z'
updated_at:
type: string
example: '2026-01-08T10:52:07Z'
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
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: Doe
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'
report_interval:
type: string
description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.'
example: weekly
terms_agreed_at:
type: string
description: 'Must be a valid date.'
example: '2026-01-08T10:52:07'
role:
type: string
description: 'Must be a valid role name.'
example: admin
/v1/tags:
get:
summary: 'List tags.'
operationId: listTags
description: " Retrieve all tags for the current company. Look at the 'Retrieve a tag' endpoint for more details on the tag object.\n "
parameters:
-
in: query
name: 'filter[name]'
description: ''
example: libero
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: libero
-
in: query
name: 'filter[business_impact]'
description: ''
example: high
required: false
schema:
type: 'Filter by business impact.'
description: ''
example: high
-
in: query
name: 'filter[system_tag]'
description: ''
example: true
required: false
schema:
type: 'Filter tags that are default.'
description: ''
example: true
-
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
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
enum:
- assets
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-db10-460e-8bf6-7da1e6b57b14
company_id: '9272510'
name: 37a8c180-9a58-3a22-a744-2aa915354bb0
description: 'Dolorem dicta reprehenderit occaecati ea enim. Earum praesentium tenetur nobis ipsa maiores. Et eius distinctio labore dolorum sed doloribus.'
business_impact: critical
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-dddb-44a2-9e5c-59f9c071b608
company_id: '4669246'
name: 8485c048-1c5e-362b-bf48-3e9275678779
description: 'Doloribus quas voluptate aliquid atque ipsa. Perspiciatis et ratione ut quo est voluptatum. Neque est doloremque rem ipsa et voluptatem inventore officiis. Sit est ipsa unde veritatis alias.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.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: a0c96b86-db10-460e-8bf6-7da1e6b57b14
company_id: '9272510'
name: 37a8c180-9a58-3a22-a744-2aa915354bb0
description: 'Dolorem dicta reprehenderit occaecati ea enim. Earum praesentium tenetur nobis ipsa maiores. Et eius distinctio labore dolorum sed doloribus.'
business_impact: critical
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
-
id: a0c96b86-dddb-44a2-9e5c-59f9c071b608
company_id: '4669246'
name: 8485c048-1c5e-362b-bf48-3e9275678779
description: 'Doloribus quas voluptate aliquid atque ipsa. Perspiciatis et ratione ut quo est voluptatum. Neque est doloremque rem ipsa et voluptatem inventore officiis. Sit est ipsa unde veritatis alias.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b86-db10-460e-8bf6-7da1e6b57b14
company_id:
type: string
example: '9272510'
name:
type: string
example: 37a8c180-9a58-3a22-a744-2aa915354bb0
description:
type: string
example: 'Dolorem dicta reprehenderit occaecati ea enim. Earum praesentium tenetur nobis ipsa maiores. Et eius distinctio labore dolorum sed doloribus.'
business_impact:
type: string
example: critical
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: a0c96b86-e2db-4f89-9614-1fb918e7f04d
company_id: '6226996'
name: 5274eaa8-1f49-3203-88d0-82280f2423c9
description: 'Vero dolor explicabo rerum quia. Sed optio deserunt impedit est est iste id. Sit nihil ea aperiam. Quis assumenda modi omnis ut quaerat vitae.'
business_impact: high
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-e2db-4f89-9614-1fb918e7f04d
company_id:
type: string
example: '6226996'
name:
type: string
example: 5274eaa8-1f49-3203-88d0-82280f2423c9
description:
type: string
example: 'Vero dolor explicabo rerum quia. Sed optio deserunt impedit est est iste id. Sit nihil ea aperiam. Quis assumenda modi omnis ut quaerat vitae.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: vwrvosix
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Repudiandae est veniam optio nesciunt perspiciatis.'
business_impact:
type: string
description: ''
example: medium
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
enum:
- assets
responses:
200:
description: 'Successfully retrieved tag'
content:
application/json:
schema:
type: object
example:
data:
id: a0c96b86-e6d5-487d-80e0-50b8feef6cb2
company_id: '8050366'
name: c5b7ad4d-1b48-3159-bb2a-416b44c0fb2f
description: 'Et doloremque ut similique fugiat mollitia. Ad autem repudiandae dolores sunt omnis commodi. Provident ut et et aut ullam.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-e6d5-487d-80e0-50b8feef6cb2
company_id:
type: string
example: '8050366'
name:
type: string
example: c5b7ad4d-1b48-3159-bb2a-416b44c0fb2f
description:
type: string
example: 'Et doloremque ut similique fugiat mollitia. Ad autem repudiandae dolores sunt omnis commodi. Provident ut et et aut ullam.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: a0c96b86-eb49-4afb-896f-8ddb0cddb9a7
company_id: '3707995'
name: a654fca5-7813-348f-b89e-2c997b868e9e
description: 'Quae porro est quasi aliquid. Consectetur similique et laborum velit facilis et earum. Aperiam voluptas in aut.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-eb49-4afb-896f-8ddb0cddb9a7
company_id:
type: string
example: '3707995'
name:
type: string
example: a654fca5-7813-348f-b89e-2c997b868e9e
description:
type: string
example: 'Quae porro est quasi aliquid. Consectetur similique et laborum velit facilis et earum. Aperiam voluptas in aut.'
business_impact:
type: string
example: low
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: dmuqxedoekoksnjxvliet
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Hic sapiente adipisci repellendus velit.'
business_impact:
type: string
description: ''
example: low
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: ea
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.partner
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany.partner
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'
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'
enum:
- first_name
- last_name
- email
- phonenumber
- report_interval
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: ec40b736-4fcb-47c5-a68d-d133c0aa78ba
company_id: '7288164'
managing_company_id: '7288164'
first_name: Karlie
last_name: Borer
two_factor_enabled: false
email: kgutmann@heller.org
email_verified_at: '2026-01-08T10:52:08.000000Z'
phonenumber: 606-874-0965
phonenumber_verified_at: '2026-01-08T10:52:08.000000Z'
report_interval: weekly
manageable_companies:
-
id: '7288164'
uuid: 5b1bcae6-8db6-428b-9dc1-de7c07030606
name: Bergstrom-Cummings
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-01-08T10:52:08.000000Z'
sso_provider: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:09.000000Z'
-
id: 39adc7fb-efc8-4c03-bee0-3caebe049096
company_id: '1074101'
managing_company_id: '1074101'
first_name: Arely
last_name: Hilpert
two_factor_enabled: false
email: bartell.vincent@yahoo.com
email_verified_at: '2026-01-08T10:52:09.000000Z'
phonenumber: 806.705.8255
phonenumber_verified_at: '2026-01-08T10:52:09.000000Z'
report_interval: weekly
manageable_companies:
-
id: '1074101'
uuid: 80a8b7ae-f9b7-4ec2-8380-ce9ca05effe2
name: 'Yundt and Sons'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-01-08T10:52:09.000000Z'
sso_provider: null
created_at: '2026-01-08T10:52:09.000000Z'
updated_at: '2026-01-08T10:52: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: ec40b736-4fcb-47c5-a68d-d133c0aa78ba
company_id: '7288164'
managing_company_id: '7288164'
first_name: Karlie
last_name: Borer
two_factor_enabled: false
email: kgutmann@heller.org
email_verified_at: '2026-01-08T10:52:08.000000Z'
phonenumber: 606-874-0965
phonenumber_verified_at: '2026-01-08T10:52:08.000000Z'
report_interval: weekly
manageable_companies:
-
id: '7288164'
uuid: 5b1bcae6-8db6-428b-9dc1-de7c07030606
name: Bergstrom-Cummings
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-01-08T10:52:08.000000Z'
sso_provider: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:09.000000Z'
-
id: 39adc7fb-efc8-4c03-bee0-3caebe049096
company_id: '1074101'
managing_company_id: '1074101'
first_name: Arely
last_name: Hilpert
two_factor_enabled: false
email: bartell.vincent@yahoo.com
email_verified_at: '2026-01-08T10:52:09.000000Z'
phonenumber: 806.705.8255
phonenumber_verified_at: '2026-01-08T10:52:09.000000Z'
report_interval: weekly
manageable_companies:
-
id: '1074101'
uuid: 80a8b7ae-f9b7-4ec2-8380-ce9ca05effe2
name: 'Yundt and Sons'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-01-08T10:52:09.000000Z'
sso_provider: null
created_at: '2026-01-08T10:52:09.000000Z'
updated_at: '2026-01-08T10:52:09.000000Z'
items:
type: object
properties:
id:
type: string
example: ec40b736-4fcb-47c5-a68d-d133c0aa78ba
company_id:
type: string
example: '7288164'
managing_company_id:
type: string
example: '7288164'
first_name:
type: string
example: Karlie
last_name:
type: string
example: Borer
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: kgutmann@heller.org
email_verified_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
phonenumber:
type: string
example: 606-874-0965
phonenumber_verified_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '7288164'
uuid: 5b1bcae6-8db6-428b-9dc1-de7c07030606
name: Bergstrom-Cummings
items:
type: object
properties:
id:
type: string
example: '7288164'
uuid:
type: string
example: 5b1bcae6-8db6-428b-9dc1-de7c07030606
name:
type: string
example: Bergstrom-Cummings
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52: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:
- 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: xrbwhj
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: yviofdfkp
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: santino.feeney@example.com
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: ''
example: disabled
enum:
- disabled
- weekly
- monthly
- quarterly
role:
type: required
description: 'string Must be a valid role name.'
example: admin
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
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 6ae50dfd-ddc2-46f7-a7f4-671ffcbfb10f
company_id: '8318259'
managing_company_id: '8318259'
first_name: Ward
last_name: Stiedemann
two_factor_enabled: false
email: tomas.hoppe@gmail.com
email_verified_at: '2026-01-08T10:52:09.000000Z'
phonenumber: 559-620-9500
phonenumber_verified_at: '2026-01-08T10:52:09.000000Z'
report_interval: weekly
manageable_companies:
-
id: '8318259'
uuid: 0af6438e-9070-4a91-939b-134992dff0af
name: 'Boyle Ltd'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-01-08T10:52:09.000000Z'
sso_provider: null
created_at: '2026-01-08T10:52:09.000000Z'
updated_at: '2026-01-08T10:52:09.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 6ae50dfd-ddc2-46f7-a7f4-671ffcbfb10f
company_id:
type: string
example: '8318259'
managing_company_id:
type: string
example: '8318259'
first_name:
type: string
example: Ward
last_name:
type: string
example: Stiedemann
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: tomas.hoppe@gmail.com
email_verified_at:
type: string
example: '2026-01-08T10:52:09.000000Z'
phonenumber:
type: string
example: 559-620-9500
phonenumber_verified_at:
type: string
example: '2026-01-08T10:52:09.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '8318259'
uuid: 0af6438e-9070-4a91-939b-134992dff0af
name: 'Boyle Ltd'
items:
type: object
properties:
id:
type: string
example: '8318259'
uuid:
type: string
example: 0af6438e-9070-4a91-939b-134992dff0af
name:
type: string
example: 'Boyle Ltd'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-01-08T10:52:09.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:09.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:09.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
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: Doe
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: john@doe.com
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
role:
type: string
description: 'Must be a valid role name.'
example: admin
parameters:
-
in: path
name: user_uuid
description: 'string The id of the user'
example: 6ceb8f47-b0f0-3dd3-80d4-7389462d5bee
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
-
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
-
in: query
name: 'filter[hostname]'
description: ''
example: laptop-1.local
required: false
schema:
type: 'Filter vulnerabilities found on hostname'
description: ''
example: laptop-1.local
-
in: query
name: 'filter[status]'
description: ''
example: Unresolved
required: false
schema:
type: 'Filter vulnerabilities by their status'
description: ''
example: Unresolved
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
-
in: query
name: 'filter[threat]'
description: ''
example: Log
required: false
schema:
type: 'Filter vulnerabilities by their threat level'
description: ''
example: Log
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'
-
in: query
name: 'filter[family]'
description: ''
example: 'SQL Injection'
required: false
schema:
type: 'Filter vulnerabilities by their family'
description: ''
example: 'SQL Injection'
-
in: query
name: sort
description: ''
example: epss_score
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: epss_score
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b86-8551-42e5-b156-bf7c65c90fc6
asset_id: a0c96b86-7a65-450e-b330-beb5fdb5d861
company_id: '1915790'
vulnerability_definition_id: a0c96b86-847e-4033-b236-659cb112b0d8
vulnerability_definition:
id: a0c96b86-847e-4033-b236-659cb112b0d8
name: 'Persistent Stored XSS due to improper veniam handling'
description: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
solution: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
category: 'Stored XSS'
threat_level: High
definition_type: openvas
definition:
id: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id: 99e719d3-896a-31e9-957c-5e16ace16fe8
name: 'Persistent Stored XSS due to improper veniam handling'
family: 'Stored XSS'
reference_urls: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves: 'CVE-2022-1182, CVE-2021-5957'
solution_type: WorkAround
solution_description: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority: High
qod_type: package
qod_value: 56
cvss_base_score: 6.4
cvss_base_vector: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
epss: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
host: 171.209.80.63
hostname: ullrich.com
port: 5432/tcp
details: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
status: Unresolved
first_seen: '2025-01-31T19:12:20.000000Z'
last_seen: '2026-01-04T12:21:39.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
name: 'Persistent Stored XSS due to improper veniam handling'
description: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
cvss_base_score: 6.4
cvss_base_vector: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
qod_type: package
qod_value: 56
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id: 99e719d3-896a-31e9-957c-5e16ace16fe8
name: 'Persistent Stored XSS due to improper veniam handling'
family: 'Stored XSS'
reference_urls: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves: 'CVE-2022-1182, CVE-2021-5957'
solution_type: WorkAround
solution_description: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority: High
qod_type: package
qod_value: 56
-
id: a0c96b86-8e70-456f-a1a0-a8fc2380ee04
asset_id: a0c96b86-89ed-41be-bf2c-b5d66f0ce4a5
company_id: '9734382'
vulnerability_definition_id: a0c96b86-8dee-4140-a6c7-8af5f552d6e2
vulnerability_definition:
id: a0c96b86-8dee-4140-a6c7-8af5f552d6e2
name: '5 in rerum'
description: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
solution: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
category: '5'
threat_level: Critical
definition_type: openvas
definition:
id: a0c96b86-8cb4-4037-9af5-19db445db2a0
o_id: 2a123c85-5941-334a-8899-24148bd4a7d8
name: '5 in rerum'
family: '5'
reference_urls: 'http://morar.com/repellendus-perferendis-voluptatem-mollitia.html, https://cummings.biz/quam-cum-similique-numquam-amet.html'
reference_cves: 'CVE-2017-6674, CVE-2019-9409'
solution_type: 'Configuration Change'
solution_description: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
summary: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
insight: 'Et repudiandae autem eos dolor itaque voluptatem nulla. Repudiandae nihil fuga officiis facilis. Est aut tempora totam beatae nihil repellendus.'
affected: 'Deleniti consectetur minus et nihil officiis. Corrupti perspiciatis voluptatibus adipisci autem et distinctio voluptas. Consequuntur soluta voluptatem quia consequatur quod.'
impact: 'Perferendis quia sunt id. Accusamus excepturi commodi rerum ipsa sed aperiam officiis. Est ut enim sunt est est aut. Magni sint voluptas et et.'
vuldetect: 'Expedita sed sequi earum porro. Excepturi necessitatibus ab et accusantium dolorum dolores labore. Ipsum ex aliquam ab. Ipsa et enim provident. Odit et aut iure quia.'
priority: High
qod_type: remote_active
qod_value: 38
cvss_base_score: 6.4
cvss_base_vector: 'AV:A/AC:L/Au:S/C:P/I:C/A:P'
epss: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
host: 245.176.36.109
hostname: green.com
port: 38550/tcp
details: 'Ut quod dolore ab explicabo perspiciatis consectetur totam. Ea aut vel quos rerum. Distinctio voluptatibus aut quia voluptatem quas repellat ducimus. Quidem ut accusantium quia tempore et asperiores ipsum.'
status: Accepted
first_seen: '2025-02-07T20:17:40.000000Z'
last_seen: '2025-09-28T12:50:06.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
name: '5 in rerum'
description: 'Ut quod dolore ab explicabo perspiciatis consectetur totam. Ea aut vel quos rerum. Distinctio voluptatibus aut quia voluptatem quas repellat ducimus. Quidem ut accusantium quia tempore et asperiores ipsum.'
cvss_base_score: 6.4
cvss_base_vector: 'AV:A/AC:L/Au:S/C:P/I:C/A:P'
qod_type: remote_active
qod_value: 38
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a0c96b86-8cb4-4037-9af5-19db445db2a0
o_id: 2a123c85-5941-334a-8899-24148bd4a7d8
name: '5 in rerum'
family: '5'
reference_urls: 'http://morar.com/repellendus-perferendis-voluptatem-mollitia.html, https://cummings.biz/quam-cum-similique-numquam-amet.html'
reference_cves: 'CVE-2017-6674, CVE-2019-9409'
solution_type: 'Configuration Change'
solution_description: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
summary: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
insight: 'Et repudiandae autem eos dolor itaque voluptatem nulla. Repudiandae nihil fuga officiis facilis. Est aut tempora totam beatae nihil repellendus.'
affected: 'Deleniti consectetur minus et nihil officiis. Corrupti perspiciatis voluptatibus adipisci autem et distinctio voluptas. Consequuntur soluta voluptatem quia consequatur quod.'
impact: 'Perferendis quia sunt id. Accusamus excepturi commodi rerum ipsa sed aperiam officiis. Est ut enim sunt est est aut. Magni sint voluptas et et.'
vuldetect: 'Expedita sed sequi earum porro. Excepturi necessitatibus ab et accusantium dolorum dolores labore. Ipsum ex aliquam ab. Ipsa et enim provident. Odit et aut iure quia.'
priority: High
qod_type: remote_active
qod_value: 38
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: a0c96b86-8551-42e5-b156-bf7c65c90fc6
asset_id: a0c96b86-7a65-450e-b330-beb5fdb5d861
company_id: '1915790'
vulnerability_definition_id: a0c96b86-847e-4033-b236-659cb112b0d8
vulnerability_definition:
id: a0c96b86-847e-4033-b236-659cb112b0d8
name: 'Persistent Stored XSS due to improper veniam handling'
description: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
solution: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
category: 'Stored XSS'
threat_level: High
definition_type: openvas
definition:
id: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id: 99e719d3-896a-31e9-957c-5e16ace16fe8
name: 'Persistent Stored XSS due to improper veniam handling'
family: 'Stored XSS'
reference_urls: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves: 'CVE-2022-1182, CVE-2021-5957'
solution_type: WorkAround
solution_description: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority: High
qod_type: package
qod_value: 56
cvss_base_score: 6.4
cvss_base_vector: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
epss: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
host: 171.209.80.63
hostname: ullrich.com
port: 5432/tcp
details: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
status: Unresolved
first_seen: '2025-01-31T19:12:20.000000Z'
last_seen: '2026-01-04T12:21:39.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
name: 'Persistent Stored XSS due to improper veniam handling'
description: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
cvss_base_score: 6.4
cvss_base_vector: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
qod_type: package
qod_value: 56
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id: 99e719d3-896a-31e9-957c-5e16ace16fe8
name: 'Persistent Stored XSS due to improper veniam handling'
family: 'Stored XSS'
reference_urls: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves: 'CVE-2022-1182, CVE-2021-5957'
solution_type: WorkAround
solution_description: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority: High
qod_type: package
qod_value: 56
-
id: a0c96b86-8e70-456f-a1a0-a8fc2380ee04
asset_id: a0c96b86-89ed-41be-bf2c-b5d66f0ce4a5
company_id: '9734382'
vulnerability_definition_id: a0c96b86-8dee-4140-a6c7-8af5f552d6e2
vulnerability_definition:
id: a0c96b86-8dee-4140-a6c7-8af5f552d6e2
name: '5 in rerum'
description: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
solution: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
category: '5'
threat_level: Critical
definition_type: openvas
definition:
id: a0c96b86-8cb4-4037-9af5-19db445db2a0
o_id: 2a123c85-5941-334a-8899-24148bd4a7d8
name: '5 in rerum'
family: '5'
reference_urls: 'http://morar.com/repellendus-perferendis-voluptatem-mollitia.html, https://cummings.biz/quam-cum-similique-numquam-amet.html'
reference_cves: 'CVE-2017-6674, CVE-2019-9409'
solution_type: 'Configuration Change'
solution_description: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
summary: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
insight: 'Et repudiandae autem eos dolor itaque voluptatem nulla. Repudiandae nihil fuga officiis facilis. Est aut tempora totam beatae nihil repellendus.'
affected: 'Deleniti consectetur minus et nihil officiis. Corrupti perspiciatis voluptatibus adipisci autem et distinctio voluptas. Consequuntur soluta voluptatem quia consequatur quod.'
impact: 'Perferendis quia sunt id. Accusamus excepturi commodi rerum ipsa sed aperiam officiis. Est ut enim sunt est est aut. Magni sint voluptas et et.'
vuldetect: 'Expedita sed sequi earum porro. Excepturi necessitatibus ab et accusantium dolorum dolores labore. Ipsum ex aliquam ab. Ipsa et enim provident. Odit et aut iure quia.'
priority: High
qod_type: remote_active
qod_value: 38
cvss_base_score: 6.4
cvss_base_vector: 'AV:A/AC:L/Au:S/C:P/I:C/A:P'
epss: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
host: 245.176.36.109
hostname: green.com
port: 38550/tcp
details: 'Ut quod dolore ab explicabo perspiciatis consectetur totam. Ea aut vel quos rerum. Distinctio voluptatibus aut quia voluptatem quas repellat ducimus. Quidem ut accusantium quia tempore et asperiores ipsum.'
status: Accepted
first_seen: '2025-02-07T20:17:40.000000Z'
last_seen: '2025-09-28T12:50:06.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
name: '5 in rerum'
description: 'Ut quod dolore ab explicabo perspiciatis consectetur totam. Ea aut vel quos rerum. Distinctio voluptatibus aut quia voluptatem quas repellat ducimus. Quidem ut accusantium quia tempore et asperiores ipsum.'
cvss_base_score: 6.4
cvss_base_vector: 'AV:A/AC:L/Au:S/C:P/I:C/A:P'
qod_type: remote_active
qod_value: 38
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a0c96b86-8cb4-4037-9af5-19db445db2a0
o_id: 2a123c85-5941-334a-8899-24148bd4a7d8
name: '5 in rerum'
family: '5'
reference_urls: 'http://morar.com/repellendus-perferendis-voluptatem-mollitia.html, https://cummings.biz/quam-cum-similique-numquam-amet.html'
reference_cves: 'CVE-2017-6674, CVE-2019-9409'
solution_type: 'Configuration Change'
solution_description: 'Eum itaque minima eius debitis. Reprehenderit cum aliquam voluptas autem esse rerum in. Quibusdam necessitatibus nesciunt quis praesentium aut.'
summary: 'Nesciunt illo qui ea quae. Corporis enim expedita perspiciatis sunt. Omnis nesciunt eos fuga et consequuntur eos nisi.'
insight: 'Et repudiandae autem eos dolor itaque voluptatem nulla. Repudiandae nihil fuga officiis facilis. Est aut tempora totam beatae nihil repellendus.'
affected: 'Deleniti consectetur minus et nihil officiis. Corrupti perspiciatis voluptatibus adipisci autem et distinctio voluptas. Consequuntur soluta voluptatem quia consequatur quod.'
impact: 'Perferendis quia sunt id. Accusamus excepturi commodi rerum ipsa sed aperiam officiis. Est ut enim sunt est est aut. Magni sint voluptas et et.'
vuldetect: 'Expedita sed sequi earum porro. Excepturi necessitatibus ab et accusantium dolorum dolores labore. Ipsum ex aliquam ab. Ipsa et enim provident. Odit et aut iure quia.'
priority: High
qod_type: remote_active
qod_value: 38
items:
type: object
properties:
id:
type: string
example: a0c96b86-8551-42e5-b156-bf7c65c90fc6
asset_id:
type: string
example: a0c96b86-7a65-450e-b330-beb5fdb5d861
company_id:
type: string
example: '1915790'
vulnerability_definition_id:
type: string
example: a0c96b86-847e-4033-b236-659cb112b0d8
vulnerability_definition:
type: object
properties:
id:
type: string
example: a0c96b86-847e-4033-b236-659cb112b0d8
name:
type: string
example: 'Persistent Stored XSS due to improper veniam handling'
description:
type: string
example: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
solution:
type: string
example: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
category:
type: string
example: 'Stored XSS'
threat_level:
type: string
example: High
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id:
type: string
example: 99e719d3-896a-31e9-957c-5e16ace16fe8
name:
type: string
example: 'Persistent Stored XSS due to improper veniam handling'
family:
type: string
example: 'Stored XSS'
reference_urls:
type: string
example: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves:
type: string
example: 'CVE-2022-1182, CVE-2021-5957'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary:
type: string
example: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight:
type: string
example: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected:
type: string
example: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact:
type: string
example: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect:
type: string
example: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority:
type: string
example: High
qod_type:
type: string
example: package
qod_value:
type: integer
example: 56
cvss_base_score:
type: number
example: 6.4
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
epss:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
host:
type: string
example: 171.209.80.63
hostname:
type: string
example: ullrich.com
port:
type: string
example: 5432/tcp
details:
type: string
example: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
status:
type: string
example: Unresolved
first_seen:
type: string
example: '2025-01-31T19:12:20.000000Z'
last_seen:
type: string
example: '2026-01-04T12:21:39.000000Z'
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
name:
type: string
example: 'Persistent Stored XSS due to improper veniam handling'
description:
type: string
example: 'Excepturi laboriosam in quia corporis enim totam vel. Repellendus sapiente ipsa iusto maxime. Ipsam est ratione hic nisi. Sed magni assumenda in est non nostrum delectus.'
cvss_base_score:
type: number
example: 6.4
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:N/C:C/I:N/A:P'
qod_type:
type: string
example: package
qod_value:
type: integer
example: 56
threat:
type: string
example: High
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: a0c96b86-8206-4df3-9bdc-e22d7acc1548
o_id:
type: string
example: 99e719d3-896a-31e9-957c-5e16ace16fe8
name:
type: string
example: 'Persistent Stored XSS due to improper veniam handling'
family:
type: string
example: 'Stored XSS'
reference_urls:
type: string
example: 'http://daniel.com/non-ea-maxime-voluptatem-aliquam-molestias-itaque, https://kihn.biz/et-ratione-tenetur-quam-delectus-eius.html'
reference_cves:
type: string
example: 'CVE-2022-1182, CVE-2021-5957'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Nisi possimus molestiae est natus. Placeat cumque est explicabo aliquam vel eos enim. Provident nobis quae laudantium quia et.'
summary:
type: string
example: 'Maxime debitis expedita omnis laboriosam. Rem consectetur et sapiente autem quia. Qui sed placeat fugit voluptas fugit commodi eos sapiente.'
insight:
type: string
example: 'Consequuntur unde laborum nulla cumque eaque. Incidunt natus aut eum officia iste incidunt. Magnam error aliquid quae quo voluptas accusantium.'
affected:
type: string
example: 'Inventore error nobis sit magnam ab. Vero aperiam molestiae necessitatibus totam fugiat error dicta nulla. Quo quos optio ducimus sunt minus accusantium commodi. Animi error reiciendis nostrum quod impedit qui.'
impact:
type: string
example: 'Et omnis quam enim amet sequi. Qui quas dolor veritatis reprehenderit. Adipisci minima qui cum qui a nihil. Fugiat vel magnam et ut corrupti voluptas. Facilis eos perspiciatis qui architecto rerum.'
vuldetect:
type: string
example: 'Neque saepe voluptatem totam eaque. Voluptatem nostrum assumenda autem vero. Beatae quasi qui accusantium odit quidem. Rerum beatae esse eligendi quam.'
priority:
type: string
example: High
qod_type:
type: string
example: package
qod_value:
type: integer
example: 56
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: []
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: zcbd
threat_level:
type: string
description: ''
example: Medium
enum:
- Log
- Low
- Medium
- High
- Critical
host:
type: string
description: 'Must not be greater than 255 characters.'
example: hvxgtqmpdnkh
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: pcchxpoe
status:
type: string
description: ''
example: Resolved
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: fc8a7303-5585-37cb-99c0-80ab9f4e5722
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 6
'/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: a0c96b86-9dbd-4482-a9fa-60e80b6e080b
asset_id: a0c96b86-98a4-4574-9966-5b535e63170d
company_id: '613133'
vulnerability_definition_id: a0c96b86-9d3b-4316-b252-f84eda09fd80
vulnerability_definition:
id: a0c96b86-9d3b-4316-b252-f84eda09fd80
name: 'Clear-text Transmission via minima input'
description: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
solution: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
category: 'Clear-text Transmission'
threat_level: Critical
definition_type: openvas
definition:
id: a0c96b86-9bb3-431f-ba88-1dcb27df3ce9
o_id: 78b59196-c94e-3781-9b13-f6c9b80235ae
name: 'Clear-text Transmission via minima input'
family: 'Clear-text Transmission'
reference_urls: 'https://www.gaylord.net/veniam-quia-magni-aliquam-unde, http://www.senger.com/'
reference_cves: 'CVE-2016-6879, CVE-2023-8400'
solution_type: VendorFix
solution_description: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
summary: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
insight: 'Voluptates et doloremque inventore tempore. Inventore aliquid unde repellendus architecto dolor. Rerum est atque dolorem laboriosam.'
affected: 'Ea deleniti maiores soluta aut odio. Culpa consectetur commodi et asperiores delectus exercitationem. Qui magnam rerum ab repellat rerum. Minima voluptatum expedita eligendi autem qui.'
impact: 'Repellat voluptas occaecati voluptatem tenetur. Aut eum non quam consequatur et quia. Quos error quos molestiae fugiat.'
vuldetect: 'Occaecati beatae ad adipisci libero quia ut. Consequatur qui necessitatibus architecto sed eveniet commodi. Laudantium quisquam quos beatae doloribus maiores et. Reiciendis rerum ut sed ut.'
priority: Low
qod_type: remote_active
qod_value: 29
cvss_base_score: 7.8
cvss_base_vector: 'AV:P/AC:L/Au:S/C:N/I:P/A:C'
epss: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
host: 62.64.127.93
hostname: hand.biz
port: 22/tcp
details: 'Vel est et eveniet inventore aliquid labore modi. Est est exercitationem veniam. Autem consequatur voluptates dignissimos illo consectetur aut. Est occaecati quis aut earum.'
status: Expired
first_seen: '2025-06-30T06:56:49.000000Z'
last_seen: '2025-07-05T02:43:20.000000Z'
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
name: 'Clear-text Transmission via minima input'
description: 'Vel est et eveniet inventore aliquid labore modi. Est est exercitationem veniam. Autem consequatur voluptates dignissimos illo consectetur aut. Est occaecati quis aut earum.'
cvss_base_score: 7.8
cvss_base_vector: 'AV:P/AC:L/Au:S/C:N/I:P/A:C'
qod_type: remote_active
qod_value: 29
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a0c96b86-9bb3-431f-ba88-1dcb27df3ce9
o_id: 78b59196-c94e-3781-9b13-f6c9b80235ae
name: 'Clear-text Transmission via minima input'
family: 'Clear-text Transmission'
reference_urls: 'https://www.gaylord.net/veniam-quia-magni-aliquam-unde, http://www.senger.com/'
reference_cves: 'CVE-2016-6879, CVE-2023-8400'
solution_type: VendorFix
solution_description: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
summary: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
insight: 'Voluptates et doloremque inventore tempore. Inventore aliquid unde repellendus architecto dolor. Rerum est atque dolorem laboriosam.'
affected: 'Ea deleniti maiores soluta aut odio. Culpa consectetur commodi et asperiores delectus exercitationem. Qui magnam rerum ab repellat rerum. Minima voluptatum expedita eligendi autem qui.'
impact: 'Repellat voluptas occaecati voluptatem tenetur. Aut eum non quam consequatur et quia. Quos error quos molestiae fugiat.'
vuldetect: 'Occaecati beatae ad adipisci libero quia ut. Consequatur qui necessitatibus architecto sed eveniet commodi. Laudantium quisquam quos beatae doloribus maiores et. Reiciendis rerum ut sed ut.'
priority: Low
qod_type: remote_active
qod_value: 29
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-9dbd-4482-a9fa-60e80b6e080b
asset_id:
type: string
example: a0c96b86-98a4-4574-9966-5b535e63170d
company_id:
type: string
example: '613133'
vulnerability_definition_id:
type: string
example: a0c96b86-9d3b-4316-b252-f84eda09fd80
vulnerability_definition:
type: object
properties:
id:
type: string
example: a0c96b86-9d3b-4316-b252-f84eda09fd80
name:
type: string
example: 'Clear-text Transmission via minima input'
description:
type: string
example: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
solution:
type: string
example: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
category:
type: string
example: 'Clear-text Transmission'
threat_level:
type: string
example: Critical
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a0c96b86-9bb3-431f-ba88-1dcb27df3ce9
o_id:
type: string
example: 78b59196-c94e-3781-9b13-f6c9b80235ae
name:
type: string
example: 'Clear-text Transmission via minima input'
family:
type: string
example: 'Clear-text Transmission'
reference_urls:
type: string
example: 'https://www.gaylord.net/veniam-quia-magni-aliquam-unde, http://www.senger.com/'
reference_cves:
type: string
example: 'CVE-2016-6879, CVE-2023-8400'
solution_type:
type: string
example: VendorFix
solution_description:
type: string
example: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
summary:
type: string
example: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
insight:
type: string
example: 'Voluptates et doloremque inventore tempore. Inventore aliquid unde repellendus architecto dolor. Rerum est atque dolorem laboriosam.'
affected:
type: string
example: 'Ea deleniti maiores soluta aut odio. Culpa consectetur commodi et asperiores delectus exercitationem. Qui magnam rerum ab repellat rerum. Minima voluptatum expedita eligendi autem qui.'
impact:
type: string
example: 'Repellat voluptas occaecati voluptatem tenetur. Aut eum non quam consequatur et quia. Quos error quos molestiae fugiat.'
vuldetect:
type: string
example: 'Occaecati beatae ad adipisci libero quia ut. Consequatur qui necessitatibus architecto sed eveniet commodi. Laudantium quisquam quos beatae doloribus maiores et. Reiciendis rerum ut sed ut.'
priority:
type: string
example: Low
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
cvss_base_score:
type: number
example: 7.8
cvss_base_vector:
type: string
example: 'AV:P/AC:L/Au:S/C:N/I:P/A:C'
epss:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
host:
type: string
example: 62.64.127.93
hostname:
type: string
example: hand.biz
port:
type: string
example: 22/tcp
details:
type: string
example: 'Vel est et eveniet inventore aliquid labore modi. Est est exercitationem veniam. Autem consequatur voluptates dignissimos illo consectetur aut. Est occaecati quis aut earum.'
status:
type: string
example: Expired
first_seen:
type: string
example: '2025-06-30T06:56:49.000000Z'
last_seen:
type: string
example: '2025-07-05T02:43:20.000000Z'
created_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.000000Z'
name:
type: string
example: 'Clear-text Transmission via minima input'
description:
type: string
example: 'Vel est et eveniet inventore aliquid labore modi. Est est exercitationem veniam. Autem consequatur voluptates dignissimos illo consectetur aut. Est occaecati quis aut earum.'
cvss_base_score:
type: number
example: 7.8
cvss_base_vector:
type: string
example: 'AV:P/AC:L/Au:S/C:N/I:P/A:C'
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
threat:
type: string
example: Critical
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: a0c96b86-9bb3-431f-ba88-1dcb27df3ce9
o_id:
type: string
example: 78b59196-c94e-3781-9b13-f6c9b80235ae
name:
type: string
example: 'Clear-text Transmission via minima input'
family:
type: string
example: 'Clear-text Transmission'
reference_urls:
type: string
example: 'https://www.gaylord.net/veniam-quia-magni-aliquam-unde, http://www.senger.com/'
reference_cves:
type: string
example: 'CVE-2016-6879, CVE-2023-8400'
solution_type:
type: string
example: VendorFix
solution_description:
type: string
example: 'Facilis aut et alias et ut quas. Ratione veritatis fugiat ex earum. Eos quia quis expedita libero esse molestiae. Vero error nihil ad rerum doloribus ratione.'
summary:
type: string
example: 'Qui repellat deleniti atque rerum et. Fuga eum et enim nulla. Iusto et nulla quisquam nihil velit. Beatae omnis et ullam enim corrupti.'
insight:
type: string
example: 'Voluptates et doloremque inventore tempore. Inventore aliquid unde repellendus architecto dolor. Rerum est atque dolorem laboriosam.'
affected:
type: string
example: 'Ea deleniti maiores soluta aut odio. Culpa consectetur commodi et asperiores delectus exercitationem. Qui magnam rerum ab repellat rerum. Minima voluptatum expedita eligendi autem qui.'
impact:
type: string
example: 'Repellat voluptas occaecati voluptatem tenetur. Aut eum non quam consequatur et quia. Quos error quos molestiae fugiat.'
vuldetect:
type: string
example: 'Occaecati beatae ad adipisci libero quia ut. Consequatur qui necessitatibus architecto sed eveniet commodi. Laudantium quisquam quos beatae doloribus maiores et. Reiciendis rerum ut sed ut.'
priority:
type: string
example: Low
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: cupiditate
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: status
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: status
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
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a0c96b85-8e01-4d1b-8fcf-45a094a1a320
webhook_id: a0c96b85-8d2c-4d2c-9dd3-56d46a65591e
event: qui
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
-
id: a0c96b86-47e2-4e17-834f-546c15f44f2c
webhook_id: a0c96b86-46f5-438e-b5e3-654d7f86ef48
event: perspiciatis
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.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: a0c96b85-8e01-4d1b-8fcf-45a094a1a320
webhook_id: a0c96b85-8d2c-4d2c-9dd3-56d46a65591e
event: qui
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
-
id: a0c96b86-47e2-4e17-834f-546c15f44f2c
webhook_id: a0c96b86-46f5-438e-b5e3-654d7f86ef48
event: perspiciatis
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b85-8e01-4d1b-8fcf-45a094a1a320
webhook_id:
type: string
example: a0c96b85-8d2c-4d2c-9dd3-56d46a65591e
event:
type: string
example: qui
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: '2026-01-08T10:52:07.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:07.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: a0c96b86-544b-4b39-b0f2-a3e41a009d11
webhook_id: a0c96b86-5393-4961-888d-11cea677b2d6
event: minus
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-01-08T10:52:08.000000Z'
updated_at: '2026-01-08T10:52:08.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b86-544b-4b39-b0f2-a3e41a009d11
webhook_id:
type: string
example: a0c96b86-5393-4961-888d-11cea677b2d6
event:
type: string
example: minus
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: '2026-01-08T10:52:08.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:08.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: a0c96b85-8e01-4d1b-8fcf-45a094a1a320
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: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
company_id: 99bbbae9-364f-4035-b0d4-6e29e5d71a1b
url: 'https://dubuque.org'
description: null
events: []
secret: faa9a87b7dd4bc25ad523ba06207d74bac8ebceeeea0248dc343e5e7e5a34104
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
-
id: a0c96b85-7437-487d-8ea7-b92870772f73
company_id: 14f8f5b4-5a56-46b9-ba8e-8c19b652b9e8
url: 'https://macejkovic.com'
description: null
events: []
secret: e184a276aae481c6319b45bb9cd01968a8c9685f9f07531c5d1dba9b0caae698
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
properties:
data:
type: array
example:
-
id: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
company_id: 99bbbae9-364f-4035-b0d4-6e29e5d71a1b
url: 'https://dubuque.org'
description: null
events: []
secret: faa9a87b7dd4bc25ad523ba06207d74bac8ebceeeea0248dc343e5e7e5a34104
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
-
id: a0c96b85-7437-487d-8ea7-b92870772f73
company_id: 14f8f5b4-5a56-46b9-ba8e-8c19b652b9e8
url: 'https://macejkovic.com'
description: null
events: []
secret: e184a276aae481c6319b45bb9cd01968a8c9685f9f07531c5d1dba9b0caae698
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
items:
type: object
properties:
id:
type: string
example: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
company_id:
type: string
example: 99bbbae9-364f-4035-b0d4-6e29e5d71a1b
url:
type: string
example: 'https://dubuque.org'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: faa9a87b7dd4bc25ad523ba06207d74bac8ebceeeea0248dc343e5e7e5a34104
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:07.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:07.000000Z'
tags:
- Webhooks
post:
summary: 'Create Webhook'
operationId: createWebhook
description: "Create a new webhook for the current company.\n"
parameters: []
responses:
201:
description: 'webhook created'
content:
application/json:
schema:
type: object
example:
data:
id: 00000000-0000-0000-0000-000000000000
properties:
data:
type: object
properties:
id:
type: string
example: 00000000-0000-0000-0000-000000000000
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'url is already used by company'
type: object
example:
message: 'The url has already been taken.'
properties:
message:
type: string
example: 'The url has already been taken.'
-
description: 'validation error'
type: object
example:
message: 'invalid url'
properties:
message:
type: string
example: 'invalid url'
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL. Must not be greater than 2048 characters.'
example: 'http://swift.com/'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Aliquam est quo tenetur dolorum.'
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: a0c96b85-7fb5-40d2-bfa9-03371456edf2
company_id: 23b72159-e6bd-475f-93eb-c2822b48ec94
url: 'https://schmeler.com'
description: null
events: []
secret: 1e89bb7814197c820ab536b2bb46d5882b5f75695fff06dda656182e4337c893
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b85-7fb5-40d2-bfa9-03371456edf2
company_id:
type: string
example: 23b72159-e6bd-475f-93eb-c2822b48ec94
url:
type: string
example: 'https://schmeler.com'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 1e89bb7814197c820ab536b2bb46d5882b5f75695fff06dda656182e4337c893
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:07.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:07.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://kassulke.org/provident-praesentium-vitae-qui-recusandae-sequi'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Sint natus explicabo sed.'
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: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
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: a0c96b85-840d-4058-aa4b-0f959f9533db
company_id: 87136a3a-e5e7-4210-98fd-90c1a15ad841
url: 'https://huels.org'
description: null
events: []
secret: f80e9d60ae882d4ad8ba4fa935caed7043a00de82177ad4d4ea89fab01463d76
last_sent_at: null
created_at: '2026-01-08T10:52:07.000000Z'
updated_at: '2026-01-08T10:52:07.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a0c96b85-840d-4058-aa4b-0f959f9533db
company_id:
type: string
example: 87136a3a-e5e7-4210-98fd-90c1a15ad841
url:
type: string
example: 'https://huels.org'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: f80e9d60ae882d4ad8ba4fa935caed7043a00de82177ad4d4ea89fab01463d76
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-01-08T10:52:07.000000Z'
updated_at:
type: string
example: '2026-01-08T10:52:07.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: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
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: a0c96b85-6ffe-44d9-9bde-cb6ffc888048
required: true
schema:
type: string