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: version
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: version
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: a1db2512-a7cc-4544-9511-574bd5bc07af
cpe: 'cpe:2.3:a:oracle:weblogic:*:*:*:*:*:*:*:*'
vendor: Oracle
product: WebLogic
version: 16.83.9957
update: hotfix1
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-a94b-4636-897b-93a345b5ba9e
cpe: 'cpe:2.3:a:oracle:solaris:*:*:*:*:*:*:*:*'
vendor: Oracle
product: Solaris
version: 9.84.2368
update: sp1
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.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: a1db2512-a7cc-4544-9511-574bd5bc07af
cpe: 'cpe:2.3:a:oracle:weblogic:*:*:*:*:*:*:*:*'
vendor: Oracle
product: WebLogic
version: 16.83.9957
update: hotfix1
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-a94b-4636-897b-93a345b5ba9e
cpe: 'cpe:2.3:a:oracle:solaris:*:*:*:*:*:*:*:*'
vendor: Oracle
product: Solaris
version: 9.84.2368
update: sp1
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2512-a7cc-4544-9511-574bd5bc07af
cpe:
type: string
example: 'cpe:2.3:a:oracle:weblogic:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Oracle
product:
type: string
example: WebLogic
version:
type: string
example: 16.83.9957
update:
type: string
example: hotfix1
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: version
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: version
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: a1db2512-ad83-4246-b250-7ac664084cbb
cpe: 'cpe:2.3:a:cisco:anyconnect:*:*:*:*:*:*:*:*'
vendor: Cisco
product: AnyConnect
version: 11.2.5019
update: update1
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-ad83-4246-b250-7ac664084cbb
cpe:
type: string
example: 'cpe:2.3:a:cisco:anyconnect:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Cisco
product:
type: string
example: AnyConnect
version:
type: string
example: 11.2.5019
update:
type: string
example: update1
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: amet
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: licensed
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: licensed
enum:
- name
- host
- last_seen
- licensed
-
in: query
name: include
description: ''
example: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a1db2512-610f-4382-bceb-7406b875fc70
company_id: '3503884'
name: 'Dr. Alisha Carter DDS'
identifier: 13.219.121.106
host: 13.219.121.106
mac_address: null
hostname: schultz.com
operating_system: quam
operating_system_name: sit
first_seen: '1992-07-02T23:19:03.000000Z'
last_seen: '2006-07-15T01:37:15.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-06-06T11:16:41.000000Z'
-
id: a1db2512-643a-4565-8fc5-76eeabc3364d
company_id: '769379'
name: 'Prof. Rubie Satterfield MD'
identifier: 'EF:E3:E1:85:76:20'
host: 146.177.229.253
mac_address: 'EF:E3:E1:85:76:20'
hostname: brakus.org
operating_system: beatae
operating_system_name: sunt
first_seen: '1980-02-29T05:13:56.000000Z'
last_seen: '2026-01-12T08:10:47.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-06-18T00:39:39.000000Z'
links:
first: '/?page=1'
last: '/?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
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: a1db2512-610f-4382-bceb-7406b875fc70
company_id: '3503884'
name: 'Dr. Alisha Carter DDS'
identifier: 13.219.121.106
host: 13.219.121.106
mac_address: null
hostname: schultz.com
operating_system: quam
operating_system_name: sit
first_seen: '1992-07-02T23:19:03.000000Z'
last_seen: '2006-07-15T01:37:15.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-06-06T11:16:41.000000Z'
-
id: a1db2512-643a-4565-8fc5-76eeabc3364d
company_id: '769379'
name: 'Prof. Rubie Satterfield MD'
identifier: 'EF:E3:E1:85:76:20'
host: 146.177.229.253
mac_address: 'EF:E3:E1:85:76:20'
hostname: brakus.org
operating_system: beatae
operating_system_name: sunt
first_seen: '1980-02-29T05:13:56.000000Z'
last_seen: '2026-01-12T08:10:47.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-06-18T00:39:39.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2512-610f-4382-bceb-7406b875fc70
company_id:
type: string
example: '3503884'
name:
type: string
example: 'Dr. Alisha Carter DDS'
identifier:
type: string
example: 13.219.121.106
host:
type: string
example: 13.219.121.106
mac_address:
type: string
example: null
nullable: true
hostname:
type: string
example: schultz.com
operating_system:
type: string
example: quam
operating_system_name:
type: string
example: sit
first_seen:
type: string
example: '1992-07-02T23:19:03.000000Z'
last_seen:
type: string
example: '2006-07-15T01:37:15.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
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-06-06T11:16:41.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: a1db2512-6d15-44e9-aea4-03056dbc7618
company_id: '5424660'
name: 'Mr. Holden Smitham'
identifier: 'AC:EA:F4:C0:BD:8E'
host: 196.107.201.45
mac_address: 'AC:EA:F4:C0:BD:8E'
hostname: gleason.com
operating_system: quia
operating_system_name: sed
first_seen: '1976-10-04T14:25:58.000000Z'
last_seen: '1987-02-17T21:23:59.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-06-18T13:55:36.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-6d15-44e9-aea4-03056dbc7618
company_id:
type: string
example: '5424660'
name:
type: string
example: 'Mr. Holden Smitham'
identifier:
type: string
example: 'AC:EA:F4:C0:BD:8E'
host:
type: string
example: 196.107.201.45
mac_address:
type: string
example: 'AC:EA:F4:C0:BD:8E'
hostname:
type: string
example: gleason.com
operating_system:
type: string
example: quia
operating_system_name:
type: string
example: sed
first_seen:
type: string
example: '1976-10-04T14:25:58.000000Z'
last_seen:
type: string
example: '1987-02-17T21:23:59.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
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2026-06-18T13:55: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: q
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: sed
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: assignLicense
enum:
- addTags
- removeTags
- delete
- assignLicense
- removeLicense
id:
type: string
description: ''
example: dolorem
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: a1db2512-71d2-42c4-95a1-e39e62e83e7c
company_id: '3203904'
name: 'Jules Kilback'
identifier: 'CE:6A:EF:12:AE:6F'
host: 227.11.98.186
mac_address: 'CE:6A:EF:12:AE:6F'
hostname: trantow.com
operating_system: voluptatum
operating_system_name: et
first_seen: '1972-04-28T17:16:05.000000Z'
last_seen: '1992-05-09T18:30:17.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-06-19T04:47:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-71d2-42c4-95a1-e39e62e83e7c
company_id:
type: string
example: '3203904'
name:
type: string
example: 'Jules Kilback'
identifier:
type: string
example: 'CE:6A:EF:12:AE:6F'
host:
type: string
example: 227.11.98.186
mac_address:
type: string
example: 'CE:6A:EF:12:AE:6F'
hostname:
type: string
example: trantow.com
operating_system:
type: string
example: voluptatum
operating_system_name:
type: string
example: et
first_seen:
type: string
example: '1972-04-28T17:16:05.000000Z'
last_seen:
type: string
example: '1992-05-09T18:30:17.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
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2026-06-19T04:47:05.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: a1db2512-7694-4eb9-abe7-e24bd2f149bb
company_id: '2734870'
name: 'Dortha Ziemann'
identifier: '7C:D6:FE:14:D8:1F'
host: 163.140.156.249
mac_address: '7C:D6:FE:14:D8:1F'
hostname: dach.com
operating_system: nihil
operating_system_name: velit
first_seen: '2012-12-19T21:51:35.000000Z'
last_seen: '1970-07-22T11:01:27.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2026-06-21T02:26:24.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-7694-4eb9-abe7-e24bd2f149bb
company_id:
type: string
example: '2734870'
name:
type: string
example: 'Dortha Ziemann'
identifier:
type: string
example: '7C:D6:FE:14:D8:1F'
host:
type: string
example: 163.140.156.249
mac_address:
type: string
example: '7C:D6:FE:14:D8:1F'
hostname:
type: string
example: dach.com
operating_system:
type: string
example: nihil
operating_system_name:
type: string
example: velit
first_seen:
type: string
example: '2012-12-19T21:51:35.000000Z'
last_seen:
type: string
example: '1970-07-22T11:01:27.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-06-21T02:26:24.000000Z'
422:
description: 'name field is empty'
content:
application/json:
schema:
type: object
example:
message: 'name is required'
properties:
message:
type: string
example: 'name is required'
tags:
- Assets
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: bvdrjmqy
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: voluptates
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: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a1db2512-7e69-46be-9521-0b5e6654e263
company_id: '9673683'
common_name: rowe.com
organization: null
organizational_unit: Group
locality: null
state: null
country: IQ
serial: 56FU6KHJBAOADOOJN856RNS6HIVC0MDR
not_valid_before: 20260328T214036Z
not_valid_after: 20260608T005356Z
value: "-----BEGIN CERTIFICATE-----\n65KbOivQ3g2SPh97lj1U9F3XIT6S9ffAocPje55FhakPIf2XA6vhXY90ON9o5qHO\n3MDuqJjPaR8oFLXHdt8g0IZ84vNSosKsi0jxT5ZG5LJNXoliz/S6Chr3/jfr5eXJ\nbLmztcEEXMErxhZiAHygpYdoerJKL0GRkDmcQae7calZIWQ7OsbDDmLwZilwmPdV\np2EXprysknaFBxxex0kelvJHqUksJJK+tqeLttb9LjYf5b753KssRvekyP0xgDe9\nVwMpJ6UGnDE6JHc/vmzoKBLEKQnrIpl9g+C7dWZhIgLC+gtfoWR1lG4sEmqqs0Fn\n2dPr2hqTtvlkIHJhDpgz61DaldXagEM5ij57XvcsvwtVJQLNkPoKAngILUGq2fUc\n3OGkPBmnZdCd8jQAmi+SvBlLHNZ59tII8Kl0okzYjrRz+LLrVZ8DHfzGywK1GSlA\nlcqnWe1DCT9k0aS8uYVq6BacORnvN+RWFvvoF2KACKZTQCOvig8z9qbtSVF5L8PN\nhlIa7A77YtguQLKenSRxbtk2p/V3Jyg1KNTZdOnsI4lURJe0xDZ0XK4Z2gg74o6+\nOiHH2Sih8ouc+6+sXdcqgZ9O206wAbsqR4gLDkrW5opYeQOxiXkf0UdNhc3ipT5K\nQYmJtZQAUjIUxEQYf0eh27AtoQ9pnYuwmWICs50wSuFwAJRTMynfCkbjR5h2Lgmo\nUx+Zs947e/ldERk/PVo3av8nYCmIP2Qxx3y8jiB2kCV9jXNlsQ2wNfthqam+vj9l\nWJ3Wkap+CQCJcVVHpJAqs5uNV6RREj3J+C0LsDEKi8k2dN70NyI0gTm2JuuUV6Ut\nRso/Elq+GtvhYTsq5Ukc9kZVYxS5fdEjAN8EWrh32CrS5P5kmdnvGmyFmv5gyuM2\nrhOhlObf8lNe3hKswbklg9daFmjPB/1qFNZsbuzISayX2O3AyBSushBeW33gUbc3\nsHQv2tOpIJbHj7q+5T/YoOZD1Glh0vrjtxEcoc5yiolN6JJxS43QpeqlrcHGDIwG\nIlrvLBSFD0vzlQeG94b6fYteKUN96JIMY9/WjqsS6coVLDIa5vJzA+fGwDH1NBFs\n4MXIAYOcboZNeIIifVIgMkmtv6FiuwePFHh0d0F0ANNw96BTPCACEV+eCjiUSeKL\nBkMU3nQ9Il6xqcAuxik3p9+9te/tBRQj2phR407sXyFxKHtkW/s912/wzyZBADE1\ntB3TFTZmLc2bCzK5Y0uzQ/6GBX4I/CxrIK+kXI5z+2it7VJZk0uEF9q3zlzga/r8\nkWCojwORASpB8mSc0NmGGLqyrD1uDuDwKtRIhlpvwrPBI9ODN6P8Y4X+879DiAg5\n7fi1Gtf2rmbVdIsrmRRFDA==\n\n-----END CERTIFICATE-----"
first_seen: '2026-04-02T22:48:24.000000Z'
last_seen: '2026-05-05T05:49:27.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-8156-4ec4-a815-2732e94a4bd6
company_id: '932056'
common_name: erdman.com
organization: 'Streich Inc'
organizational_unit: Inc
locality: null
state: Arizona
country: VG
serial: UHWGRYT4RSPE1EAVLH27DXAI51TE4XEY
not_valid_before: 20250223T060219Z
not_valid_after: 20270611T025652Z
value: "-----BEGIN CERTIFICATE-----\nemweCGUvbQZvzZfX6PFCSLUdMKKvV/QaaBTNrSJrDKzS95aPKg+8vqfhjy0ZjaU1\ntOcOs0Uu9ND77VTqDKkECaVEA1odgHGPfrBfm85n90WQYjgplq2zq0qdWxpmrS9W\nxmavvzrKZZCkDptqt1+YYGaD3Yin/KFL16R/oLAU1jpcNKXUzVgz6N9LhwDJ33WL\n6ju24UEhZ2Uc/zomUetw70IoTThcDqW+TTbngGtK5dU9O2SWUGcdW3LOd8iL5tPo\n5L9MUDCvO1Ac1xkbnvSK0OSPM3i7SM9RvPpJeK+WQ0ZzkxI048f0xTyctt3+8HyO\nGaEcG55fSO7FSuYi4GDx5hWGiq4AH0csftasRH+cxNP2demAaZ/5iHccufuSetPJ\nes3zKCLYrAJGvrPfMmSmaU0jN0Z4aAunk1OL2syvL0nxVXF4Oq4wypoeI0f6m7/n\nF1352CqgRWUSAHI7ATHU+9kNmvFrin8w/9yWvsDhDML/JMph1SETExJlqWUO6Iyv\nv9by4l2t7MD+Kg+TkhRIUqSDcEMLNrUoObvqT93b3PCHfcBn4kqQ1FFmUcgVZSCV\nktjKZ0Hh9fF/vl8hAckmJ/KD75AiH9otrSQBTAKfnTb+K8ACw4tgMU301Up1ISI4\n30Pg+EsqdI87w8A8is8qYUJhpU3YYno1JzTkbfd6HARzAQrCXBp/Dg/SxPxuzZg7\nAM2uF+WiXRFx5lwfOoGfqfC099Nypq/XMbUq3kmAQRBmWY/KQGSc3dwQiX9CGWHR\nAiB6iqF8eUU5w0/OpmuivRp3MPrwQkDjmOTP4K4vMuPoLQXYa2mXdbGr2JA4vxqB\nCVN/89Mh037+rQ+IN3BygCMffJ1r8Ikgqs3eeVDxVBZQcsN3zf4kncnlFu/K9Shf\n/5HyQtuPff57Z5cjhHC1OZnkuu4CcFOW7S/wIVR7yWI5KYTKi88NYp3nQ6vj4dJw\nymFhr5Uw1GLRfIFYKLe6nqpfZt3zePNKArOzRewhmM4l4YZei0ZM9rzAj8XIWAnA\nTHJbIf+LPKUf/QetBvUA6ski9FB3/IA8pZgyPb7x6vgqbLkqSGlXlr556YEvRUbS\ntS91ntQpMCaOjKZv1U8ogUz+Jbo2qaOI73P9T3unpPMGiaSeXPvSe6023F6LnSZI\nOEwkxA2cwjnJsfLg17BCQxjcdyP8LIbPyAwemC+0yawa8uL18uBmhHmTm6rBu5QE\nPGMbeJkspNSRkjmUen5CO560cH+H8Ca3GGzgHpVqEcRQC31d8vN4zDqJ4ILh4Pmy\n5mI/wplN45Gkh4V/u7DL6OhcUU2OlGWh+Vqcv7K/UV7HK9MFhUZ9aXcEt7ww3ceD\nCmpS879Ewf1M5hXLMEbG5w==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-13T07:13:24.000000Z'
last_seen: '2025-07-20T09:53:48.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.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: a1db2512-7e69-46be-9521-0b5e6654e263
company_id: '9673683'
common_name: rowe.com
organization: null
organizational_unit: Group
locality: null
state: null
country: IQ
serial: 56FU6KHJBAOADOOJN856RNS6HIVC0MDR
not_valid_before: 20260328T214036Z
not_valid_after: 20260608T005356Z
value: "-----BEGIN CERTIFICATE-----\n65KbOivQ3g2SPh97lj1U9F3XIT6S9ffAocPje55FhakPIf2XA6vhXY90ON9o5qHO\n3MDuqJjPaR8oFLXHdt8g0IZ84vNSosKsi0jxT5ZG5LJNXoliz/S6Chr3/jfr5eXJ\nbLmztcEEXMErxhZiAHygpYdoerJKL0GRkDmcQae7calZIWQ7OsbDDmLwZilwmPdV\np2EXprysknaFBxxex0kelvJHqUksJJK+tqeLttb9LjYf5b753KssRvekyP0xgDe9\nVwMpJ6UGnDE6JHc/vmzoKBLEKQnrIpl9g+C7dWZhIgLC+gtfoWR1lG4sEmqqs0Fn\n2dPr2hqTtvlkIHJhDpgz61DaldXagEM5ij57XvcsvwtVJQLNkPoKAngILUGq2fUc\n3OGkPBmnZdCd8jQAmi+SvBlLHNZ59tII8Kl0okzYjrRz+LLrVZ8DHfzGywK1GSlA\nlcqnWe1DCT9k0aS8uYVq6BacORnvN+RWFvvoF2KACKZTQCOvig8z9qbtSVF5L8PN\nhlIa7A77YtguQLKenSRxbtk2p/V3Jyg1KNTZdOnsI4lURJe0xDZ0XK4Z2gg74o6+\nOiHH2Sih8ouc+6+sXdcqgZ9O206wAbsqR4gLDkrW5opYeQOxiXkf0UdNhc3ipT5K\nQYmJtZQAUjIUxEQYf0eh27AtoQ9pnYuwmWICs50wSuFwAJRTMynfCkbjR5h2Lgmo\nUx+Zs947e/ldERk/PVo3av8nYCmIP2Qxx3y8jiB2kCV9jXNlsQ2wNfthqam+vj9l\nWJ3Wkap+CQCJcVVHpJAqs5uNV6RREj3J+C0LsDEKi8k2dN70NyI0gTm2JuuUV6Ut\nRso/Elq+GtvhYTsq5Ukc9kZVYxS5fdEjAN8EWrh32CrS5P5kmdnvGmyFmv5gyuM2\nrhOhlObf8lNe3hKswbklg9daFmjPB/1qFNZsbuzISayX2O3AyBSushBeW33gUbc3\nsHQv2tOpIJbHj7q+5T/YoOZD1Glh0vrjtxEcoc5yiolN6JJxS43QpeqlrcHGDIwG\nIlrvLBSFD0vzlQeG94b6fYteKUN96JIMY9/WjqsS6coVLDIa5vJzA+fGwDH1NBFs\n4MXIAYOcboZNeIIifVIgMkmtv6FiuwePFHh0d0F0ANNw96BTPCACEV+eCjiUSeKL\nBkMU3nQ9Il6xqcAuxik3p9+9te/tBRQj2phR407sXyFxKHtkW/s912/wzyZBADE1\ntB3TFTZmLc2bCzK5Y0uzQ/6GBX4I/CxrIK+kXI5z+2it7VJZk0uEF9q3zlzga/r8\nkWCojwORASpB8mSc0NmGGLqyrD1uDuDwKtRIhlpvwrPBI9ODN6P8Y4X+879DiAg5\n7fi1Gtf2rmbVdIsrmRRFDA==\n\n-----END CERTIFICATE-----"
first_seen: '2026-04-02T22:48:24.000000Z'
last_seen: '2026-05-05T05:49:27.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-8156-4ec4-a815-2732e94a4bd6
company_id: '932056'
common_name: erdman.com
organization: 'Streich Inc'
organizational_unit: Inc
locality: null
state: Arizona
country: VG
serial: UHWGRYT4RSPE1EAVLH27DXAI51TE4XEY
not_valid_before: 20250223T060219Z
not_valid_after: 20270611T025652Z
value: "-----BEGIN CERTIFICATE-----\nemweCGUvbQZvzZfX6PFCSLUdMKKvV/QaaBTNrSJrDKzS95aPKg+8vqfhjy0ZjaU1\ntOcOs0Uu9ND77VTqDKkECaVEA1odgHGPfrBfm85n90WQYjgplq2zq0qdWxpmrS9W\nxmavvzrKZZCkDptqt1+YYGaD3Yin/KFL16R/oLAU1jpcNKXUzVgz6N9LhwDJ33WL\n6ju24UEhZ2Uc/zomUetw70IoTThcDqW+TTbngGtK5dU9O2SWUGcdW3LOd8iL5tPo\n5L9MUDCvO1Ac1xkbnvSK0OSPM3i7SM9RvPpJeK+WQ0ZzkxI048f0xTyctt3+8HyO\nGaEcG55fSO7FSuYi4GDx5hWGiq4AH0csftasRH+cxNP2demAaZ/5iHccufuSetPJ\nes3zKCLYrAJGvrPfMmSmaU0jN0Z4aAunk1OL2syvL0nxVXF4Oq4wypoeI0f6m7/n\nF1352CqgRWUSAHI7ATHU+9kNmvFrin8w/9yWvsDhDML/JMph1SETExJlqWUO6Iyv\nv9by4l2t7MD+Kg+TkhRIUqSDcEMLNrUoObvqT93b3PCHfcBn4kqQ1FFmUcgVZSCV\nktjKZ0Hh9fF/vl8hAckmJ/KD75AiH9otrSQBTAKfnTb+K8ACw4tgMU301Up1ISI4\n30Pg+EsqdI87w8A8is8qYUJhpU3YYno1JzTkbfd6HARzAQrCXBp/Dg/SxPxuzZg7\nAM2uF+WiXRFx5lwfOoGfqfC099Nypq/XMbUq3kmAQRBmWY/KQGSc3dwQiX9CGWHR\nAiB6iqF8eUU5w0/OpmuivRp3MPrwQkDjmOTP4K4vMuPoLQXYa2mXdbGr2JA4vxqB\nCVN/89Mh037+rQ+IN3BygCMffJ1r8Ikgqs3eeVDxVBZQcsN3zf4kncnlFu/K9Shf\n/5HyQtuPff57Z5cjhHC1OZnkuu4CcFOW7S/wIVR7yWI5KYTKi88NYp3nQ6vj4dJw\nymFhr5Uw1GLRfIFYKLe6nqpfZt3zePNKArOzRewhmM4l4YZei0ZM9rzAj8XIWAnA\nTHJbIf+LPKUf/QetBvUA6ski9FB3/IA8pZgyPb7x6vgqbLkqSGlXlr556YEvRUbS\ntS91ntQpMCaOjKZv1U8ogUz+Jbo2qaOI73P9T3unpPMGiaSeXPvSe6023F6LnSZI\nOEwkxA2cwjnJsfLg17BCQxjcdyP8LIbPyAwemC+0yawa8uL18uBmhHmTm6rBu5QE\nPGMbeJkspNSRkjmUen5CO560cH+H8Ca3GGzgHpVqEcRQC31d8vN4zDqJ4ILh4Pmy\n5mI/wplN45Gkh4V/u7DL6OhcUU2OlGWh+Vqcv7K/UV7HK9MFhUZ9aXcEt7ww3ceD\nCmpS879Ewf1M5hXLMEbG5w==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-13T07:13:24.000000Z'
last_seen: '2025-07-20T09:53:48.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2512-7e69-46be-9521-0b5e6654e263
company_id:
type: string
example: '9673683'
common_name:
type: string
example: rowe.com
organization:
type: string
example: null
nullable: true
organizational_unit:
type: string
example: Group
locality:
type: string
example: null
nullable: true
state:
type: string
example: null
nullable: true
country:
type: string
example: IQ
serial:
type: string
example: 56FU6KHJBAOADOOJN856RNS6HIVC0MDR
not_valid_before:
type: string
example: 20260328T214036Z
not_valid_after:
type: string
example: 20260608T005356Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\n65KbOivQ3g2SPh97lj1U9F3XIT6S9ffAocPje55FhakPIf2XA6vhXY90ON9o5qHO\n3MDuqJjPaR8oFLXHdt8g0IZ84vNSosKsi0jxT5ZG5LJNXoliz/S6Chr3/jfr5eXJ\nbLmztcEEXMErxhZiAHygpYdoerJKL0GRkDmcQae7calZIWQ7OsbDDmLwZilwmPdV\np2EXprysknaFBxxex0kelvJHqUksJJK+tqeLttb9LjYf5b753KssRvekyP0xgDe9\nVwMpJ6UGnDE6JHc/vmzoKBLEKQnrIpl9g+C7dWZhIgLC+gtfoWR1lG4sEmqqs0Fn\n2dPr2hqTtvlkIHJhDpgz61DaldXagEM5ij57XvcsvwtVJQLNkPoKAngILUGq2fUc\n3OGkPBmnZdCd8jQAmi+SvBlLHNZ59tII8Kl0okzYjrRz+LLrVZ8DHfzGywK1GSlA\nlcqnWe1DCT9k0aS8uYVq6BacORnvN+RWFvvoF2KACKZTQCOvig8z9qbtSVF5L8PN\nhlIa7A77YtguQLKenSRxbtk2p/V3Jyg1KNTZdOnsI4lURJe0xDZ0XK4Z2gg74o6+\nOiHH2Sih8ouc+6+sXdcqgZ9O206wAbsqR4gLDkrW5opYeQOxiXkf0UdNhc3ipT5K\nQYmJtZQAUjIUxEQYf0eh27AtoQ9pnYuwmWICs50wSuFwAJRTMynfCkbjR5h2Lgmo\nUx+Zs947e/ldERk/PVo3av8nYCmIP2Qxx3y8jiB2kCV9jXNlsQ2wNfthqam+vj9l\nWJ3Wkap+CQCJcVVHpJAqs5uNV6RREj3J+C0LsDEKi8k2dN70NyI0gTm2JuuUV6Ut\nRso/Elq+GtvhYTsq5Ukc9kZVYxS5fdEjAN8EWrh32CrS5P5kmdnvGmyFmv5gyuM2\nrhOhlObf8lNe3hKswbklg9daFmjPB/1qFNZsbuzISayX2O3AyBSushBeW33gUbc3\nsHQv2tOpIJbHj7q+5T/YoOZD1Glh0vrjtxEcoc5yiolN6JJxS43QpeqlrcHGDIwG\nIlrvLBSFD0vzlQeG94b6fYteKUN96JIMY9/WjqsS6coVLDIa5vJzA+fGwDH1NBFs\n4MXIAYOcboZNeIIifVIgMkmtv6FiuwePFHh0d0F0ANNw96BTPCACEV+eCjiUSeKL\nBkMU3nQ9Il6xqcAuxik3p9+9te/tBRQj2phR407sXyFxKHtkW/s912/wzyZBADE1\ntB3TFTZmLc2bCzK5Y0uzQ/6GBX4I/CxrIK+kXI5z+2it7VJZk0uEF9q3zlzga/r8\nkWCojwORASpB8mSc0NmGGLqyrD1uDuDwKtRIhlpvwrPBI9ODN6P8Y4X+879DiAg5\n7fi1Gtf2rmbVdIsrmRRFDA==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2026-04-02T22:48:24.000000Z'
last_seen:
type: string
example: '2026-05-05T05:49:27.000000Z'
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Certificates
/v1/certificates/export:
get:
summary: 'Export certificates.'
operationId: exportCertificates
description: " Export all certificates for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: xlsx
required: true
schema:
type: 'The type of export to generate'
description: ''
example: xlsx
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: common_name
required: false
schema:
type: 'The column(s) to filter by. Eg filter=common_name:test.nl'
description: ''
example: common_name
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: tags
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: tags
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: 'Successfully retrieved certificate'
content:
application/json:
schema:
type: object
example:
data:
id: a1db2512-87f9-4d32-8012-c41415bdae9f
company_id: '4521759'
common_name: skiles.com
organization: 'Dickens Ltd'
organizational_unit: null
locality: null
state: 'New York'
country: AF
serial: 4QH8LT42AAJRXDLJJYFA1Y4UCOMV1WHG
not_valid_before: 20251104T015202Z
not_valid_after: 20261228T205401Z
value: "-----BEGIN CERTIFICATE-----\nfvJFcMOvrP3vq9qv6JI4j1/jJcvVyNEJavpfyWcGHkethgLxe5tz2eflRJ7ehY06\nztfsQfOs96c2W5dcsfUfgkuLMC3rTY8jEmW73JYILXh+7lq7bikrDg7dpwzEjGzv\noB+rPZ22CCn0mgeDIG1zt7QC+wKULq9CZs2UIvetikg1dufaKLjpU3ljfhQ1ombE\nnv49cdVP+gQWAP9X0+Xo9KjYmfgb5wxw5NrIl+imhNPnkEl68wc4L+a/dv5aEJae\nQ2/nJU20/7NyjvCneImgice6ut96vliRunJ9rWNCBLzPbYKqGHPsqYp0ZWhOqOJX\n9fej+Pmses/fHvRqexxfhbpCg5IANIrNcpiL405FY+JbAvk4XBRprIMN5fwQOjHw\n0JknRQUj3w9m7WNXZo0R379+A2TwJy0vnzDWraOuvLJXKkhHwlcjRP+xxYWBQw2k\ndZUIoxj1CLaGGuA8K6Z3UQKmD6mFooc5NB9oziWE6ktm3lriph6qJfzu99g7x05X\nJSVkgmbdIj6txs19Ie17epWoQRbxOXLYfPpillQsEM8MoR04NtqQVzZHRwtxe7dI\nAZmqy/D+SwAIT2rPNoN6LRsaQWO3tTsdRJV3BV24Yxb0wEwHBD7aVTWtsteecux+\nstGQHvTW7XSKEyMT7VjK/+3A21tGq3kpwxosy9vy0hpIjUZ7RWJf5KI40LhYqJvS\n5Eae1yU3OdvsK61dT93Synxeba2zsFHidXeCkymoRCRhLowe3pkwk48/X9Zi6/Rk\nZlgrLAAX2LG0vChL1fThrDJhyLCvfKaS3mBvi+09RYdkQNIT9rmBflX7IFkvNU8g\nEhejcXuoM7Kp7VPDeSmcy5dl/y3UJtXgppRArpxBuC3w/hwb4b7BaNph7ThY43ad\nvUerIWi8BNfeq0U2r5ZyzqQjU7oGjqEyfS0q3iaXBfCIb4Dsu2OPqlcil4NFyOjr\nY/iCmclt0tMnBDXFJBDY4gturmsrj/o37JM+NIxXXCZeABY8IIxb/C5F9k3S762s\nV4BNuHfPRjVgJ6PYU07srVoU1b2MuffZ9blX2G6srT7RfcifRc79Z0zd2NWDfxFu\nhNVGwFTzU0wwx3M1naQONmmPIy7cycceQQY/8tkOVsR/CUOITvqT8BXIOAJ7H/ly\n+fZykojIyaXkrESg/xOEgNNRRSd0T7B4GINJ0zJnubCQYYVnfLjPkx71Z6br474v\nqySHNzYzKmwfKjc1sVRBYAuBiXZo+lSHDH76jyRdra1fBYm+BwRf1hlhmIlDY2Y4\nP8r4+G9ta9FLnyzrvCE9cUXJZe8sDanSEuBlurCTk1fEqZv5wB96t3zghi3qIAlg\n2RkzNga2uQ9l9GDuoD8q5Q==\n\n-----END CERTIFICATE-----"
first_seen: '2025-12-18T12:33:02.000000Z'
last_seen: '2026-05-06T21:30:11.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-87f9-4d32-8012-c41415bdae9f
company_id:
type: string
example: '4521759'
common_name:
type: string
example: skiles.com
organization:
type: string
example: 'Dickens Ltd'
organizational_unit:
type: string
example: null
nullable: true
locality:
type: string
example: null
nullable: true
state:
type: string
example: 'New York'
country:
type: string
example: AF
serial:
type: string
example: 4QH8LT42AAJRXDLJJYFA1Y4UCOMV1WHG
not_valid_before:
type: string
example: 20251104T015202Z
not_valid_after:
type: string
example: 20261228T205401Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nfvJFcMOvrP3vq9qv6JI4j1/jJcvVyNEJavpfyWcGHkethgLxe5tz2eflRJ7ehY06\nztfsQfOs96c2W5dcsfUfgkuLMC3rTY8jEmW73JYILXh+7lq7bikrDg7dpwzEjGzv\noB+rPZ22CCn0mgeDIG1zt7QC+wKULq9CZs2UIvetikg1dufaKLjpU3ljfhQ1ombE\nnv49cdVP+gQWAP9X0+Xo9KjYmfgb5wxw5NrIl+imhNPnkEl68wc4L+a/dv5aEJae\nQ2/nJU20/7NyjvCneImgice6ut96vliRunJ9rWNCBLzPbYKqGHPsqYp0ZWhOqOJX\n9fej+Pmses/fHvRqexxfhbpCg5IANIrNcpiL405FY+JbAvk4XBRprIMN5fwQOjHw\n0JknRQUj3w9m7WNXZo0R379+A2TwJy0vnzDWraOuvLJXKkhHwlcjRP+xxYWBQw2k\ndZUIoxj1CLaGGuA8K6Z3UQKmD6mFooc5NB9oziWE6ktm3lriph6qJfzu99g7x05X\nJSVkgmbdIj6txs19Ie17epWoQRbxOXLYfPpillQsEM8MoR04NtqQVzZHRwtxe7dI\nAZmqy/D+SwAIT2rPNoN6LRsaQWO3tTsdRJV3BV24Yxb0wEwHBD7aVTWtsteecux+\nstGQHvTW7XSKEyMT7VjK/+3A21tGq3kpwxosy9vy0hpIjUZ7RWJf5KI40LhYqJvS\n5Eae1yU3OdvsK61dT93Synxeba2zsFHidXeCkymoRCRhLowe3pkwk48/X9Zi6/Rk\nZlgrLAAX2LG0vChL1fThrDJhyLCvfKaS3mBvi+09RYdkQNIT9rmBflX7IFkvNU8g\nEhejcXuoM7Kp7VPDeSmcy5dl/y3UJtXgppRArpxBuC3w/hwb4b7BaNph7ThY43ad\nvUerIWi8BNfeq0U2r5ZyzqQjU7oGjqEyfS0q3iaXBfCIb4Dsu2OPqlcil4NFyOjr\nY/iCmclt0tMnBDXFJBDY4gturmsrj/o37JM+NIxXXCZeABY8IIxb/C5F9k3S762s\nV4BNuHfPRjVgJ6PYU07srVoU1b2MuffZ9blX2G6srT7RfcifRc79Z0zd2NWDfxFu\nhNVGwFTzU0wwx3M1naQONmmPIy7cycceQQY/8tkOVsR/CUOITvqT8BXIOAJ7H/ly\n+fZykojIyaXkrESg/xOEgNNRRSd0T7B4GINJ0zJnubCQYYVnfLjPkx71Z6br474v\nqySHNzYzKmwfKjc1sVRBYAuBiXZo+lSHDH76jyRdra1fBYm+BwRf1hlhmIlDY2Y4\nP8r4+G9ta9FLnyzrvCE9cUXJZe8sDanSEuBlurCTk1fEqZv5wB96t3zghi3qIAlg\n2RkzNga2uQ9l9GDuoD8q5Q==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2025-12-18T12:33:02.000000Z'
last_seen:
type: string
example: '2026-05-06T21:30:11.000000Z'
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: nisi
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: Portscan
required: false
schema:
type: string
description: 'Filter by sensor type'
example: Portscan
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: a1db2512-1bc4-4773-a522-ad4cfe93a015
company_id: ba9bfb8a-8f7b-42b1-ab13-8e8986c2e402
src_ip: 236.134.59.10
dst_ip: 34.133.135.3
sensor: Modbus
timestamp: '2025-01-06T00:46:06.000000Z'
marked_as_seen: false
honeypot_id: d8243cc5-98e5-4e94-9061-c40544e50fe4
honeypot_alias: Honeypot-Office-27
src_port: null
src_hostname: null
src_mac: null
dst_port: 47727
-
id: a1db2512-2294-4aa4-aef7-d473c362a293
company_id: 5d959ecc-b0b2-45d9-8c43-0673ef184335
src_ip: 164.85.66.21
dst_ip: 76.37.34.251
sensor: Modbus
timestamp: '2024-11-08T12:10:06.000000Z'
marked_as_seen: true
honeypot_id: cc4a962c-6268-483d-8b4f-3f85193a99b9
honeypot_alias: Honeypot-Office-19
src_port: null
src_hostname: null
src_mac: '89:C6:F4:95:EA:E3'
dst_port: 29350
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: a1db2512-1bc4-4773-a522-ad4cfe93a015
company_id: ba9bfb8a-8f7b-42b1-ab13-8e8986c2e402
src_ip: 236.134.59.10
dst_ip: 34.133.135.3
sensor: Modbus
timestamp: '2025-01-06T00:46:06.000000Z'
marked_as_seen: false
honeypot_id: d8243cc5-98e5-4e94-9061-c40544e50fe4
honeypot_alias: Honeypot-Office-27
src_port: null
src_hostname: null
src_mac: null
dst_port: 47727
-
id: a1db2512-2294-4aa4-aef7-d473c362a293
company_id: 5d959ecc-b0b2-45d9-8c43-0673ef184335
src_ip: 164.85.66.21
dst_ip: 76.37.34.251
sensor: Modbus
timestamp: '2024-11-08T12:10:06.000000Z'
marked_as_seen: true
honeypot_id: cc4a962c-6268-483d-8b4f-3f85193a99b9
honeypot_alias: Honeypot-Office-19
src_port: null
src_hostname: null
src_mac: '89:C6:F4:95:EA:E3'
dst_port: 29350
items:
type: object
properties:
id:
type: string
example: a1db2512-1bc4-4773-a522-ad4cfe93a015
description: 'The unique identifier (UUID) of the detection'
company_id:
type: string
example: ba9bfb8a-8f7b-42b1-ab13-8e8986c2e402
description: 'The company UUID this detection belongs to'
src_ip:
type: string
example: 236.134.59.10
description: 'Source IP address of the attacker'
dst_ip:
type: string
example: 34.133.135.3
description: 'Destination IP address (honeypot)'
sensor:
type: string
example: Modbus
description: 'The sensor type that triggered the detection'
enum:
- SSH
- MSSQL
- Blackhole
- MySQL
- SMB
- FTP
- UPnP
- HTTP
- Ping
- Portscan
- Modbus
timestamp:
type: string
example: '2025-01-06T00:46:06.000000Z'
description: 'When the detection occurred'
marked_as_seen:
type: boolean
example: false
description: 'Whether the detection has been marked as seen'
honeypot_id:
type: string
example: d8243cc5-98e5-4e94-9061-c40544e50fe4
description: 'The honeypot UUID that captured this detection'
nullable: true
honeypot_alias:
type: string
example: Honeypot-Office-27
description: 'The alias of the honeypot'
nullable: true
src_port:
type: string
example: null
description: 'Source port number'
nullable: true
src_hostname:
type: string
example: null
description: 'Reverse DNS hostname of source IP'
nullable: true
src_mac:
type: string
example: null
description: 'Source MAC address'
nullable: true
dst_port:
type: integer
example: 47727
description: 'Destination port number'
nullable: true
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
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: bruuvwhrunln
sensor:
type: string
description: ''
example: MySQL
enum:
- SSH
- MSSQL
- Blackhole
- MySQL
- SMB
- FTP
- UPnP
- HTTP
- Ping
- Portscan
- Modbus
honeypot_id:
type: string
description: 'Must be a valid UUID.'
example: 99bf4c53-963d-3d83-b2bc-be1de8e1e4a9
honeypot_alias:
type: string
description: 'Must not be greater than 255 characters.'
example: nhhroxtevdi
src_ip:
type: string
description: 'Must not be greater than 255 characters.'
example: hjvxfqanxccykzimcltujvxo
src_hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: zcfqeycopwxszuwgfuppzwmhe
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: 82
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 20.'
example: 15
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: a1db2512-1bc4-4773-a522-ad4cfe93a015
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: suscipit
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: 78d84b32-d6f1-46ee-8569-b2ea147ab125
alias: Honeypot-Branch-82
status: 5
activation_status: 1
hostname: honeypot-ipol-120.example.com
slane_enabled: true
slane_connected: false
paired: true
provisioned: true
dns1: 60.155.129.230
dns2: 187.250.232.210
configured_as: null
notes: null
checked_at: '2026-02-26T23:57:09.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 78d84b32-d6f1-46ee-8569-b2ea147ab125
description: 'The id (uuid) of the Honeypot'
alias:
type: string
example: Honeypot-Branch-82
description: 'The alias used to identify the Honeypot'
status:
type: integer
example: 5
description: 'The status of the Honeypot (0 = Offline, 1 = Online, 5 = Rebooting, 6 = Testing)'
enum:
- 0
- 1
- 5
- 6
activation_status:
type: integer
example: 1
description: 'Whether the Honeypot has been activated'
hostname:
type: string
example: honeypot-ipol-120.example.com
description: 'The hostname of the Honeypot'
slane_enabled:
type: boolean
example: true
description: 'Whether SLANE is enabled on the Honeypot'
nullable: true
slane_connected:
type: boolean
example: false
description: 'Whether the Honeypot is connected using SLANE'
nullable: true
paired:
type: boolean
example: true
description: 'Whether the Honeypot is successfully paired with your environment'
provisioned:
type: boolean
example: true
description: 'Whether the Honeypot is provisioned'
dns1:
type: string
example: 60.155.129.230
description: 'The primary DNS server'
dns2:
type: string
example: 187.250.232.210
description: 'The primary DNS server'
configured_as:
type: string
example: null
description: 'The identity that the Honeypot is configured as'
nullable: true
notes:
type: string
example: null
description: 'Internal notes'
nullable: true
checked_at:
type: string
example: '2026-02-26T23:57:09.000000Z'
description: 'When the Honeypot last connected to your environment'
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
description: 'When the Honeypot was created'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
description: 'When the Honeypot was last updated'
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: company.type
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: company.type
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: b7f41a10-fb33-4832-a8ce-87392eeb950c
company_id: '5978728'
managing_company_id: '5978728'
first_name: Frederic
last_name: Lang
two_factor_enabled: false
two_factor_configured: false
email: vgerlach@hotmail.com
email_verified_at: '2026-05-24T12:31:57Z'
phonenumber: 1-803-863-9546
phonenumber_verified_at: '2026-05-24T12:31:57Z'
report_interval: weekly
manageable_companies:
-
id: '5978728'
uuid: 1d6f98d8-bcf0-4eb5-8d5f-3c62b113c22d
name: 'Bailey, Lakin and Willms'
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2026-05-24T12:31:57Z'
sso_provider: null
created_at: '2026-05-24T12:31:57Z'
updated_at: '2026-05-24T12:31:58Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: b7f41a10-fb33-4832-a8ce-87392eeb950c
company_id:
type: string
example: '5978728'
managing_company_id:
type: string
example: '5978728'
first_name:
type: string
example: Frederic
last_name:
type: string
example: Lang
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: vgerlach@hotmail.com
email_verified_at:
type: string
example: '2026-05-24T12:31:57Z'
phonenumber:
type: string
example: 1-803-863-9546
phonenumber_verified_at:
type: string
example: '2026-05-24T12:31:57Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '5978728'
uuid: 1d6f98d8-bcf0-4eb5-8d5f-3c62b113c22d
name: 'Bailey, Lakin and Willms'
items:
type: object
properties:
id:
type: string
example: '5978728'
uuid:
type: string
example: 1d6f98d8-bcf0-4eb5-8d5f-3c62b113c22d
name:
type: string
example: 'Bailey, Lakin and Willms'
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-05-24T12:31:57Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:57Z'
updated_at:
type: string
example: '2026-05-24T12:31:58Z'
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-05-24T12:31:58'
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: id
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: id
-
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: a1db2512-8fb1-436a-9b91-830f559bac55
company_id: '4954366'
name: 61eb6efa-4824-3ea6-abd8-06dc79fcb407
description: 'Atque fugiat id animi qui est. Laboriosam animi dicta tempore reprehenderit ipsum cupiditate. Nobis fuga repudiandae qui veritatis et et nemo. Dolor dolorum autem dolorum rem quibusdam voluptas.'
business_impact: high
system_tag: false
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-9282-4916-9e5b-cb0638948711
company_id: '5981906'
name: 46a2d532-9c5e-3794-9baf-943f0c81e30b
description: 'Quo ipsa omnis et et numquam. Nihil suscipit vero quia repellat inventore molestiae quo. Voluptas quaerat nobis praesentium dolorem quam eum incidunt. Consequatur quaerat corporis id numquam qui.'
business_impact: medium
system_tag: true
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.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: a1db2512-8fb1-436a-9b91-830f559bac55
company_id: '4954366'
name: 61eb6efa-4824-3ea6-abd8-06dc79fcb407
description: 'Atque fugiat id animi qui est. Laboriosam animi dicta tempore reprehenderit ipsum cupiditate. Nobis fuga repudiandae qui veritatis et et nemo. Dolor dolorum autem dolorum rem quibusdam voluptas.'
business_impact: high
system_tag: false
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2512-9282-4916-9e5b-cb0638948711
company_id: '5981906'
name: 46a2d532-9c5e-3794-9baf-943f0c81e30b
description: 'Quo ipsa omnis et et numquam. Nihil suscipit vero quia repellat inventore molestiae quo. Voluptas quaerat nobis praesentium dolorem quam eum incidunt. Consequatur quaerat corporis id numquam qui.'
business_impact: medium
system_tag: true
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2512-8fb1-436a-9b91-830f559bac55
company_id:
type: string
example: '4954366'
name:
type: string
example: 61eb6efa-4824-3ea6-abd8-06dc79fcb407
description:
type: string
example: 'Atque fugiat id animi qui est. Laboriosam animi dicta tempore reprehenderit ipsum cupiditate. Nobis fuga repudiandae qui veritatis et et nemo. Dolor dolorum autem dolorum rem quibusdam voluptas.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: a1db2512-97c8-4c7d-85f6-cc013ec883e3
company_id: '6793132'
name: 2f21a88a-9e32-3218-a8c2-1f3245436321
description: 'Quisquam aliquam voluptatem quae odio iste. Molestiae similique et odio suscipit voluptatem. Sed sequi dolores eos est ut ipsa.'
business_impact: critical
system_tag: true
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-97c8-4c7d-85f6-cc013ec883e3
company_id:
type: string
example: '6793132'
name:
type: string
example: 2f21a88a-9e32-3218-a8c2-1f3245436321
description:
type: string
example: 'Quisquam aliquam voluptatem quae odio iste. Molestiae similique et odio suscipit voluptatem. Sed sequi dolores eos est ut ipsa.'
business_impact:
type: string
example: critical
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: ookfuoxbxpsuu
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Quia et animi atque amet velit qui.'
business_impact:
type: string
description: ''
example: low
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: a1db2512-9c0d-4037-bbca-254923a10a8a
company_id: '3156539'
name: 12bfcdf1-b8b6-395b-a758-c1b10cbb4c46
description: 'Eos vitae et quis sunt libero laboriosam quam. Animi quia impedit rem quas molestiae et eum. Minima quae sit non unde praesentium occaecati eum. Et aliquid culpa accusantium et aperiam possimus.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-9c0d-4037-bbca-254923a10a8a
company_id:
type: string
example: '3156539'
name:
type: string
example: 12bfcdf1-b8b6-395b-a758-c1b10cbb4c46
description:
type: string
example: 'Eos vitae et quis sunt libero laboriosam quam. Animi quia impedit rem quas molestiae et eum. Minima quae sit non unde praesentium occaecati eum. Et aliquid culpa accusantium et aperiam possimus.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: a1db2512-a07a-4b21-a739-27e07e2e3be2
company_id: '2134304'
name: e2e37b1c-723f-349b-b36f-94e3c70e4b6c
description: 'Voluptatum perferendis vitae animi et. Amet dolor dolores dolor distinctio. Illo corporis eos autem. Et rerum illo placeat dolorem deleniti est perspiciatis unde.'
business_impact: medium
system_tag: true
asset_count: 0
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-a07a-4b21-a739-27e07e2e3be2
company_id:
type: string
example: '2134304'
name:
type: string
example: e2e37b1c-723f-349b-b36f-94e3c70e4b6c
description:
type: string
example: 'Voluptatum perferendis vitae animi et. Amet dolor dolores dolor distinctio. Illo corporis eos autem. Et rerum illo placeat dolorem deleniti est perspiciatis unde.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: cedhdrhphbu
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Occaecati possimus provident in perspiciatis aut quia.'
business_impact:
type: string
description: ''
example: high
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: sit
required: true
schema:
type: string
/v1/users:
get:
summary: 'List Users'
operationId: listUsers
description: "Retrieve all users for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: company
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: company
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: bc34448f-a26c-484d-b6ea-caec7e61e01c
company_id: '9075634'
managing_company_id: '9075634'
first_name: Zachary
last_name: Aufderhar
two_factor_enabled: false
email: hoberbrunner@torphy.com
email_verified_at: '2026-05-24T12:31:58.000000Z'
phonenumber: 413-230-4014
phonenumber_verified_at: '2026-05-24T12:31:58.000000Z'
report_interval: weekly
manageable_companies:
-
id: '9075634'
uuid: 28c6720a-e037-4caf-80ed-b154c19dbc4a
name: Beahan-Kunze
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-05-24T12:31:58.000000Z'
sso_provider: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:59.000000Z'
last_login_at: null
-
id: 932948ae-058b-4678-b5ea-dd3ac2091ea2
company_id: '6842934'
managing_company_id: '6842934'
first_name: Meggie
last_name: Hand
two_factor_enabled: false
email: parisian.luciano@yahoo.com
email_verified_at: '2026-05-24T12:31:59.000000Z'
phonenumber: '(229) 207-5195'
phonenumber_verified_at: '2026-05-24T12:31:59.000000Z'
report_interval: weekly
manageable_companies:
-
id: '6842934'
uuid: ec2ff2f7-c024-44ea-9f82-c8fbfb7c36bf
name: 'Gusikowski and Sons'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-05-24T12:31:59.000000Z'
sso_provider: null
created_at: '2026-05-24T12:31:59.000000Z'
updated_at: '2026-05-24T12:31:59.000000Z'
last_login_at: null
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: bc34448f-a26c-484d-b6ea-caec7e61e01c
company_id: '9075634'
managing_company_id: '9075634'
first_name: Zachary
last_name: Aufderhar
two_factor_enabled: false
email: hoberbrunner@torphy.com
email_verified_at: '2026-05-24T12:31:58.000000Z'
phonenumber: 413-230-4014
phonenumber_verified_at: '2026-05-24T12:31:58.000000Z'
report_interval: weekly
manageable_companies:
-
id: '9075634'
uuid: 28c6720a-e037-4caf-80ed-b154c19dbc4a
name: Beahan-Kunze
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-05-24T12:31:58.000000Z'
sso_provider: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:59.000000Z'
last_login_at: null
-
id: 932948ae-058b-4678-b5ea-dd3ac2091ea2
company_id: '6842934'
managing_company_id: '6842934'
first_name: Meggie
last_name: Hand
two_factor_enabled: false
email: parisian.luciano@yahoo.com
email_verified_at: '2026-05-24T12:31:59.000000Z'
phonenumber: '(229) 207-5195'
phonenumber_verified_at: '2026-05-24T12:31:59.000000Z'
report_interval: weekly
manageable_companies:
-
id: '6842934'
uuid: ec2ff2f7-c024-44ea-9f82-c8fbfb7c36bf
name: 'Gusikowski and Sons'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-05-24T12:31:59.000000Z'
sso_provider: null
created_at: '2026-05-24T12:31:59.000000Z'
updated_at: '2026-05-24T12:31:59.000000Z'
last_login_at: null
items:
type: object
properties:
id:
type: string
example: bc34448f-a26c-484d-b6ea-caec7e61e01c
company_id:
type: string
example: '9075634'
managing_company_id:
type: string
example: '9075634'
first_name:
type: string
example: Zachary
last_name:
type: string
example: Aufderhar
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: hoberbrunner@torphy.com
email_verified_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
phonenumber:
type: string
example: 413-230-4014
phonenumber_verified_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '9075634'
uuid: 28c6720a-e037-4caf-80ed-b154c19dbc4a
name: Beahan-Kunze
items:
type: object
properties:
id:
type: string
example: '9075634'
uuid:
type: string
example: 28c6720a-e037-4caf-80ed-b154c19dbc4a
name:
type: string
example: Beahan-Kunze
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
last_login_at:
type: string
example: null
nullable: true
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: yrcliypuxpmcmraefwbobu
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: qpheklaniahavvjxwgjn
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: arlo.reichel@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.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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: fd92df49-24db-4654-b4e0-0fab90306faf
company_id: '6723009'
managing_company_id: '6723009'
first_name: Flossie
last_name: Lehner
two_factor_enabled: false
email: schuppe.connor@yahoo.com
email_verified_at: '2026-05-24T12:31:59.000000Z'
phonenumber: +1-360-498-8943
phonenumber_verified_at: '2026-05-24T12:31:59.000000Z'
report_interval: weekly
manageable_companies:
-
id: '6723009'
uuid: a8742d50-f933-45f5-a014-9e5ac5de87b9
name: 'Hansen, Stamm and Predovic'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-05-24T12:31:59.000000Z'
sso_provider: null
created_at: '2026-05-24T12:31:59.000000Z'
updated_at: '2026-05-24T12:31:59.000000Z'
last_login_at: null
properties:
data:
type: object
properties:
id:
type: string
example: fd92df49-24db-4654-b4e0-0fab90306faf
company_id:
type: string
example: '6723009'
managing_company_id:
type: string
example: '6723009'
first_name:
type: string
example: Flossie
last_name:
type: string
example: Lehner
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: schuppe.connor@yahoo.com
email_verified_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
phonenumber:
type: string
example: +1-360-498-8943
phonenumber_verified_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '6723009'
uuid: a8742d50-f933-45f5-a014-9e5ac5de87b9
name: 'Hansen, Stamm and Predovic'
items:
type: object
properties:
id:
type: string
example: '6723009'
uuid:
type: string
example: a8742d50-f933-45f5-a014-9e5ac5de87b9
name:
type: string
example: 'Hansen, Stamm and Predovic'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:59.000000Z'
last_login_at:
type: string
example: null
nullable: true
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: d5185592-a4a9-3a0a-bfcc-92d635711522
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: port
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: port
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a1db2512-3d43-468e-995a-e30e94028463
asset_id: a1db2512-322f-49f7-b7ef-a3a901d03b59
company_id: '7149616'
vulnerability_definition_id: a1db2512-3c66-4bb2-bad5-989b121a17a0
vulnerability_definition:
id: a1db2512-3c66-4bb2-bad5-989b121a17a0
name: '4 exploitable through enim manipulation'
description: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
solution: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
category: '4'
threat_level: Low
definition_type: openvas
definition:
id: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name: '4 exploitable through enim manipulation'
family: '4'
reference_urls: 'http://www.toy.com/, http://wisozk.info/'
reference_cves: 'CVE-2023-2653, CVE-2021-4719'
solution_type: 'Configuration Change'
solution_description: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority: High
qod_type: registry
qod_value: 72
cvss_base_score: 4.7
cvss_base_vector: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
epss: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
host: 12.57.229.52
hostname: hahn.com
port: general/tcp
details: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
status: Detected
first_seen: '2025-07-28T03:19:26.000000Z'
last_seen: '2026-03-15T05:27:49.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
name: '4 exploitable through enim manipulation'
description: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
cvss_base_score: 4.7
cvss_base_vector: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
qod_type: registry
qod_value: 72
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name: '4 exploitable through enim manipulation'
family: '4'
reference_urls: 'http://www.toy.com/, http://wisozk.info/'
reference_cves: 'CVE-2023-2653, CVE-2021-4719'
solution_type: 'Configuration Change'
solution_description: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority: High
qod_type: registry
qod_value: 72
-
id: a1db2512-466e-4767-8fc9-b3e5bf6d62d4
asset_id: a1db2512-420c-4984-a696-f40e4dffb711
company_id: '6354303'
vulnerability_definition_id: a1db2512-45ea-4542-a1b7-c723257512cd
vulnerability_definition:
id: a1db2512-45ea-4542-a1b7-c723257512cd
name: 'Unnecessary Services Enabled in earum'
description: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
solution: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
category: 'Unnecessary Services Enabled'
threat_level: High
definition_type: openvas
definition:
id: a1db2512-44a6-4075-bfe0-403c00f161bc
o_id: 7a8507f6-16ab-36ec-96c0-eb2944b02237
name: 'Unnecessary Services Enabled in earum'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://turner.com/, http://mayert.net/molestias-cum-magnam-debitis-distinctio-rem-eum'
reference_cves: 'CVE-2020-1757, CVE-2018-4933'
solution_type: Mitigation
solution_description: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
summary: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
insight: 'Perferendis in enim placeat tempora iusto quo ad quisquam. Sequi numquam quos quasi deleniti nulla. Consequatur consequatur nam molestiae hic.'
affected: 'Magnam quia ut totam. Autem est quidem voluptatum aliquam ut et. Culpa doloremque et deleniti voluptas qui in. Est in maxime voluptatem earum et explicabo.'
impact: 'Blanditiis aut voluptas ullam atque. Provident pariatur eius asperiores non ipsa autem. Accusantium eveniet eligendi illo.'
vuldetect: 'Dolor laboriosam qui facilis. Esse velit voluptas quia error sapiente voluptatem. Inventore illum aut id ad tempore quia. Quos aspernatur omnis qui eum asperiores et praesentium.'
priority: Log
qod_type: exploit
qod_value: 5
cvss_base_score: 1.5
cvss_base_vector: 'AV:N/AC:L/Au:M/C:C/I:C/A:C'
epss: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
host: 123.207.166.196
hostname: cormier.net
port: 5432/tcp
details: 'Repellat necessitatibus ea ut et dolor reiciendis deserunt. Et sint sed et officia. Dolores enim animi a porro magni commodi. Dolorum minima cum aut et placeat dolorum aut.'
status: Accepted
first_seen: '2026-05-15T16:27:35.000000Z'
last_seen: '2026-05-23T22:59:22.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
name: 'Unnecessary Services Enabled in earum'
description: 'Repellat necessitatibus ea ut et dolor reiciendis deserunt. Et sint sed et officia. Dolores enim animi a porro magni commodi. Dolorum minima cum aut et placeat dolorum aut.'
cvss_base_score: 1.5
cvss_base_vector: 'AV:N/AC:L/Au:M/C:C/I:C/A:C'
qod_type: exploit
qod_value: 5
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a1db2512-44a6-4075-bfe0-403c00f161bc
o_id: 7a8507f6-16ab-36ec-96c0-eb2944b02237
name: 'Unnecessary Services Enabled in earum'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://turner.com/, http://mayert.net/molestias-cum-magnam-debitis-distinctio-rem-eum'
reference_cves: 'CVE-2020-1757, CVE-2018-4933'
solution_type: Mitigation
solution_description: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
summary: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
insight: 'Perferendis in enim placeat tempora iusto quo ad quisquam. Sequi numquam quos quasi deleniti nulla. Consequatur consequatur nam molestiae hic.'
affected: 'Magnam quia ut totam. Autem est quidem voluptatum aliquam ut et. Culpa doloremque et deleniti voluptas qui in. Est in maxime voluptatem earum et explicabo.'
impact: 'Blanditiis aut voluptas ullam atque. Provident pariatur eius asperiores non ipsa autem. Accusantium eveniet eligendi illo.'
vuldetect: 'Dolor laboriosam qui facilis. Esse velit voluptas quia error sapiente voluptatem. Inventore illum aut id ad tempore quia. Quos aspernatur omnis qui eum asperiores et praesentium.'
priority: Log
qod_type: exploit
qod_value: 5
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: a1db2512-3d43-468e-995a-e30e94028463
asset_id: a1db2512-322f-49f7-b7ef-a3a901d03b59
company_id: '7149616'
vulnerability_definition_id: a1db2512-3c66-4bb2-bad5-989b121a17a0
vulnerability_definition:
id: a1db2512-3c66-4bb2-bad5-989b121a17a0
name: '4 exploitable through enim manipulation'
description: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
solution: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
category: '4'
threat_level: Low
definition_type: openvas
definition:
id: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name: '4 exploitable through enim manipulation'
family: '4'
reference_urls: 'http://www.toy.com/, http://wisozk.info/'
reference_cves: 'CVE-2023-2653, CVE-2021-4719'
solution_type: 'Configuration Change'
solution_description: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority: High
qod_type: registry
qod_value: 72
cvss_base_score: 4.7
cvss_base_vector: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
epss: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
host: 12.57.229.52
hostname: hahn.com
port: general/tcp
details: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
status: Detected
first_seen: '2025-07-28T03:19:26.000000Z'
last_seen: '2026-03-15T05:27:49.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
name: '4 exploitable through enim manipulation'
description: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
cvss_base_score: 4.7
cvss_base_vector: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
qod_type: registry
qod_value: 72
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name: '4 exploitable through enim manipulation'
family: '4'
reference_urls: 'http://www.toy.com/, http://wisozk.info/'
reference_cves: 'CVE-2023-2653, CVE-2021-4719'
solution_type: 'Configuration Change'
solution_description: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority: High
qod_type: registry
qod_value: 72
-
id: a1db2512-466e-4767-8fc9-b3e5bf6d62d4
asset_id: a1db2512-420c-4984-a696-f40e4dffb711
company_id: '6354303'
vulnerability_definition_id: a1db2512-45ea-4542-a1b7-c723257512cd
vulnerability_definition:
id: a1db2512-45ea-4542-a1b7-c723257512cd
name: 'Unnecessary Services Enabled in earum'
description: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
solution: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
category: 'Unnecessary Services Enabled'
threat_level: High
definition_type: openvas
definition:
id: a1db2512-44a6-4075-bfe0-403c00f161bc
o_id: 7a8507f6-16ab-36ec-96c0-eb2944b02237
name: 'Unnecessary Services Enabled in earum'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://turner.com/, http://mayert.net/molestias-cum-magnam-debitis-distinctio-rem-eum'
reference_cves: 'CVE-2020-1757, CVE-2018-4933'
solution_type: Mitigation
solution_description: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
summary: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
insight: 'Perferendis in enim placeat tempora iusto quo ad quisquam. Sequi numquam quos quasi deleniti nulla. Consequatur consequatur nam molestiae hic.'
affected: 'Magnam quia ut totam. Autem est quidem voluptatum aliquam ut et. Culpa doloremque et deleniti voluptas qui in. Est in maxime voluptatem earum et explicabo.'
impact: 'Blanditiis aut voluptas ullam atque. Provident pariatur eius asperiores non ipsa autem. Accusantium eveniet eligendi illo.'
vuldetect: 'Dolor laboriosam qui facilis. Esse velit voluptas quia error sapiente voluptatem. Inventore illum aut id ad tempore quia. Quos aspernatur omnis qui eum asperiores et praesentium.'
priority: Log
qod_type: exploit
qod_value: 5
cvss_base_score: 1.5
cvss_base_vector: 'AV:N/AC:L/Au:M/C:C/I:C/A:C'
epss: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
host: 123.207.166.196
hostname: cormier.net
port: 5432/tcp
details: 'Repellat necessitatibus ea ut et dolor reiciendis deserunt. Et sint sed et officia. Dolores enim animi a porro magni commodi. Dolorum minima cum aut et placeat dolorum aut.'
status: Accepted
first_seen: '2026-05-15T16:27:35.000000Z'
last_seen: '2026-05-23T22:59:22.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
name: 'Unnecessary Services Enabled in earum'
description: 'Repellat necessitatibus ea ut et dolor reiciendis deserunt. Et sint sed et officia. Dolores enim animi a porro magni commodi. Dolorum minima cum aut et placeat dolorum aut.'
cvss_base_score: 1.5
cvss_base_vector: 'AV:N/AC:L/Au:M/C:C/I:C/A:C'
qod_type: exploit
qod_value: 5
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a1db2512-44a6-4075-bfe0-403c00f161bc
o_id: 7a8507f6-16ab-36ec-96c0-eb2944b02237
name: 'Unnecessary Services Enabled in earum'
family: 'Unnecessary Services Enabled'
reference_urls: 'http://turner.com/, http://mayert.net/molestias-cum-magnam-debitis-distinctio-rem-eum'
reference_cves: 'CVE-2020-1757, CVE-2018-4933'
solution_type: Mitigation
solution_description: 'Vero pariatur harum dignissimos sequi neque autem fuga. Neque excepturi asperiores sit qui autem quia et. Provident repellat architecto tempore quae.'
summary: 'Quibusdam sed velit quis aut laboriosam aut autem laborum. Ut modi sit ut quia quas adipisci impedit. Voluptas et voluptatum reiciendis ut nisi recusandae.'
insight: 'Perferendis in enim placeat tempora iusto quo ad quisquam. Sequi numquam quos quasi deleniti nulla. Consequatur consequatur nam molestiae hic.'
affected: 'Magnam quia ut totam. Autem est quidem voluptatum aliquam ut et. Culpa doloremque et deleniti voluptas qui in. Est in maxime voluptatem earum et explicabo.'
impact: 'Blanditiis aut voluptas ullam atque. Provident pariatur eius asperiores non ipsa autem. Accusantium eveniet eligendi illo.'
vuldetect: 'Dolor laboriosam qui facilis. Esse velit voluptas quia error sapiente voluptatem. Inventore illum aut id ad tempore quia. Quos aspernatur omnis qui eum asperiores et praesentium.'
priority: Log
qod_type: exploit
qod_value: 5
items:
type: object
properties:
id:
type: string
example: a1db2512-3d43-468e-995a-e30e94028463
asset_id:
type: string
example: a1db2512-322f-49f7-b7ef-a3a901d03b59
company_id:
type: string
example: '7149616'
vulnerability_definition_id:
type: string
example: a1db2512-3c66-4bb2-bad5-989b121a17a0
vulnerability_definition:
type: object
properties:
id:
type: string
example: a1db2512-3c66-4bb2-bad5-989b121a17a0
name:
type: string
example: '4 exploitable through enim manipulation'
description:
type: string
example: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
solution:
type: string
example: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
category:
type: string
example: '4'
threat_level:
type: string
example: Low
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id:
type: string
example: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name:
type: string
example: '4 exploitable through enim manipulation'
family:
type: string
example: '4'
reference_urls:
type: string
example: 'http://www.toy.com/, http://wisozk.info/'
reference_cves:
type: string
example: 'CVE-2023-2653, CVE-2021-4719'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary:
type: string
example: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight:
type: string
example: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected:
type: string
example: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact:
type: string
example: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect:
type: string
example: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority:
type: string
example: High
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 72
cvss_base_score:
type: number
example: 4.7
cvss_base_vector:
type: string
example: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
epss:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
host:
type: string
example: 12.57.229.52
hostname:
type: string
example: hahn.com
port:
type: string
example: general/tcp
details:
type: string
example: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
status:
type: string
example: Detected
first_seen:
type: string
example: '2025-07-28T03:19:26.000000Z'
last_seen:
type: string
example: '2026-03-15T05:27:49.000000Z'
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
name:
type: string
example: '4 exploitable through enim manipulation'
description:
type: string
example: 'Quia modi est et dolore voluptate. Nisi repellat dolorem suscipit et autem ex molestiae. Repudiandae dolorem expedita eum.'
cvss_base_score:
type: number
example: 4.7
cvss_base_vector:
type: string
example: 'AV:P/AC:H/Au:M/C:N/I:C/A:P'
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 72
threat:
type: string
example: Low
scanner_id:
type: string
example: null
nullable: true
scanner_hostname:
type: string
example: null
nullable: true
plugin:
type: object
properties:
id:
type: string
example: a1db2512-39c7-4d1c-83ac-8ca9b3ea294c
o_id:
type: string
example: 6db1b6a3-662e-3acb-af87-a5796f6a2e63
name:
type: string
example: '4 exploitable through enim manipulation'
family:
type: string
example: '4'
reference_urls:
type: string
example: 'http://www.toy.com/, http://wisozk.info/'
reference_cves:
type: string
example: 'CVE-2023-2653, CVE-2021-4719'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Et cupiditate omnis quia necessitatibus. Qui et rem illo excepturi eligendi. Libero ab odio est commodi reprehenderit. Voluptatum occaecati cupiditate vero voluptatum.'
summary:
type: string
example: 'Quae eligendi eius voluptas ea sit perferendis nam. Ut iusto a et asperiores possimus aperiam. Quo et voluptatem quaerat deleniti.'
insight:
type: string
example: 'Expedita cupiditate a ut et commodi. Tempora assumenda quasi enim incidunt architecto rerum. Commodi ullam sunt perferendis. Laborum est beatae reprehenderit qui.'
affected:
type: string
example: 'Et fugit beatae voluptatum. Sit amet iure sint similique id. Ullam in nobis est in commodi.'
impact:
type: string
example: 'Ratione sunt officiis pariatur est ut. Incidunt placeat esse eum. Nesciunt sed perspiciatis voluptatem quos ut officiis labore.'
vuldetect:
type: string
example: 'Nulla qui officia ex aspernatur. Quibusdam asperiores accusamus et praesentium. Eius officia optio minima est quo at. Qui aut aut omnis consectetur nisi nemo laborum. Voluptas autem exercitationem dolore ut.'
priority:
type: string
example: High
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 72
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: neddqeryenwusbrnrtrei
threat_level:
type: string
description: ''
example: Low
enum:
- Log
- Low
- Medium
- High
- Critical
host:
type: string
description: 'Must not be greater than 255 characters.'
example: xnskeohga
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: artagifdyxiymzktes
status:
type: string
description: ''
example: Detected
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: 7e988ccd-9ee3-35a7-a0ea-7882338e12da
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 17
'/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: a1db2512-555a-4b8f-9efb-fc9d5040960e
asset_id: a1db2512-50b4-4a20-9082-8c971d47247b
company_id: '1265717'
vulnerability_definition_id: a1db2512-54da-4119-b57d-b2157b93ab31
vulnerability_definition:
id: a1db2512-54da-4119-b57d-b2157b93ab31
name: 'Weak Passwords via eius input'
description: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
solution: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
category: 'Weak Passwords'
threat_level: Medium
definition_type: openvas
definition:
id: a1db2512-537a-4ec5-9232-8ae07615d918
o_id: fe4dc678-86c5-3628-ae75-e575576e4fa8
name: 'Weak Passwords via eius input'
family: 'Weak Passwords'
reference_urls: 'http://denesik.org/, https://schiller.info/ut-officia-omnis-a-est-necessitatibus-quibusdam.html'
reference_cves: 'CVE-2022-4708, CVE-2015-8958'
solution_type: 'Configuration Change'
solution_description: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
summary: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
insight: 'Sed error tenetur aut. Quibusdam in non velit ut voluptatem consequatur. Saepe culpa quia consequatur qui sed vel.'
affected: 'Quia error eum deserunt. Quod rem fugit facilis temporibus dolore. Cumque quae quae quisquam. Rem distinctio quibusdam ullam quibusdam recusandae iure fugiat.'
impact: 'Id eligendi consequatur quidem saepe pariatur temporibus qui. Ducimus ut maiores nostrum laborum id. In accusamus quas et et autem magnam et. Voluptas sit omnis nihil. Quis sed pariatur et. Rem id earum et praesentium.'
vuldetect: 'Voluptatibus autem quis eos in. Eaque dolores asperiores autem quia vero sed. Eos soluta qui asperiores voluptas quae. Beatae et voluptates nobis.'
priority: Log
qod_type: package
qod_value: 64
cvss_base_score: 3.2
cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:C/A:P'
epss: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
host: 19.105.218.158
hostname: weber.biz
port: 3389/tcp
details: 'Aut est at et nemo eaque cumque ea. Qui quaerat quod voluptatum. Debitis autem non quia ducimus occaecati quasi fuga.'
status: Detected
first_seen: '2025-09-09T08:02:59.000000Z'
last_seen: '2026-04-11T23:00:13.000000Z'
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
name: 'Weak Passwords via eius input'
description: 'Aut est at et nemo eaque cumque ea. Qui quaerat quod voluptatum. Debitis autem non quia ducimus occaecati quasi fuga.'
cvss_base_score: 3.2
cvss_base_vector: 'AV:L/AC:H/Au:N/C:C/I:C/A:P'
qod_type: package
qod_value: 64
threat: Medium
scanner_id: null
scanner_hostname: null
plugin:
id: a1db2512-537a-4ec5-9232-8ae07615d918
o_id: fe4dc678-86c5-3628-ae75-e575576e4fa8
name: 'Weak Passwords via eius input'
family: 'Weak Passwords'
reference_urls: 'http://denesik.org/, https://schiller.info/ut-officia-omnis-a-est-necessitatibus-quibusdam.html'
reference_cves: 'CVE-2022-4708, CVE-2015-8958'
solution_type: 'Configuration Change'
solution_description: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
summary: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
insight: 'Sed error tenetur aut. Quibusdam in non velit ut voluptatem consequatur. Saepe culpa quia consequatur qui sed vel.'
affected: 'Quia error eum deserunt. Quod rem fugit facilis temporibus dolore. Cumque quae quae quisquam. Rem distinctio quibusdam ullam quibusdam recusandae iure fugiat.'
impact: 'Id eligendi consequatur quidem saepe pariatur temporibus qui. Ducimus ut maiores nostrum laborum id. In accusamus quas et et autem magnam et. Voluptas sit omnis nihil. Quis sed pariatur et. Rem id earum et praesentium.'
vuldetect: 'Voluptatibus autem quis eos in. Eaque dolores asperiores autem quia vero sed. Eos soluta qui asperiores voluptas quae. Beatae et voluptates nobis.'
priority: Log
qod_type: package
qod_value: 64
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-555a-4b8f-9efb-fc9d5040960e
asset_id:
type: string
example: a1db2512-50b4-4a20-9082-8c971d47247b
company_id:
type: string
example: '1265717'
vulnerability_definition_id:
type: string
example: a1db2512-54da-4119-b57d-b2157b93ab31
vulnerability_definition:
type: object
properties:
id:
type: string
example: a1db2512-54da-4119-b57d-b2157b93ab31
name:
type: string
example: 'Weak Passwords via eius input'
description:
type: string
example: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
solution:
type: string
example: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
category:
type: string
example: 'Weak Passwords'
threat_level:
type: string
example: Medium
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a1db2512-537a-4ec5-9232-8ae07615d918
o_id:
type: string
example: fe4dc678-86c5-3628-ae75-e575576e4fa8
name:
type: string
example: 'Weak Passwords via eius input'
family:
type: string
example: 'Weak Passwords'
reference_urls:
type: string
example: 'http://denesik.org/, https://schiller.info/ut-officia-omnis-a-est-necessitatibus-quibusdam.html'
reference_cves:
type: string
example: 'CVE-2022-4708, CVE-2015-8958'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
summary:
type: string
example: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
insight:
type: string
example: 'Sed error tenetur aut. Quibusdam in non velit ut voluptatem consequatur. Saepe culpa quia consequatur qui sed vel.'
affected:
type: string
example: 'Quia error eum deserunt. Quod rem fugit facilis temporibus dolore. Cumque quae quae quisquam. Rem distinctio quibusdam ullam quibusdam recusandae iure fugiat.'
impact:
type: string
example: 'Id eligendi consequatur quidem saepe pariatur temporibus qui. Ducimus ut maiores nostrum laborum id. In accusamus quas et et autem magnam et. Voluptas sit omnis nihil. Quis sed pariatur et. Rem id earum et praesentium.'
vuldetect:
type: string
example: 'Voluptatibus autem quis eos in. Eaque dolores asperiores autem quia vero sed. Eos soluta qui asperiores voluptas quae. Beatae et voluptates nobis.'
priority:
type: string
example: Log
qod_type:
type: string
example: package
qod_value:
type: integer
example: 64
cvss_base_score:
type: number
example: 3.2
cvss_base_vector:
type: string
example: 'AV:L/AC:H/Au:N/C:C/I:C/A:P'
epss:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
host:
type: string
example: 19.105.218.158
hostname:
type: string
example: weber.biz
port:
type: string
example: 3389/tcp
details:
type: string
example: 'Aut est at et nemo eaque cumque ea. Qui quaerat quod voluptatum. Debitis autem non quia ducimus occaecati quasi fuga.'
status:
type: string
example: Detected
first_seen:
type: string
example: '2025-09-09T08:02:59.000000Z'
last_seen:
type: string
example: '2026-04-11T23:00:13.000000Z'
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
name:
type: string
example: 'Weak Passwords via eius input'
description:
type: string
example: 'Aut est at et nemo eaque cumque ea. Qui quaerat quod voluptatum. Debitis autem non quia ducimus occaecati quasi fuga.'
cvss_base_score:
type: number
example: 3.2
cvss_base_vector:
type: string
example: 'AV:L/AC:H/Au:N/C:C/I:C/A:P'
qod_type:
type: string
example: package
qod_value:
type: integer
example: 64
threat:
type: string
example: Medium
scanner_id:
type: string
example: null
nullable: true
scanner_hostname:
type: string
example: null
nullable: true
plugin:
type: object
properties:
id:
type: string
example: a1db2512-537a-4ec5-9232-8ae07615d918
o_id:
type: string
example: fe4dc678-86c5-3628-ae75-e575576e4fa8
name:
type: string
example: 'Weak Passwords via eius input'
family:
type: string
example: 'Weak Passwords'
reference_urls:
type: string
example: 'http://denesik.org/, https://schiller.info/ut-officia-omnis-a-est-necessitatibus-quibusdam.html'
reference_cves:
type: string
example: 'CVE-2022-4708, CVE-2015-8958'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Nesciunt provident non numquam eos recusandae rem id. Ut dolorem corporis qui corrupti est consectetur. Et sit nisi laborum laudantium minima occaecati amet. Aut architecto deleniti eos quasi optio unde eaque. Sed aut et quod officiis.'
summary:
type: string
example: 'Earum perferendis voluptatum odio perferendis delectus ut asperiores. Eum iusto laborum iste. Autem vero labore inventore nemo ex quae.'
insight:
type: string
example: 'Sed error tenetur aut. Quibusdam in non velit ut voluptatem consequatur. Saepe culpa quia consequatur qui sed vel.'
affected:
type: string
example: 'Quia error eum deserunt. Quod rem fugit facilis temporibus dolore. Cumque quae quae quisquam. Rem distinctio quibusdam ullam quibusdam recusandae iure fugiat.'
impact:
type: string
example: 'Id eligendi consequatur quidem saepe pariatur temporibus qui. Ducimus ut maiores nostrum laborum id. In accusamus quas et et autem magnam et. Voluptas sit omnis nihil. Quis sed pariatur et. Rem id earum et praesentium.'
vuldetect:
type: string
example: 'Voluptatibus autem quis eos in. Eaque dolores asperiores autem quia vero sed. Eos soluta qui asperiores voluptas quae. Beatae et voluptates nobis.'
priority:
type: string
example: Log
qod_type:
type: string
example: package
qod_value:
type: integer
example: 64
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: laborum
required: true
schema:
type: string
/v1/webhook-events:
get:
summary: 'List all webhook events'
operationId: listAllWebhookEvents
description: "Lists all webhook events for the authenticated user's company.\n"
parameters:
-
in: query
name: sort
description: 'Sort the results by column(s) (comma separated).'
example: event
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: event
enum:
- webhook_id
- event
- status
- next_retry_at
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: status
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: status
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a1db2511-f674-47cf-a951-2dc47d57a156
webhook_id: a1db2511-f59d-4fd8-acd3-f574155ef539
event: possimus
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2511-fa0e-44c0-94bf-771375e3cd66
webhook_id: a1db2511-f978-4e6a-90dc-4d8c4213f045
event: itaque
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.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: a1db2511-f674-47cf-a951-2dc47d57a156
webhook_id: a1db2511-f59d-4fd8-acd3-f574155ef539
event: possimus
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2511-fa0e-44c0-94bf-771375e3cd66
webhook_id: a1db2511-f978-4e6a-90dc-4d8c4213f045
event: itaque
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2511-f674-47cf-a951-2dc47d57a156
webhook_id:
type: string
example: a1db2511-f59d-4fd8-acd3-f574155ef539
event:
type: string
example: possimus
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
nullable: true
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
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
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
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: a1db2512-0599-4c86-ab73-50059d976318
webhook_id: a1db2512-04f0-4191-b921-b3cfd115ea5e
event: nulla
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2512-0599-4c86-ab73-50059d976318
webhook_id:
type: string
example: a1db2512-04f0-4191-b921-b3cfd115ea5e
event:
type: string
example: nulla
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
nullable: true
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: a1db2511-f674-47cf-a951-2dc47d57a156
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: a1db2511-c1f3-492a-9294-940a7a4f8bc8
company_id: 6fa47559-ed23-4ff7-8fda-2803597f1340
url: 'https://wunsch.com'
description: null
events: []
secret: 3e9ba4e92353e42d465213823842c8651e2105f0cf2ae8d5b103fe5a67947904
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2511-deed-41fa-a92e-f3b3069b00a4
company_id: c0d2d469-170d-4b0c-91a7-e2da9a0851f3
url: 'https://oconner.com'
description: null
events: []
secret: 7c574dbe85bc620b102ce97893b01c1552ea025eb6c5916f493cdd484377cc1e
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: array
example:
-
id: a1db2511-c1f3-492a-9294-940a7a4f8bc8
company_id: 6fa47559-ed23-4ff7-8fda-2803597f1340
url: 'https://wunsch.com'
description: null
events: []
secret: 3e9ba4e92353e42d465213823842c8651e2105f0cf2ae8d5b103fe5a67947904
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
-
id: a1db2511-deed-41fa-a92e-f3b3069b00a4
company_id: c0d2d469-170d-4b0c-91a7-e2da9a0851f3
url: 'https://oconner.com'
description: null
events: []
secret: 7c574dbe85bc620b102ce97893b01c1552ea025eb6c5916f493cdd484377cc1e
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
items:
type: object
properties:
id:
type: string
example: a1db2511-c1f3-492a-9294-940a7a4f8bc8
company_id:
type: string
example: 6fa47559-ed23-4ff7-8fda-2803597f1340
url:
type: string
example: 'https://wunsch.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: 3e9ba4e92353e42d465213823842c8651e2105f0cf2ae8d5b103fe5a67947904
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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://www.bednar.info/'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Odio est voluptatem explicabo expedita.'
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: a1db2511-e75e-437a-9db1-a61aa44d0e0d
company_id: 8d4d178d-573e-4000-8b01-6fc32da92088
url: 'https://feest.com'
description: null
events: []
secret: e7d49f524aae36c07c855d5454c178087a82e551f45d4129109a27889ce2e0e5
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2511-e75e-437a-9db1-a61aa44d0e0d
company_id:
type: string
example: 8d4d178d-573e-4000-8b01-6fc32da92088
url:
type: string
example: 'https://feest.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: e7d49f524aae36c07c855d5454c178087a82e551f45d4129109a27889ce2e0e5
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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://rutherford.biz/'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Aut doloribus consequatur quae nihil rerum mollitia sit.'
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: a1db2511-c1f3-492a-9294-940a7a4f8bc8
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: a1db2511-ebb6-417b-8da0-abfb5f581108
company_id: ff402a7e-2bca-4760-b960-a740c036211f
url: 'https://buckridge.com'
description: null
events: []
secret: 11603aaaf9b7668c944fbc6b48154b3f33947da2cf24ca34bd094a9f50e5dcdf
last_sent_at: null
created_at: '2026-05-24T12:31:58.000000Z'
updated_at: '2026-05-24T12:31:58.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a1db2511-ebb6-417b-8da0-abfb5f581108
company_id:
type: string
example: ff402a7e-2bca-4760-b960-a740c036211f
url:
type: string
example: 'https://buckridge.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: 11603aaaf9b7668c944fbc6b48154b3f33947da2cf24ca34bd094a9f50e5dcdf
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-05-24T12:31:58.000000Z'
updated_at:
type: string
example: '2026-05-24T12:31:58.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: a1db2511-c1f3-492a-9294-940a7a4f8bc8
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: a1db2511-c1f3-492a-9294-940a7a4f8bc8
required: true
schema:
type: string