openapi: 3.0.3
info:
title: 'SecurityHive API Documentation'
description: ''
version: 1.0.0
servers:
-
url: 'https://api.securityhive.io'
tags:
-
name: Applications
description: 'Manage the applications that have been discovered on your assets.'
-
name: Assets
description: 'Manage assets that have been discovered on your network.'
-
name: Certificates
description: 'Manage certificates that have been discovered on your network.'
-
name: Detections
description: 'Manage your honeypot detections'
-
name: Endpoints
description: ''
-
name: Honeypots
description: 'Manage your honeypots.'
-
name: Integrations
description: "\nAPIs for managing integrations"
-
name: Me
description: "\nAPIs for managing the authenticated user"
-
name: Tags
description: 'Tags can be used to categorize assets.'
-
name: Users
description: "\nAPIs for managing users"
-
name: Vulnerabilities
description: 'Manage vulnerabilities that have been discovered on your network.'
-
name: 'Webhook Events'
description: "\nAPIs for managing webhook events"
-
name: Webhooks
description: "\nAPIs for managing webhooks"
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting the dashboard and clicking Generate new token at your profile.'
security:
-
default: []
paths:
/v1/applications:
get:
summary: 'List applications.'
operationId: listApplications
description: " Retrieve all applications for the current company. Look at the 'Retrieve an application' endpoint for more details on the application object.\n "
parameters:
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
-
in: query
name: sort
description: ''
example: product
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: product
enum:
- cpe
- vendor
- product
- version
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
enum:
- assets
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a17a46d5-f6f1-4f50-b7d4-e606095a074a
cpe: 'cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*'
vendor: Google
product: Workspace
version: 13.53.431
update: sp1
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-f819-4a3e-907f-9845a5c22fc8
cpe: 'cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*'
vendor: Google
product: Workspace
version: 18.10.9956
update: sp2
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.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: a17a46d5-f6f1-4f50-b7d4-e606095a074a
cpe: 'cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*'
vendor: Google
product: Workspace
version: 13.53.431
update: sp1
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-f819-4a3e-907f-9845a5c22fc8
cpe: 'cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*'
vendor: Google
product: Workspace
version: 18.10.9956
update: sp2
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-f6f1-4f50-b7d4-e606095a074a
cpe:
type: string
example: 'cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Google
product:
type: string
example: Workspace
version:
type: string
example: 13.53.431
update:
type: string
example: sp1
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Applications
/v1/applications/export:
get:
summary: 'Export applications.'
operationId: exportApplications
description: " Export all applications for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: csv
required: true
schema:
type: 'The type of export to generate'
description: ''
example: csv
enum:
- csv
- xlsx
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
-
in: query
name: sort
description: ''
example: vendor
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: vendor
enum:
- cpe
- vendor
- product
- version
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: ''
example: csv
enum:
- csv
- xlsx
required:
- type
'/v1/applications/{id}':
get:
summary: 'Retrieve an application.'
operationId: retrieveAnApplication
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
enum:
- assets
responses:
200:
description: 'Successfully retrieved application'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-fb91-4c08-9582-236842e1f6aa
cpe: 'cpe:2.3:a:microsoft:windows:*:*:*:*:*:*:*:*'
vendor: Microsoft
product: Windows
version: 20.94.2287
update: sp2
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-fb91-4c08-9582-236842e1f6aa
cpe:
type: string
example: 'cpe:2.3:a:microsoft:windows:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Microsoft
product:
type: string
example: Windows
version:
type: string
example: 20.94.2287
update:
type: string
example: sp2
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: est
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: host
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: host
enum:
- name
- host
- last_seen
- licensed
-
in: query
name: include
description: ''
example: software
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: software
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a17a46d5-bc58-4b35-bf22-0715ccb5bd56
company_id: '294250'
name: 'Jena Conroy'
identifier: 88.8.178.6
host: 88.8.178.6
mac_address: null
hostname: zulauf.com
operating_system: quam
operating_system_name: dignissimos
first_seen: '1986-12-08T09:53:33.000000Z'
last_seen: '1975-05-22T03:39:18.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-04-29T20:49:30.000000Z'
-
id: a17a46d5-bee2-4d17-8af3-9c818d04f6eb
company_id: '8296156'
name: 'Eve Beatty'
identifier: '60:F6:37:C4:FA:3B'
host: 172.48.89.86
mac_address: '60:F6:37:C4:FA:3B'
hostname: block.info
operating_system: reiciendis
operating_system_name: inventore
first_seen: '1988-12-21T21:37:43.000000Z'
last_seen: '1992-03-27T19:02:02.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-04-17T11:16:18.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: a17a46d5-bc58-4b35-bf22-0715ccb5bd56
company_id: '294250'
name: 'Jena Conroy'
identifier: 88.8.178.6
host: 88.8.178.6
mac_address: null
hostname: zulauf.com
operating_system: quam
operating_system_name: dignissimos
first_seen: '1986-12-08T09:53:33.000000Z'
last_seen: '1975-05-22T03:39:18.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-04-29T20:49:30.000000Z'
-
id: a17a46d5-bee2-4d17-8af3-9c818d04f6eb
company_id: '8296156'
name: 'Eve Beatty'
identifier: '60:F6:37:C4:FA:3B'
host: 172.48.89.86
mac_address: '60:F6:37:C4:FA:3B'
hostname: block.info
operating_system: reiciendis
operating_system_name: inventore
first_seen: '1988-12-21T21:37:43.000000Z'
last_seen: '1992-03-27T19:02:02.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-04-17T11:16:18.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-bc58-4b35-bf22-0715ccb5bd56
company_id:
type: string
example: '294250'
name:
type: string
example: 'Jena Conroy'
identifier:
type: string
example: 88.8.178.6
host:
type: string
example: 88.8.178.6
mac_address:
type: string
example: null
hostname:
type: string
example: zulauf.com
operating_system:
type: string
example: quam
operating_system_name:
type: string
example: dignissimos
first_seen:
type: string
example: '1986-12-08T09:53:33.000000Z'
last_seen:
type: string
example: '1975-05-22T03:39:18.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2026-04-29T20:49:30.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Assets
post:
summary: 'Create asset.'
operationId: createAsset
description: "Will create a new asset for the current company. \n "
parameters: []
responses:
200:
description: 'Successfully created asset'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-c639-41de-992b-b36e4784389b
company_id: '9053797'
name: 'Dr. Kirstin Ernser'
identifier: 'E8:81:D4:CE:4C:DA'
host: 78.190.226.181
mac_address: 'E8:81:D4:CE:4C:DA'
hostname: cronin.info
operating_system: quo
operating_system_name: quia
first_seen: '2007-03-09T01:47:26.000000Z'
last_seen: '2001-11-22T02:56:13.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-04-16T05:09:29.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-c639-41de-992b-b36e4784389b
company_id:
type: string
example: '9053797'
name:
type: string
example: 'Dr. Kirstin Ernser'
identifier:
type: string
example: 'E8:81:D4:CE:4C:DA'
host:
type: string
example: 78.190.226.181
mac_address:
type: string
example: 'E8:81:D4:CE:4C:DA'
hostname:
type: string
example: cronin.info
operating_system:
type: string
example: quo
operating_system_name:
type: string
example: quia
first_seen:
type: string
example: '2007-03-09T01:47:26.000000Z'
last_seen:
type: string
example: '2001-11-22T02:56:13.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-04-16T05:09:29.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: au
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: aut
licensed:
type: boolean
description: ''
example: true
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: eum
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: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: 'Successfully retrieved asset'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-c9bf-4847-a4cf-104f635c666b
company_id: '2643712'
name: 'Abigail Homenick'
identifier: '3E:A4:83:75:61:EA'
host: 123.124.61.143
mac_address: '3E:A4:83:75:61:EA'
hostname: botsford.org
operating_system: quam
operating_system_name: ullam
first_seen: '1994-11-22T14:53:01.000000Z'
last_seen: '1974-09-03T05:04:42.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: false
change_license_at: '2026-04-15T13:20:38.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-c9bf-4847-a4cf-104f635c666b
company_id:
type: string
example: '2643712'
name:
type: string
example: 'Abigail Homenick'
identifier:
type: string
example: '3E:A4:83:75:61:EA'
host:
type: string
example: 123.124.61.143
mac_address:
type: string
example: '3E:A4:83:75:61:EA'
hostname:
type: string
example: botsford.org
operating_system:
type: string
example: quam
operating_system_name:
type: string
example: ullam
first_seen:
type: string
example: '1994-11-22T14:53:01.000000Z'
last_seen:
type: string
example: '1974-09-03T05:04:42.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-04-15T13:20:38.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: a17a46d5-ce59-48c2-91cb-c54efc69e9d3
company_id: '7454614'
name: 'Francesco Littel'
identifier: 'D1:46:47:2E:9E:0C'
host: 80.52.130.78
mac_address: 'D1:46:47:2E:9E:0C'
hostname: reichert.com
operating_system: fugit
operating_system_name: itaque
first_seen: '2007-12-26T23:06:51.000000Z'
last_seen: '2025-11-27T00:37:20.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-05-05T04:59:17.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-ce59-48c2-91cb-c54efc69e9d3
company_id:
type: string
example: '7454614'
name:
type: string
example: 'Francesco Littel'
identifier:
type: string
example: 'D1:46:47:2E:9E:0C'
host:
type: string
example: 80.52.130.78
mac_address:
type: string
example: 'D1:46:47:2E:9E:0C'
hostname:
type: string
example: reichert.com
operating_system:
type: string
example: fugit
operating_system_name:
type: string
example: itaque
first_seen:
type: string
example: '2007-12-26T23:06:51.000000Z'
last_seen:
type: string
example: '2025-11-27T00:37:20.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2026-05-05T04:59:17.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: hoxyzixjypbjmbi
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: ullam
required: true
schema:
type: string
/v1/certificates:
get:
summary: 'List certificates.'
operationId: listCertificates
description: " Retrieve all certificates for the current company. Look at the 'Retrieve a certificate' endpoint for more details on the certificate object.\n "
parameters:
-
in: query
name: 'filter[common_name]'
description: ''
example: test.nl
required: false
schema:
type: 'Filter certificates by their common name.'
description: ''
example: test.nl
-
in: query
name: 'filter[organization]'
description: ''
example: 'Test B.V.'
required: false
schema:
type: 'Filter certificates by their organization name.'
description: ''
example: 'Test B.V.'
-
in: query
name: sort
description: ''
example: not_valid_after
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before'
description: ''
example: not_valid_after
enum:
- not_valid_after
-
in: query
name: include
description: ''
example: scans
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: scans
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a17a46d5-d4b9-43f0-b410-0c334a8fd545
company_id: '9401673'
common_name: stokes.com
organization: 'Grant, Osinski and Schmidt'
organizational_unit: null
locality: null
state: null
country: PF
serial: 5IS1XCCURMQAVC9NGKOIUPBSYCUQKIQQ
not_valid_before: 20240714T030108Z
not_valid_after: 20261023T203514Z
value: "-----BEGIN CERTIFICATE-----\ns0NF5/Xn7SA4jL26JlHxsAqz3wXuGnH3LBhSg4lXLlskcq3UiwewssFAFlDVyN92\nMhlNavXKpO8YCyduAtNsm1+fPZVG7rCkKQmNJfxseWgms4k43BM3FUvEfdgzBsIF\nJvl0qohS4EQKZoeqT9XEHqJ1Mcdl6V8T54q2jOw4wUgIUWFdQJqHc6zh3ZQX/k7f\nndumnSjg/jzF8fowyWsTRy14p/lsjYz+tCYPTYP7doO3s0bFXsHjm5oEUvIVAP5r\nZp6OqC/VIgoWKCSGxuUaXFlOMOgoMp8+r39ZudnMPJcxIkJ2xONTsA0Fbk3UmDIJ\nqBzSF78jfL+PwpHRa3ZptcP9IA+aSpoGTEc8nfQubsE63RMOhn3HABvQ4IiAVtQl\nZPLJ/dpBEW/PTmeso8lkwJti7jkgcloU2aQKaBV0fR6ldu1fWgz3tV4IcZeyEBrj\nLdS3N7WWrmgciLEtZLJAphW6e5ZpZ457ClXJddWuOauZ4fzdNj2+iaOacMe0Dye6\npce3sUdoGfbXncIzi3mgZ82RnLs4hcs/EzZWa5IbZQtHhL8NlQxM3riEHFSkqRbu\nEV7KNVjJT+DzTwN+MAwigu5B5/CWfe+kKbsyCY+g04Szj4TtIOmqp0yuI+gud12q\nAjiCN0eJKYhroBa5ZNbtoEJk0IVHTqWudSQqt5nhWHcAqbUA9eq8yiF6GVNp622m\nW8d4J+PJ8yEKVhCP4P12t7nfwvNbuZ9TF4rhRLMRBowGEJ/QfUOO9dEGDaqBrd42\nQx1LF+3e7oUNWSSkVHL/lHwafP4iiilafSXqtczTNU1BfUxt4Cau+2j8h/39xi+X\nY9IHE1IBqJ7ocKvOSGrQKG90RR1Qh6ue1YIWIsuDxRrJ2ofFuUqK+ti9oumpViPE\nL49D+lLZVzUyoG4ua020cTXLt6hoFUy6URn/U7pGuXYKozSTPT/7DVXPqztCh7sP\nCELzPAJo+9mGEfDPYx9SAor3LHpe9xEVwikpON7tf7Zv0ZCLiDjxuSF9ybHKMxTi\n+ckMj0yd/mtvc96MK/29ki8xlGSMn11q3Cy3WxDofv45T7rfb8hM+A4+FOEKnNPd\nazZL/QGkmwvHA0xRsMg8vpq+aVWFoO/ykAcjYrBDjM6kpgqU6t3VU31N7p0yUj4X\n7+jvfQMcu6fqRciazgYQEqWfKeROk0hJD6HlKy1oXRwo+n32I1JZCAUktXtG0CyX\nSMhQTuNvMu4oNdx5d2Kucxa1kGRhkC8Y+LYQpPewf5yiNOGPCw/gLh/sBzFRlJQR\nN+UlcK8YkiHROL8cseJuh4xkgCtBUnAql9ZN5c0jl52O2Z8zBS9IpyoKL2duwdnX\n0zSuludw5tAdlZF1ZJSoyg==\n\n-----END CERTIFICATE-----"
first_seen: '2024-09-15T03:44:20.000000Z'
last_seen: '2024-10-26T07:20:42.000000Z'
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-d74f-42d2-8345-b25b193f6d40
company_id: '147404'
common_name: gibson.com
organization: null
organizational_unit: PLC
locality: 'North Domenic'
state: null
country: PK
serial: UNMMXSCCSHSSEO9JHMDNYN20SQZOXRTQ
not_valid_before: 20241126T205631Z
not_valid_after: 20271228T230712Z
value: "-----BEGIN CERTIFICATE-----\nghUuK0gp4YrCFgyZ4C/At314IFHxcWFHqT5KmPhkH6WM5jF70Eg8nIWh4H1N1LNp\nTWzCB3Uzc9dsldXA2WuBKwWqKIkNJm2fhWmuQjLfC+pDiJtyQ3YP/F4Tl6DSNs2Y\nmRvmI/dvEU3KPfIVzniC4xa7kH8ckdhxzSAFOL662jQdiroC4zyjPhnEMGRXkj3B\nQu7NGXafrjMrdrVJKSr7Gv2DbxoET1chUcpu9NcCQJLw/8XRWoE0SHR9VzRrOjpZ\n7RCRZeu+DKVc5AAzvoGPjP2wzXa9z03A2BqC8ETOTaMI+3QKOJmg9iTRWblw4iDS\nltyyWRLdo4nH68m1KSRkx4bO6h0SO5Q1mD0CwFXOzbo8RJ/05BdFhb9SlDjgy+a4\ne1PyPlvu1ol/ySi2xT5dSc0zKJfX1iYQhukQR1iwrSvkh/ng3jhBxpOa1+ugAgO7\nOcFxzmIVk2Lzuz0PZ9K2EljMVnv3MAy+tYLEHWt4wp7cVM+TGBZyC7j7fKWz+Nsk\no3M+0RuyCyHblVfgjF8RDWUNy03oSfkq2NE6wi3Lgd7Vmgqm2oCc2Z6RnrUUVK8n\nD05c6Z2xhLHt8Mv6TUD+w6JC15qZ/sm6apMVOb8DQuBjdJxq2gXjnCOw/BeEZPe4\n5MoSLbqByVUwiy9i0FE85pFGyleIPT2Rvg6V1nqB5ZwIK/t1peglel+HSag8mSXM\nSZZGDQ7SEnSgKB5x/7UJ6LuDaoq1vYy514PjZqWle5+Cp/rieONNra4CCvZHkw5j\n/Hy2sKnpXgkg6KcHn1Q11xy3oGy4E62gAxq9b74edQob4YZGuA5OmJrxPbz6XtmE\njlp2ZNSSvgnuQxtYVsRdaAwqPJni6cJKmYTi2D9U6ZRdWTdDyI6ZUw6X88vWUqSS\nyNwj5YoAq7qILP4UKs+ESoFkCyRZ8Jm4OSKBEzxhTpNsjT3s66ffbjKTxRpUcZd9\nm+XxEhVfv0VdBo89AVuHOsuWk8qI8WRurGbZpRJv4kJIfJGR6WqRtO82ZFGAI+v7\n5hsAsaXMGyjrs1BDGfJlm+/CuZBLC1dNi/Btg1iZ4Prlfa6r+KDQn5LxLq/lo/3e\nV+qrvzxMOaEF/kESV+W3NRS15DEWDBaXRl+DgfVOit7K4yULvT2Zavd5l4B2VMnh\nyyL9KJ0smtDrHpn5hbiecHOTQLXlRWIVVP8zaFgKC0Qkx6qbCXKzV2sGqsqE2M9F\nyqnCcOwzk1srcOg436XWYvZkBLlMPVqD9WNf+Pp78ow8zkxf66bFzo/wqc2Wjouy\nk2tUfXm3SBwcrOMcJFVME43hHO2rU9xHSlJCmQQq78+F2gmk1AUeUd3H686DEx46\nUEulUgPARum31ZjsBTDoag==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-14T02:59:07.000000Z'
last_seen: '2026-02-10T01:00:04.000000Z'
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.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: a17a46d5-d4b9-43f0-b410-0c334a8fd545
company_id: '9401673'
common_name: stokes.com
organization: 'Grant, Osinski and Schmidt'
organizational_unit: null
locality: null
state: null
country: PF
serial: 5IS1XCCURMQAVC9NGKOIUPBSYCUQKIQQ
not_valid_before: 20240714T030108Z
not_valid_after: 20261023T203514Z
value: "-----BEGIN CERTIFICATE-----\ns0NF5/Xn7SA4jL26JlHxsAqz3wXuGnH3LBhSg4lXLlskcq3UiwewssFAFlDVyN92\nMhlNavXKpO8YCyduAtNsm1+fPZVG7rCkKQmNJfxseWgms4k43BM3FUvEfdgzBsIF\nJvl0qohS4EQKZoeqT9XEHqJ1Mcdl6V8T54q2jOw4wUgIUWFdQJqHc6zh3ZQX/k7f\nndumnSjg/jzF8fowyWsTRy14p/lsjYz+tCYPTYP7doO3s0bFXsHjm5oEUvIVAP5r\nZp6OqC/VIgoWKCSGxuUaXFlOMOgoMp8+r39ZudnMPJcxIkJ2xONTsA0Fbk3UmDIJ\nqBzSF78jfL+PwpHRa3ZptcP9IA+aSpoGTEc8nfQubsE63RMOhn3HABvQ4IiAVtQl\nZPLJ/dpBEW/PTmeso8lkwJti7jkgcloU2aQKaBV0fR6ldu1fWgz3tV4IcZeyEBrj\nLdS3N7WWrmgciLEtZLJAphW6e5ZpZ457ClXJddWuOauZ4fzdNj2+iaOacMe0Dye6\npce3sUdoGfbXncIzi3mgZ82RnLs4hcs/EzZWa5IbZQtHhL8NlQxM3riEHFSkqRbu\nEV7KNVjJT+DzTwN+MAwigu5B5/CWfe+kKbsyCY+g04Szj4TtIOmqp0yuI+gud12q\nAjiCN0eJKYhroBa5ZNbtoEJk0IVHTqWudSQqt5nhWHcAqbUA9eq8yiF6GVNp622m\nW8d4J+PJ8yEKVhCP4P12t7nfwvNbuZ9TF4rhRLMRBowGEJ/QfUOO9dEGDaqBrd42\nQx1LF+3e7oUNWSSkVHL/lHwafP4iiilafSXqtczTNU1BfUxt4Cau+2j8h/39xi+X\nY9IHE1IBqJ7ocKvOSGrQKG90RR1Qh6ue1YIWIsuDxRrJ2ofFuUqK+ti9oumpViPE\nL49D+lLZVzUyoG4ua020cTXLt6hoFUy6URn/U7pGuXYKozSTPT/7DVXPqztCh7sP\nCELzPAJo+9mGEfDPYx9SAor3LHpe9xEVwikpON7tf7Zv0ZCLiDjxuSF9ybHKMxTi\n+ckMj0yd/mtvc96MK/29ki8xlGSMn11q3Cy3WxDofv45T7rfb8hM+A4+FOEKnNPd\nazZL/QGkmwvHA0xRsMg8vpq+aVWFoO/ykAcjYrBDjM6kpgqU6t3VU31N7p0yUj4X\n7+jvfQMcu6fqRciazgYQEqWfKeROk0hJD6HlKy1oXRwo+n32I1JZCAUktXtG0CyX\nSMhQTuNvMu4oNdx5d2Kucxa1kGRhkC8Y+LYQpPewf5yiNOGPCw/gLh/sBzFRlJQR\nN+UlcK8YkiHROL8cseJuh4xkgCtBUnAql9ZN5c0jl52O2Z8zBS9IpyoKL2duwdnX\n0zSuludw5tAdlZF1ZJSoyg==\n\n-----END CERTIFICATE-----"
first_seen: '2024-09-15T03:44:20.000000Z'
last_seen: '2024-10-26T07:20:42.000000Z'
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-d74f-42d2-8345-b25b193f6d40
company_id: '147404'
common_name: gibson.com
organization: null
organizational_unit: PLC
locality: 'North Domenic'
state: null
country: PK
serial: UNMMXSCCSHSSEO9JHMDNYN20SQZOXRTQ
not_valid_before: 20241126T205631Z
not_valid_after: 20271228T230712Z
value: "-----BEGIN CERTIFICATE-----\nghUuK0gp4YrCFgyZ4C/At314IFHxcWFHqT5KmPhkH6WM5jF70Eg8nIWh4H1N1LNp\nTWzCB3Uzc9dsldXA2WuBKwWqKIkNJm2fhWmuQjLfC+pDiJtyQ3YP/F4Tl6DSNs2Y\nmRvmI/dvEU3KPfIVzniC4xa7kH8ckdhxzSAFOL662jQdiroC4zyjPhnEMGRXkj3B\nQu7NGXafrjMrdrVJKSr7Gv2DbxoET1chUcpu9NcCQJLw/8XRWoE0SHR9VzRrOjpZ\n7RCRZeu+DKVc5AAzvoGPjP2wzXa9z03A2BqC8ETOTaMI+3QKOJmg9iTRWblw4iDS\nltyyWRLdo4nH68m1KSRkx4bO6h0SO5Q1mD0CwFXOzbo8RJ/05BdFhb9SlDjgy+a4\ne1PyPlvu1ol/ySi2xT5dSc0zKJfX1iYQhukQR1iwrSvkh/ng3jhBxpOa1+ugAgO7\nOcFxzmIVk2Lzuz0PZ9K2EljMVnv3MAy+tYLEHWt4wp7cVM+TGBZyC7j7fKWz+Nsk\no3M+0RuyCyHblVfgjF8RDWUNy03oSfkq2NE6wi3Lgd7Vmgqm2oCc2Z6RnrUUVK8n\nD05c6Z2xhLHt8Mv6TUD+w6JC15qZ/sm6apMVOb8DQuBjdJxq2gXjnCOw/BeEZPe4\n5MoSLbqByVUwiy9i0FE85pFGyleIPT2Rvg6V1nqB5ZwIK/t1peglel+HSag8mSXM\nSZZGDQ7SEnSgKB5x/7UJ6LuDaoq1vYy514PjZqWle5+Cp/rieONNra4CCvZHkw5j\n/Hy2sKnpXgkg6KcHn1Q11xy3oGy4E62gAxq9b74edQob4YZGuA5OmJrxPbz6XtmE\njlp2ZNSSvgnuQxtYVsRdaAwqPJni6cJKmYTi2D9U6ZRdWTdDyI6ZUw6X88vWUqSS\nyNwj5YoAq7qILP4UKs+ESoFkCyRZ8Jm4OSKBEzxhTpNsjT3s66ffbjKTxRpUcZd9\nm+XxEhVfv0VdBo89AVuHOsuWk8qI8WRurGbZpRJv4kJIfJGR6WqRtO82ZFGAI+v7\n5hsAsaXMGyjrs1BDGfJlm+/CuZBLC1dNi/Btg1iZ4Prlfa6r+KDQn5LxLq/lo/3e\nV+qrvzxMOaEF/kESV+W3NRS15DEWDBaXRl+DgfVOit7K4yULvT2Zavd5l4B2VMnh\nyyL9KJ0smtDrHpn5hbiecHOTQLXlRWIVVP8zaFgKC0Qkx6qbCXKzV2sGqsqE2M9F\nyqnCcOwzk1srcOg436XWYvZkBLlMPVqD9WNf+Pp78ow8zkxf66bFzo/wqc2Wjouy\nk2tUfXm3SBwcrOMcJFVME43hHO2rU9xHSlJCmQQq78+F2gmk1AUeUd3H686DEx46\nUEulUgPARum31ZjsBTDoag==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-14T02:59:07.000000Z'
last_seen: '2026-02-10T01:00:04.000000Z'
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-d4b9-43f0-b410-0c334a8fd545
company_id:
type: string
example: '9401673'
common_name:
type: string
example: stokes.com
organization:
type: string
example: 'Grant, Osinski and Schmidt'
organizational_unit:
type: string
example: null
locality:
type: string
example: null
state:
type: string
example: null
country:
type: string
example: PF
serial:
type: string
example: 5IS1XCCURMQAVC9NGKOIUPBSYCUQKIQQ
not_valid_before:
type: string
example: 20240714T030108Z
not_valid_after:
type: string
example: 20261023T203514Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\ns0NF5/Xn7SA4jL26JlHxsAqz3wXuGnH3LBhSg4lXLlskcq3UiwewssFAFlDVyN92\nMhlNavXKpO8YCyduAtNsm1+fPZVG7rCkKQmNJfxseWgms4k43BM3FUvEfdgzBsIF\nJvl0qohS4EQKZoeqT9XEHqJ1Mcdl6V8T54q2jOw4wUgIUWFdQJqHc6zh3ZQX/k7f\nndumnSjg/jzF8fowyWsTRy14p/lsjYz+tCYPTYP7doO3s0bFXsHjm5oEUvIVAP5r\nZp6OqC/VIgoWKCSGxuUaXFlOMOgoMp8+r39ZudnMPJcxIkJ2xONTsA0Fbk3UmDIJ\nqBzSF78jfL+PwpHRa3ZptcP9IA+aSpoGTEc8nfQubsE63RMOhn3HABvQ4IiAVtQl\nZPLJ/dpBEW/PTmeso8lkwJti7jkgcloU2aQKaBV0fR6ldu1fWgz3tV4IcZeyEBrj\nLdS3N7WWrmgciLEtZLJAphW6e5ZpZ457ClXJddWuOauZ4fzdNj2+iaOacMe0Dye6\npce3sUdoGfbXncIzi3mgZ82RnLs4hcs/EzZWa5IbZQtHhL8NlQxM3riEHFSkqRbu\nEV7KNVjJT+DzTwN+MAwigu5B5/CWfe+kKbsyCY+g04Szj4TtIOmqp0yuI+gud12q\nAjiCN0eJKYhroBa5ZNbtoEJk0IVHTqWudSQqt5nhWHcAqbUA9eq8yiF6GVNp622m\nW8d4J+PJ8yEKVhCP4P12t7nfwvNbuZ9TF4rhRLMRBowGEJ/QfUOO9dEGDaqBrd42\nQx1LF+3e7oUNWSSkVHL/lHwafP4iiilafSXqtczTNU1BfUxt4Cau+2j8h/39xi+X\nY9IHE1IBqJ7ocKvOSGrQKG90RR1Qh6ue1YIWIsuDxRrJ2ofFuUqK+ti9oumpViPE\nL49D+lLZVzUyoG4ua020cTXLt6hoFUy6URn/U7pGuXYKozSTPT/7DVXPqztCh7sP\nCELzPAJo+9mGEfDPYx9SAor3LHpe9xEVwikpON7tf7Zv0ZCLiDjxuSF9ybHKMxTi\n+ckMj0yd/mtvc96MK/29ki8xlGSMn11q3Cy3WxDofv45T7rfb8hM+A4+FOEKnNPd\nazZL/QGkmwvHA0xRsMg8vpq+aVWFoO/ykAcjYrBDjM6kpgqU6t3VU31N7p0yUj4X\n7+jvfQMcu6fqRciazgYQEqWfKeROk0hJD6HlKy1oXRwo+n32I1JZCAUktXtG0CyX\nSMhQTuNvMu4oNdx5d2Kucxa1kGRhkC8Y+LYQpPewf5yiNOGPCw/gLh/sBzFRlJQR\nN+UlcK8YkiHROL8cseJuh4xkgCtBUnAql9ZN5c0jl52O2Z8zBS9IpyoKL2duwdnX\n0zSuludw5tAdlZF1ZJSoyg==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2024-09-15T03:44:20.000000Z'
last_seen:
type: string
example: '2024-10-26T07:20:42.000000Z'
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Certificates
/v1/certificates/export:
get:
summary: 'Export certificates.'
operationId: exportCertificates
description: " Export all certificates for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: 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: applications
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: applications
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: 'Successfully retrieved certificate'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-dc9a-4577-a5f3-8fb7823ce9b3
company_id: '3389963'
common_name: okuneva.net
organization: 'Rippin and Sons'
organizational_unit: null
locality: 'West Kraig'
state: California
country: BM
serial: YLB568TTGBL1O8BAUERCWX9UZJTXXACQ
not_valid_before: 20240723T012949Z
not_valid_after: 20240905T220006Z
value: "-----BEGIN CERTIFICATE-----\nwmvnxvcB9u9SHTLTxKVmtLpXGlPSwUDBlr3OBIaMEOwKl0mQ2LbygFPDeS9n8rbW\ngPzWTzQ5wyjDTHjfIv5oQtzW2acnS5TijVPLSy7GeonhxcnbSLfmmSJtPbaw7O4C\n+pl8mVI4iqGjbLeCk9U7FKHMstVlZuNiBENNElUZ28gHfpQx6GI9KDGs5jZVdGvB\nAWaHlj/AEJlbePpZc12vHAyUDW6Pv2Refyes8w0Kf9py9FunSe0enMjf73ODXtr7\nc2mipY7SlqM+8HGp0QOIBfHA0QOCg8Y0PTEh02GNdS3OnuJkiSqhCjMQOvB6ygnq\n1RW5DL8oE8AP8J+lwukwDw9M88Eqn/Z/K2p+uKzYwlqWo3KeSBrX1uL/y0WjqSfc\ni9aoKBaO8ae01Aqb06bRlmD96ZJaM5RzzBmJRWNdf6OQaL9c2zUOp1Nwow2IEiX5\nY8Fxu3lQnZHgFZK28Wq61dbWOukVrHL3M8q3TCF5D3RjWk6+sq7BjfGUSCL2V9M1\nwP5OmwyRNojaMYR6/D+7pmi73njnfM2opePJsU2dELf9KyUHs0dKxtk3wpkkGVm5\n0kFP3cTkSfamM+1rpbITQfPfDPzN4NylwXkL16HWjXZfWst2af46PUBitAKQU2EN\ns3KoXpVL4YhRqx0jhy7VLL/bQ3LUHPxTPKILCvJVwzwwU4826x9Faj/ZX92c/SSI\nRjvJRFpAppFxF27dvir9bUZ+ry5AQkK12eevq+RKqlo+Y9VTlNtK6KgNbp+KuERJ\nIGZv++rLeNkN9WQv1WIoHF9YNCZipiJtWOUxEiM/wTBSIuGC7A5JJRsqHlrqANcU\nHOoTHJA6WlfDwhUzOw3WbGeIISFRwupaT7OYxq5CQyK7x5Uh2/SEYjR/RrizcTc/\ncGs67tKi3d2lV740J1Q9+5LCGVJHml/YkW3HcHuTLXi0OR4XMcASHnX43i6VZXsU\nzA2peJd+H/tZQIcee5YPi3K9gb02fKCXmZTpZj92H6jyrqN3He7Dd4v1mXPyP1g4\nOJVrH3Pmb42HEf9mw3zYSo7iTYFw6OKvKhO9aw7otKI7eGApSNt1pEOU2meu1TON\nYwQBdr6aLHWgOQrV6aNLlCoO8YURhfvzsxMuXrY6vvPiskoxRpswuW60uEZIYz+8\nzgKMWFkhUtdWb13qgMUlbYq1eaR6NCc6nE538zdKFKIXbEZI+nN5LfI7aXjiwWa3\nf8DlQsPSCdBNpSsy8/LGcPhjAHxz+1wrqKz9iknYani5Kk0zrHZ00pYkvjZa+fYN\n/I5pt5+lvD9/GYA8sMu0tmt6PDPdQ2m1thc2xH+xxkabBmh/JHT4X9Hisp1qW5CC\nUpZguDtAt0lOtD4RXx00jQ==\n\n-----END CERTIFICATE-----"
first_seen: '2026-02-20T15:05:12.000000Z'
last_seen: '2026-06-19T10:50:59.000000Z'
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-dc9a-4577-a5f3-8fb7823ce9b3
company_id:
type: string
example: '3389963'
common_name:
type: string
example: okuneva.net
organization:
type: string
example: 'Rippin and Sons'
organizational_unit:
type: string
example: null
locality:
type: string
example: 'West Kraig'
state:
type: string
example: California
country:
type: string
example: BM
serial:
type: string
example: YLB568TTGBL1O8BAUERCWX9UZJTXXACQ
not_valid_before:
type: string
example: 20240723T012949Z
not_valid_after:
type: string
example: 20240905T220006Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nwmvnxvcB9u9SHTLTxKVmtLpXGlPSwUDBlr3OBIaMEOwKl0mQ2LbygFPDeS9n8rbW\ngPzWTzQ5wyjDTHjfIv5oQtzW2acnS5TijVPLSy7GeonhxcnbSLfmmSJtPbaw7O4C\n+pl8mVI4iqGjbLeCk9U7FKHMstVlZuNiBENNElUZ28gHfpQx6GI9KDGs5jZVdGvB\nAWaHlj/AEJlbePpZc12vHAyUDW6Pv2Refyes8w0Kf9py9FunSe0enMjf73ODXtr7\nc2mipY7SlqM+8HGp0QOIBfHA0QOCg8Y0PTEh02GNdS3OnuJkiSqhCjMQOvB6ygnq\n1RW5DL8oE8AP8J+lwukwDw9M88Eqn/Z/K2p+uKzYwlqWo3KeSBrX1uL/y0WjqSfc\ni9aoKBaO8ae01Aqb06bRlmD96ZJaM5RzzBmJRWNdf6OQaL9c2zUOp1Nwow2IEiX5\nY8Fxu3lQnZHgFZK28Wq61dbWOukVrHL3M8q3TCF5D3RjWk6+sq7BjfGUSCL2V9M1\nwP5OmwyRNojaMYR6/D+7pmi73njnfM2opePJsU2dELf9KyUHs0dKxtk3wpkkGVm5\n0kFP3cTkSfamM+1rpbITQfPfDPzN4NylwXkL16HWjXZfWst2af46PUBitAKQU2EN\ns3KoXpVL4YhRqx0jhy7VLL/bQ3LUHPxTPKILCvJVwzwwU4826x9Faj/ZX92c/SSI\nRjvJRFpAppFxF27dvir9bUZ+ry5AQkK12eevq+RKqlo+Y9VTlNtK6KgNbp+KuERJ\nIGZv++rLeNkN9WQv1WIoHF9YNCZipiJtWOUxEiM/wTBSIuGC7A5JJRsqHlrqANcU\nHOoTHJA6WlfDwhUzOw3WbGeIISFRwupaT7OYxq5CQyK7x5Uh2/SEYjR/RrizcTc/\ncGs67tKi3d2lV740J1Q9+5LCGVJHml/YkW3HcHuTLXi0OR4XMcASHnX43i6VZXsU\nzA2peJd+H/tZQIcee5YPi3K9gb02fKCXmZTpZj92H6jyrqN3He7Dd4v1mXPyP1g4\nOJVrH3Pmb42HEf9mw3zYSo7iTYFw6OKvKhO9aw7otKI7eGApSNt1pEOU2meu1TON\nYwQBdr6aLHWgOQrV6aNLlCoO8YURhfvzsxMuXrY6vvPiskoxRpswuW60uEZIYz+8\nzgKMWFkhUtdWb13qgMUlbYq1eaR6NCc6nE538zdKFKIXbEZI+nN5LfI7aXjiwWa3\nf8DlQsPSCdBNpSsy8/LGcPhjAHxz+1wrqKz9iknYani5Kk0zrHZ00pYkvjZa+fYN\n/I5pt5+lvD9/GYA8sMu0tmt6PDPdQ2m1thc2xH+xxkabBmh/JHT4X9Hisp1qW5CC\nUpZguDtAt0lOtD4RXx00jQ==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2026-02-20T15:05:12.000000Z'
last_seen:
type: string
example: '2026-06-19T10:50:59.000000Z'
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.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: id
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: Modbus
required: false
schema:
type: string
description: 'Filter by sensor type'
example: Modbus
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: a17a46d5-8185-4f03-aab9-68e4a5817650
company_id: b655e546-6ada-49a6-9489-2d1c7f6e9d20
src_ip: 211.253.129.247
dst_ip: 2.24.228.103
sensor: Modbus
timestamp: '2025-01-25T20:21:16.000000Z'
marked_as_seen: true
honeypot_id: c0e2122a-30d5-44db-8dbb-3966db5049ce
honeypot_alias: Honeypot-Office-67
src_port: null
src_hostname: 'Kshlerin, Parisian and Adams'
src_mac: '1F:19:75:1B:28:24'
dst_port: 16964
-
id: a17a46d5-87c4-4c8b-8adf-98e148a3523d
company_id: a6e5762b-223e-421d-b969-89ef69a5576d
src_ip: 18.54.67.135
dst_ip: 78.20.125.9
sensor: Modbus
timestamp: '2025-07-03T03:21:44.000000Z'
marked_as_seen: false
honeypot_id: ce929507-007d-4c34-99dd-9286a6f304aa
honeypot_alias: Honeypot-Datacenter-93
src_port: null
src_hostname: null
src_mac: null
dst_port: 21577
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: a17a46d5-8185-4f03-aab9-68e4a5817650
company_id: b655e546-6ada-49a6-9489-2d1c7f6e9d20
src_ip: 211.253.129.247
dst_ip: 2.24.228.103
sensor: Modbus
timestamp: '2025-01-25T20:21:16.000000Z'
marked_as_seen: true
honeypot_id: c0e2122a-30d5-44db-8dbb-3966db5049ce
honeypot_alias: Honeypot-Office-67
src_port: null
src_hostname: 'Kshlerin, Parisian and Adams'
src_mac: '1F:19:75:1B:28:24'
dst_port: 16964
-
id: a17a46d5-87c4-4c8b-8adf-98e148a3523d
company_id: a6e5762b-223e-421d-b969-89ef69a5576d
src_ip: 18.54.67.135
dst_ip: 78.20.125.9
sensor: Modbus
timestamp: '2025-07-03T03:21:44.000000Z'
marked_as_seen: false
honeypot_id: ce929507-007d-4c34-99dd-9286a6f304aa
honeypot_alias: Honeypot-Datacenter-93
src_port: null
src_hostname: null
src_mac: null
dst_port: 21577
items:
type: object
properties:
id:
type: string
example: a17a46d5-8185-4f03-aab9-68e4a5817650
company_id:
type: string
example: b655e546-6ada-49a6-9489-2d1c7f6e9d20
src_ip:
type: string
example: 211.253.129.247
dst_ip:
type: string
example: 2.24.228.103
sensor:
type: string
example: Modbus
timestamp:
type: string
example: '2025-01-25T20:21:16.000000Z'
marked_as_seen:
type: boolean
example: true
honeypot_id:
type: string
example: c0e2122a-30d5-44db-8dbb-3966db5049ce
honeypot_alias:
type: string
example: Honeypot-Office-67
src_port:
type: string
example: null
src_hostname:
type: string
example: 'Kshlerin, Parisian and Adams'
src_mac:
type: string
example: '1F:19:75:1B:28:24'
dst_port:
type: integer
example: 16964
required:
- id
- company_id
- src_ip
- dst_ip
- sensor
- timestamp
- marked_as_seen
- honeypot_id
- honeypot_alias
- src_port
- src_hostname
- src_mac
- dst_port
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Detections
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
properties:
search:
type: string
description: 'Must not be greater than 255 characters.'
example: mv
sensor:
type: string
description: ''
example: null
honeypot_id:
type: string
description: 'Must be a valid UUID.'
example: ed3d25c2-ab22-350c-a728-17574dd314b4
honeypot_alias:
type: string
description: 'Must not be greater than 255 characters.'
example: mdwjedtffjxnhseh
src_ip:
type: string
description: 'Must not be greater than 255 characters.'
example: hjpganpfdoujfeqrvvmyh
src_hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: ycsxatorbgug
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: 89
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: a17a46d5-8185-4f03-aab9-68e4a5817650
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: officiis
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: 7633350a-f6ad-40fa-874a-50cc077c4b16
alias: Honeypot-HQ-67
status: 1
activation_status: 1
hostname: honeypot-djyp-942.example.com
slane_enabled: true
slane_connected: false
paired: true
provisioned: false
dns1: 158.238.35.28
dns2: 62.15.96.153
configured_as: null
notes: null
checked_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 7633350a-f6ad-40fa-874a-50cc077c4b16
alias:
type: string
example: Honeypot-HQ-67
status:
type: integer
example: 1
activation_status:
type: integer
example: 1
hostname:
type: string
example: honeypot-djyp-942.example.com
slane_enabled:
type: boolean
example: true
slane_connected:
type: boolean
example: false
paired:
type: boolean
example: true
provisioned:
type: boolean
example: false
dns1:
type: string
example: 158.238.35.28
dns2:
type: string
example: 62.15.96.153
configured_as:
type: string
example: null
notes:
type: string
example: null
checked_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
required:
- id
- alias
- status
- activation_status
- hostname
- slane_enabled
- slane_connected
- paired
- provisioned
- dns1
- dns2
- configured_as
- notes
- checked_at
- created_at
- updated_at
tags:
- Honeypots
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
alias:
type: string
description: 'Alias is used to identify the Honeypot (not visible to the attacker).'
example: 'Internal Honeypot'
required:
- alias
/v1/integrations:
get:
summary: 'List Integrations'
operationId: listIntegrations
description: "Retrieve all enabled integrations for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '[{"autotask": {...}, "another_integration": {...}}]'
tags:
- Integrations
'/v1/integrations/{integration}':
post:
summary: 'Enable Integration'
operationId: enableIntegration
description: "Enable a new integration for the current company.\n"
parameters: []
responses:
201:
description: 'integration enabled'
content:
application/json:
schema:
type: object
example:
message: 'Integration enabled successfully'
properties:
message:
type: string
example: 'Integration enabled successfully'
400:
description: 'enable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to enable integration'
properties:
error:
type: string
example: 'Failed to enable integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
get:
summary: 'Show Integration'
operationId: showIntegration
description: "Retrieve details of a specific enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'integration not found'
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
-
description: 'integration not enabled'
type: object
example:
error: 'Integration not enabled'
properties:
error:
type: string
example: 'Integration not enabled'
tags:
- Integrations
patch:
summary: 'Update Integration'
operationId: updateIntegration
description: "Update the configuration of an enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
message: 'Integration updated successfully'
properties:
message:
type: string
example: 'Integration updated successfully'
400:
description: 'update failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to update integration'
properties:
error:
type: string
example: 'Failed to update integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
delete:
summary: 'Disable Integration'
operationId: disableIntegration
description: "Disable a specific integration for the current company.\n"
parameters: []
responses:
204:
description: 'disable successful'
content:
text/plain:
schema:
type: string
example: ''
400:
description: 'disable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to disable integration'
properties:
error:
type: string
example: 'Failed to disable integration'
tags:
- Integrations
parameters:
-
in: path
name: integration
description: 'The name of the integration to enable.'
example: autotask
required: true
schema:
type: string
/v1/me:
get:
summary: 'Retrieve the authenticated user'
operationId: retrieveTheAuthenticatedUser
description: 'Retrieves the authenticated user and its metadata.'
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: 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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 0d33dbda-7d3f-45ae-a904-0d4eec8585a6
company_id: '1910128'
managing_company_id: '1910128'
first_name: Jaylon
last_name: Reinger
two_factor_enabled: false
two_factor_configured: false
email: cristina.franecki@gmail.com
email_verified_at: '2026-04-06T08:51:04Z'
phonenumber: '(224) 731-4052'
phonenumber_verified_at: '2026-04-06T08:51:04Z'
report_interval: weekly
manageable_companies:
-
id: '1910128'
uuid: 31dcf3a6-850a-483f-aa22-01b7c4232451
name: Lynch-Goyette
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2026-04-06T08:51:04Z'
sso_provider: null
created_at: '2026-04-06T08:51:04Z'
updated_at: '2026-04-06T08:51:04Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: 0d33dbda-7d3f-45ae-a904-0d4eec8585a6
company_id:
type: string
example: '1910128'
managing_company_id:
type: string
example: '1910128'
first_name:
type: string
example: Jaylon
last_name:
type: string
example: Reinger
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: cristina.franecki@gmail.com
email_verified_at:
type: string
example: '2026-04-06T08:51:04Z'
phonenumber:
type: string
example: '(224) 731-4052'
phonenumber_verified_at:
type: string
example: '2026-04-06T08:51:04Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '1910128'
uuid: 31dcf3a6-850a-483f-aa22-01b7c4232451
name: Lynch-Goyette
items:
type: object
properties:
id:
type: string
example: '1910128'
uuid:
type: string
example: 31dcf3a6-850a-483f-aa22-01b7c4232451
name:
type: string
example: Lynch-Goyette
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-04-06T08:51:04Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04Z'
updated_at:
type: string
example: '2026-04-06T08:51:04Z'
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-04-06T08:51:04'
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: dicta
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: dicta
-
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: created_at
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=business_impact'
description: ''
example: created_at
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: a17a46d5-e362-495a-898a-ffea1348fe90
company_id: '8636420'
name: 88d0c42d-2e81-3088-bac0-da52d9107437
description: 'Sint ullam voluptatem itaque illum. Tempora dolorem et nisi ipsum eligendi voluptates rem. Adipisci quam consequatur tempora ut quidem facere. Enim dolorem repellat iusto fugiat.'
business_impact: medium
system_tag: true
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-e5c8-43c9-ae53-8f046d481f4c
company_id: '3235480'
name: e52271b2-d8e6-3963-86bf-2e34a307222d
description: 'Laudantium voluptatem dignissimos numquam dicta. Hic perspiciatis sed voluptatem. Ut praesentium nulla sit. Doloribus sed vero sequi.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.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: a17a46d5-e362-495a-898a-ffea1348fe90
company_id: '8636420'
name: 88d0c42d-2e81-3088-bac0-da52d9107437
description: 'Sint ullam voluptatem itaque illum. Tempora dolorem et nisi ipsum eligendi voluptates rem. Adipisci quam consequatur tempora ut quidem facere. Enim dolorem repellat iusto fugiat.'
business_impact: medium
system_tag: true
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
-
id: a17a46d5-e5c8-43c9-ae53-8f046d481f4c
company_id: '3235480'
name: e52271b2-d8e6-3963-86bf-2e34a307222d
description: 'Laudantium voluptatem dignissimos numquam dicta. Hic perspiciatis sed voluptatem. Ut praesentium nulla sit. Doloribus sed vero sequi.'
business_impact: low
system_tag: false
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-e362-495a-898a-ffea1348fe90
company_id:
type: string
example: '8636420'
name:
type: string
example: 88d0c42d-2e81-3088-bac0-da52d9107437
description:
type: string
example: 'Sint ullam voluptatem itaque illum. Tempora dolorem et nisi ipsum eligendi voluptates rem. Adipisci quam consequatur tempora ut quidem facere. Enim dolorem repellat iusto fugiat.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Tags
post:
summary: 'Create tag.'
operationId: createTag
description: "Will create a new tag for the current company. \n "
parameters: []
responses:
201:
description: 'Successfully created tag'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-ea48-4c47-8565-d9348c89c809
company_id: '3220893'
name: 30040281-0178-387f-8e3a-79bb3d733037
description: 'Et ut aut libero eveniet aut. Id similique sed voluptates. Eligendi corrupti quia optio et quis ab perferendis.'
business_impact: medium
system_tag: false
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-ea48-4c47-8565-d9348c89c809
company_id:
type: string
example: '3220893'
name:
type: string
example: 30040281-0178-387f-8e3a-79bb3d733037
description:
type: string
example: 'Et ut aut libero eveniet aut. Id similique sed voluptates. Eligendi corrupti quia optio et quis ab perferendis.'
business_impact:
type: string
example: medium
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.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: gitavwocetfhzdpbaadn
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Repellat autem enim velit dolores dolores.'
business_impact:
type: string
description: ''
example: medium
enum:
- low
- medium
- high
- critical
required:
- name
- description
- business_impact
'/v1/tags/{id}':
get:
summary: 'Retrieve a tag.'
operationId: retrieveATag
description: " Retrieves an tag by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
enum:
- assets
responses:
200:
description: 'Successfully retrieved tag'
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-ed97-4ff2-82c5-a3795e994cc0
company_id: '2757565'
name: a7976013-6352-32f6-88c2-6a2f4ffb17fa
description: 'Et qui rem libero dolores. Beatae et vero quisquam est aliquam est ut. Ad id sequi tenetur provident hic blanditiis est.'
business_impact: high
system_tag: false
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-ed97-4ff2-82c5-a3795e994cc0
company_id:
type: string
example: '2757565'
name:
type: string
example: a7976013-6352-32f6-88c2-6a2f4ffb17fa
description:
type: string
example: 'Et qui rem libero dolores. Beatae et vero quisquam est aliquam est ut. Ad id sequi tenetur provident hic blanditiis est.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: false
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.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: a17a46d5-f169-4c01-b515-3579c805de00
company_id: '3555315'
name: 16660858-8e58-3b00-a0e2-3e18a0bdcb55
description: 'Enim sit omnis sed laudantium sed necessitatibus. Quibusdam ut sint illum quaerat. Consequatur eveniet veniam explicabo inventore neque voluptas delectus.'
business_impact: low
system_tag: true
asset_count: 0
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-f169-4c01-b515-3579c805de00
company_id:
type: string
example: '3555315'
name:
type: string
example: 16660858-8e58-3b00-a0e2-3e18a0bdcb55
description:
type: string
example: 'Enim sit omnis sed laudantium sed necessitatibus. Quibusdam ut sint illum quaerat. Consequatur eveniet veniam explicabo inventore neque voluptas delectus.'
business_impact:
type: string
example: low
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.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: ibytzccvfepi
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Officiis at totam impedit hic impedit fugit eveniet quos.'
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: et
required: true
schema:
type: string
/v1/users:
get:
summary: 'List Users'
operationId: listUsers
description: "Retrieve all users for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany
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: 94e73e44-499d-4805-99df-6107c3d166bd
company_id: '6772728'
managing_company_id: '6772728'
first_name: Madge
last_name: Borer
two_factor_enabled: false
email: ajenkins@hotmail.com
email_verified_at: '2026-04-06T08:51:05.000000Z'
phonenumber: 803-424-2882
phonenumber_verified_at: '2026-04-06T08:51:05.000000Z'
report_interval: weekly
manageable_companies:
-
id: '6772728'
uuid: 8745c228-7324-4a8f-8529-d6808ccf93c2
name: Luettgen-Emmerich
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-04-06T08:51:05.000000Z'
sso_provider: null
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
last_login_at: null
-
id: 8c94e237-f856-4733-a2c5-793db83cf311
company_id: '455754'
managing_company_id: '455754'
first_name: Jocelyn
last_name: Harber
two_factor_enabled: false
email: ulices.nitzsche@beier.net
email_verified_at: '2026-04-06T08:51:05.000000Z'
phonenumber: 628.528.0823
phonenumber_verified_at: '2026-04-06T08:51:05.000000Z'
report_interval: weekly
manageable_companies:
-
id: '455754'
uuid: e8bd4c9b-c545-449b-be80-ae98154be5c1
name: Heathcote-Welch
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-04-06T08:51:05.000000Z'
sso_provider: null
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.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: 94e73e44-499d-4805-99df-6107c3d166bd
company_id: '6772728'
managing_company_id: '6772728'
first_name: Madge
last_name: Borer
two_factor_enabled: false
email: ajenkins@hotmail.com
email_verified_at: '2026-04-06T08:51:05.000000Z'
phonenumber: 803-424-2882
phonenumber_verified_at: '2026-04-06T08:51:05.000000Z'
report_interval: weekly
manageable_companies:
-
id: '6772728'
uuid: 8745c228-7324-4a8f-8529-d6808ccf93c2
name: Luettgen-Emmerich
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-04-06T08:51:05.000000Z'
sso_provider: null
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
last_login_at: null
-
id: 8c94e237-f856-4733-a2c5-793db83cf311
company_id: '455754'
managing_company_id: '455754'
first_name: Jocelyn
last_name: Harber
two_factor_enabled: false
email: ulices.nitzsche@beier.net
email_verified_at: '2026-04-06T08:51:05.000000Z'
phonenumber: 628.528.0823
phonenumber_verified_at: '2026-04-06T08:51:05.000000Z'
report_interval: weekly
manageable_companies:
-
id: '455754'
uuid: e8bd4c9b-c545-449b-be80-ae98154be5c1
name: Heathcote-Welch
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-04-06T08:51:05.000000Z'
sso_provider: null
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
last_login_at: null
items:
type: object
properties:
id:
type: string
example: 94e73e44-499d-4805-99df-6107c3d166bd
company_id:
type: string
example: '6772728'
managing_company_id:
type: string
example: '6772728'
first_name:
type: string
example: Madge
last_name:
type: string
example: Borer
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: ajenkins@hotmail.com
email_verified_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
phonenumber:
type: string
example: 803-424-2882
phonenumber_verified_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '6772728'
uuid: 8745c228-7324-4a8f-8529-d6808ccf93c2
name: Luettgen-Emmerich
items:
type: object
properties:
id:
type: string
example: '6772728'
uuid:
type: string
example: 8745c228-7324-4a8f-8529-d6808ccf93c2
name:
type: string
example: Luettgen-Emmerich
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
last_login_at:
type: string
example: null
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- 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: xytvjrkwobalsfalqoov
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: zstyivxvfhbaqegh
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: stephania66@example.com
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: ''
example: weekly
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: 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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: d410934b-5f8d-4e0c-ac9b-6c33384fc168
company_id: '434984'
managing_company_id: '434984'
first_name: Eriberto
last_name: Grant
two_factor_enabled: false
email: halvorson.mayra@friesen.com
email_verified_at: '2026-04-06T08:51:05.000000Z'
phonenumber: 1-951-953-2611
phonenumber_verified_at: '2026-04-06T08:51:05.000000Z'
report_interval: weekly
manageable_companies:
-
id: '434984'
uuid: d90c4851-bac3-473a-9e3f-d63b0d26aa5b
name: 'Jones, Torp and Jacobi'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-04-06T08:51:05.000000Z'
sso_provider: null
created_at: '2026-04-06T08:51:05.000000Z'
updated_at: '2026-04-06T08:51:05.000000Z'
last_login_at: null
properties:
data:
type: object
properties:
id:
type: string
example: d410934b-5f8d-4e0c-ac9b-6c33384fc168
company_id:
type: string
example: '434984'
managing_company_id:
type: string
example: '434984'
first_name:
type: string
example: Eriberto
last_name:
type: string
example: Grant
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: halvorson.mayra@friesen.com
email_verified_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
phonenumber:
type: string
example: 1-951-953-2611
phonenumber_verified_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '434984'
uuid: d90c4851-bac3-473a-9e3f-d63b0d26aa5b
name: 'Jones, Torp and Jacobi'
items:
type: object
properties:
id:
type: string
example: '434984'
uuid:
type: string
example: d90c4851-bac3-473a-9e3f-d63b0d26aa5b
name:
type: string
example: 'Jones, Torp and Jacobi'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
sso_provider:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:05.000000Z'
last_login_at:
type: string
example: null
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: d468b64c-5286-3334-a638-8da711dd3112
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: Detected
required: false
schema:
type: 'Filter vulnerabilities by their status'
description: ''
example: Detected
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
-
in: query
name: 'filter[threat]'
description: ''
example: Critical
required: false
schema:
type: 'Filter vulnerabilities by their threat level'
description: ''
example: Critical
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: name
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: name
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a17a46d5-9ee1-496a-b4a8-af9d452ed2c1
asset_id: a17a46d5-94d5-433b-9efa-284fae3a61d6
company_id: '8845855'
vulnerability_definition_id: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
vulnerability_definition:
id: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
name: '10 exploitable through fugit manipulation'
description: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
solution: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
category: '10'
threat_level: Medium
definition_type: openvas
definition:
id: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name: '10 exploitable through fugit manipulation'
family: '10'
reference_urls: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves: 'CVE-2023-3119, CVE-2019-1854'
solution_type: WorkAround
solution_description: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority: Log
qod_type: registry
qod_value: 32
cvss_base_score: 2.9
cvss_base_vector: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
epss: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
host: 34.131.122.99
hostname: schaden.com
port: 34308/tcp
details: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
status: Accepted
first_seen: '2025-11-25T15:28:14.000000Z'
last_seen: '2026-01-15T07:59:42.000000Z'
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
name: '10 exploitable through fugit manipulation'
description: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
cvss_base_score: 2.9
cvss_base_vector: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
qod_type: registry
qod_value: 32
threat: Medium
scanner_id: null
scanner_hostname: null
plugin:
id: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name: '10 exploitable through fugit manipulation'
family: '10'
reference_urls: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves: 'CVE-2023-3119, CVE-2019-1854'
solution_type: WorkAround
solution_description: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority: Log
qod_type: registry
qod_value: 32
-
id: a17a46d5-a5bd-4342-85b8-3997b65cf15d
asset_id: a17a46d5-a1fc-46b3-bd92-dbd06a7c6551
company_id: '4523355'
vulnerability_definition_id: a17a46d5-a550-4798-91c3-532f80279543
vulnerability_definition:
id: a17a46d5-a550-4798-91c3-532f80279543
name: 'Remote File Inclusion via earum input'
description: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
solution: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
category: 'Remote File Inclusion'
threat_level: Critical
definition_type: openvas
definition:
id: a17a46d5-a448-429e-b524-20e4ed841ccd
o_id: 22f44bc3-3a4c-3519-ad23-149aedaeff52
name: 'Remote File Inclusion via earum input'
family: 'Remote File Inclusion'
reference_urls: 'https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/'
reference_cves: 'CVE-2018-9829, CVE-2016-6699'
solution_type: 'Configuration Change'
solution_description: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
summary: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
insight: 'Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.'
affected: 'Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.'
impact: 'Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.'
vuldetect: 'Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.'
priority: Critical
qod_type: exploit
qod_value: 89
cvss_base_score: 9.6
cvss_base_vector: 'AV:N/AC:H/Au:N/C:N/I:P/A:P'
epss: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
host: 63.77.140.175
hostname: schulist.info
port: 25/tcp
details: 'Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.'
status: Resolved
first_seen: '2026-01-13T15:52:23.000000Z'
last_seen: '2026-02-26T15:04:44.000000Z'
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
name: 'Remote File Inclusion via earum input'
description: 'Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.'
cvss_base_score: 9.6
cvss_base_vector: 'AV:N/AC:H/Au:N/C:N/I:P/A:P'
qod_type: exploit
qod_value: 89
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a17a46d5-a448-429e-b524-20e4ed841ccd
o_id: 22f44bc3-3a4c-3519-ad23-149aedaeff52
name: 'Remote File Inclusion via earum input'
family: 'Remote File Inclusion'
reference_urls: 'https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/'
reference_cves: 'CVE-2018-9829, CVE-2016-6699'
solution_type: 'Configuration Change'
solution_description: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
summary: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
insight: 'Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.'
affected: 'Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.'
impact: 'Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.'
vuldetect: 'Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.'
priority: Critical
qod_type: exploit
qod_value: 89
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: a17a46d5-9ee1-496a-b4a8-af9d452ed2c1
asset_id: a17a46d5-94d5-433b-9efa-284fae3a61d6
company_id: '8845855'
vulnerability_definition_id: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
vulnerability_definition:
id: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
name: '10 exploitable through fugit manipulation'
description: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
solution: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
category: '10'
threat_level: Medium
definition_type: openvas
definition:
id: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name: '10 exploitable through fugit manipulation'
family: '10'
reference_urls: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves: 'CVE-2023-3119, CVE-2019-1854'
solution_type: WorkAround
solution_description: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority: Log
qod_type: registry
qod_value: 32
cvss_base_score: 2.9
cvss_base_vector: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
epss: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
host: 34.131.122.99
hostname: schaden.com
port: 34308/tcp
details: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
status: Accepted
first_seen: '2025-11-25T15:28:14.000000Z'
last_seen: '2026-01-15T07:59:42.000000Z'
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
name: '10 exploitable through fugit manipulation'
description: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
cvss_base_score: 2.9
cvss_base_vector: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
qod_type: registry
qod_value: 32
threat: Medium
scanner_id: null
scanner_hostname: null
plugin:
id: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name: '10 exploitable through fugit manipulation'
family: '10'
reference_urls: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves: 'CVE-2023-3119, CVE-2019-1854'
solution_type: WorkAround
solution_description: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority: Log
qod_type: registry
qod_value: 32
-
id: a17a46d5-a5bd-4342-85b8-3997b65cf15d
asset_id: a17a46d5-a1fc-46b3-bd92-dbd06a7c6551
company_id: '4523355'
vulnerability_definition_id: a17a46d5-a550-4798-91c3-532f80279543
vulnerability_definition:
id: a17a46d5-a550-4798-91c3-532f80279543
name: 'Remote File Inclusion via earum input'
description: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
solution: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
category: 'Remote File Inclusion'
threat_level: Critical
definition_type: openvas
definition:
id: a17a46d5-a448-429e-b524-20e4ed841ccd
o_id: 22f44bc3-3a4c-3519-ad23-149aedaeff52
name: 'Remote File Inclusion via earum input'
family: 'Remote File Inclusion'
reference_urls: 'https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/'
reference_cves: 'CVE-2018-9829, CVE-2016-6699'
solution_type: 'Configuration Change'
solution_description: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
summary: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
insight: 'Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.'
affected: 'Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.'
impact: 'Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.'
vuldetect: 'Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.'
priority: Critical
qod_type: exploit
qod_value: 89
cvss_base_score: 9.6
cvss_base_vector: 'AV:N/AC:H/Au:N/C:N/I:P/A:P'
epss: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
host: 63.77.140.175
hostname: schulist.info
port: 25/tcp
details: 'Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.'
status: Resolved
first_seen: '2026-01-13T15:52:23.000000Z'
last_seen: '2026-02-26T15:04:44.000000Z'
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
name: 'Remote File Inclusion via earum input'
description: 'Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.'
cvss_base_score: 9.6
cvss_base_vector: 'AV:N/AC:H/Au:N/C:N/I:P/A:P'
qod_type: exploit
qod_value: 89
threat: Critical
scanner_id: null
scanner_hostname: null
plugin:
id: a17a46d5-a448-429e-b524-20e4ed841ccd
o_id: 22f44bc3-3a4c-3519-ad23-149aedaeff52
name: 'Remote File Inclusion via earum input'
family: 'Remote File Inclusion'
reference_urls: 'https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/'
reference_cves: 'CVE-2018-9829, CVE-2016-6699'
solution_type: 'Configuration Change'
solution_description: 'Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.'
summary: 'Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.'
insight: 'Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.'
affected: 'Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.'
impact: 'Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.'
vuldetect: 'Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.'
priority: Critical
qod_type: exploit
qod_value: 89
items:
type: object
properties:
id:
type: string
example: a17a46d5-9ee1-496a-b4a8-af9d452ed2c1
asset_id:
type: string
example: a17a46d5-94d5-433b-9efa-284fae3a61d6
company_id:
type: string
example: '8845855'
vulnerability_definition_id:
type: string
example: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
vulnerability_definition:
type: object
properties:
id:
type: string
example: a17a46d5-9e1d-4ca3-b870-da7dd46efcef
name:
type: string
example: '10 exploitable through fugit manipulation'
description:
type: string
example: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
solution:
type: string
example: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
category:
type: string
example: '10'
threat_level:
type: string
example: Medium
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id:
type: string
example: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name:
type: string
example: '10 exploitable through fugit manipulation'
family:
type: string
example: '10'
reference_urls:
type: string
example: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves:
type: string
example: 'CVE-2023-3119, CVE-2019-1854'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary:
type: string
example: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight:
type: string
example: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected:
type: string
example: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact:
type: string
example: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect:
type: string
example: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority:
type: string
example: Log
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 32
cvss_base_score:
type: number
example: 2.9
cvss_base_vector:
type: string
example: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
epss:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
host:
type: string
example: 34.131.122.99
hostname:
type: string
example: schaden.com
port:
type: string
example: 34308/tcp
details:
type: string
example: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
status:
type: string
example: Accepted
first_seen:
type: string
example: '2025-11-25T15:28:14.000000Z'
last_seen:
type: string
example: '2026-01-15T07:59:42.000000Z'
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
name:
type: string
example: '10 exploitable through fugit manipulation'
description:
type: string
example: 'Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.'
cvss_base_score:
type: number
example: 2.9
cvss_base_vector:
type: string
example: 'AV:P/AC:L/Au:S/C:P/I:P/A:P'
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 32
threat:
type: string
example: Medium
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: a17a46d5-9bec-408a-8927-ef0ee111e503
o_id:
type: string
example: c35cd687-b3a6-3500-8a6a-ac9df7aa0a84
name:
type: string
example: '10 exploitable through fugit manipulation'
family:
type: string
example: '10'
reference_urls:
type: string
example: 'http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in'
reference_cves:
type: string
example: 'CVE-2023-3119, CVE-2019-1854'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.'
summary:
type: string
example: 'Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.'
insight:
type: string
example: 'Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.'
affected:
type: string
example: 'Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.'
impact:
type: string
example: 'Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.'
vuldetect:
type: string
example: 'Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.'
priority:
type: string
example: Log
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 32
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Vulnerabilities
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: hjcbuwpsyujcbjxnkbvlijzmf
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: opopichwmdkmywyfkqgcmk
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: ptggbfniyuah
status:
type: string
description: ''
example: Expired
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: 4d35bfd8-69d7-3b27-9b6d-95c2014efe32
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 19
'/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: a17a46d5-b2c8-49ea-a73e-28db8507f8f0
asset_id: a17a46d5-aef7-4326-b24b-672ad4e69fd7
company_id: '9768063'
vulnerability_definition_id: a17a46d5-b25b-4a4e-997a-9ddcc441c771
vulnerability_definition:
id: a17a46d5-b25b-4a4e-997a-9ddcc441c771
name: 'Missing Function Level Access Control affecting qui functionality'
description: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
solution: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
category: 'Missing Function Level Access Control'
threat_level: Low
definition_type: openvas
definition:
id: a17a46d5-b15d-48d2-a750-c897c69487d6
o_id: 86685fc5-a1c8-327d-b1f9-af0dc4645cd3
name: 'Missing Function Level Access Control affecting qui functionality'
family: 'Missing Function Level Access Control'
reference_urls: 'http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/'
reference_cves: 'CVE-2018-4250, CVE-2016-7547'
solution_type: Mitigation
solution_description: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
summary: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
insight: 'Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.'
affected: 'Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.'
impact: 'Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.'
vuldetect: 'Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.'
priority: High
qod_type: package
qod_value: 72
cvss_base_score: 4.9
cvss_base_vector: 'AV:N/AC:H/Au:M/C:P/I:C/A:N'
epss: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
host: 47.188.19.65
hostname: kilback.com
port: 3306/tcp
details: 'Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.'
status: Expired
first_seen: '2025-11-28T03:06:12.000000Z'
last_seen: '2026-01-02T21:36:10.000000Z'
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
name: 'Missing Function Level Access Control affecting qui functionality'
description: 'Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.'
cvss_base_score: 4.9
cvss_base_vector: 'AV:N/AC:H/Au:M/C:P/I:C/A:N'
qod_type: package
qod_value: 72
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a17a46d5-b15d-48d2-a750-c897c69487d6
o_id: 86685fc5-a1c8-327d-b1f9-af0dc4645cd3
name: 'Missing Function Level Access Control affecting qui functionality'
family: 'Missing Function Level Access Control'
reference_urls: 'http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/'
reference_cves: 'CVE-2018-4250, CVE-2016-7547'
solution_type: Mitigation
solution_description: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
summary: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
insight: 'Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.'
affected: 'Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.'
impact: 'Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.'
vuldetect: 'Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.'
priority: High
qod_type: package
qod_value: 72
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-b2c8-49ea-a73e-28db8507f8f0
asset_id:
type: string
example: a17a46d5-aef7-4326-b24b-672ad4e69fd7
company_id:
type: string
example: '9768063'
vulnerability_definition_id:
type: string
example: a17a46d5-b25b-4a4e-997a-9ddcc441c771
vulnerability_definition:
type: object
properties:
id:
type: string
example: a17a46d5-b25b-4a4e-997a-9ddcc441c771
name:
type: string
example: 'Missing Function Level Access Control affecting qui functionality'
description:
type: string
example: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
solution:
type: string
example: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
category:
type: string
example: 'Missing Function Level Access Control'
threat_level:
type: string
example: Low
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a17a46d5-b15d-48d2-a750-c897c69487d6
o_id:
type: string
example: 86685fc5-a1c8-327d-b1f9-af0dc4645cd3
name:
type: string
example: 'Missing Function Level Access Control affecting qui functionality'
family:
type: string
example: 'Missing Function Level Access Control'
reference_urls:
type: string
example: 'http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/'
reference_cves:
type: string
example: 'CVE-2018-4250, CVE-2016-7547'
solution_type:
type: string
example: Mitigation
solution_description:
type: string
example: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
summary:
type: string
example: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
insight:
type: string
example: 'Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.'
affected:
type: string
example: 'Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.'
impact:
type: string
example: 'Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.'
vuldetect:
type: string
example: 'Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.'
priority:
type: string
example: High
qod_type:
type: string
example: package
qod_value:
type: integer
example: 72
cvss_base_score:
type: number
example: 4.9
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:M/C:P/I:C/A:N'
epss:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
host:
type: string
example: 47.188.19.65
hostname:
type: string
example: kilback.com
port:
type: string
example: 3306/tcp
details:
type: string
example: 'Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.'
status:
type: string
example: Expired
first_seen:
type: string
example: '2025-11-28T03:06:12.000000Z'
last_seen:
type: string
example: '2026-01-02T21:36:10.000000Z'
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
name:
type: string
example: 'Missing Function Level Access Control affecting qui functionality'
description:
type: string
example: 'Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.'
cvss_base_score:
type: number
example: 4.9
cvss_base_vector:
type: string
example: 'AV:N/AC:H/Au:M/C:P/I:C/A:N'
qod_type:
type: string
example: package
qod_value:
type: integer
example: 72
threat:
type: string
example: Low
scanner_id:
type: string
example: null
scanner_hostname:
type: string
example: null
plugin:
type: object
properties:
id:
type: string
example: a17a46d5-b15d-48d2-a750-c897c69487d6
o_id:
type: string
example: 86685fc5-a1c8-327d-b1f9-af0dc4645cd3
name:
type: string
example: 'Missing Function Level Access Control affecting qui functionality'
family:
type: string
example: 'Missing Function Level Access Control'
reference_urls:
type: string
example: 'http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/'
reference_cves:
type: string
example: 'CVE-2018-4250, CVE-2016-7547'
solution_type:
type: string
example: Mitigation
solution_description:
type: string
example: 'Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.'
summary:
type: string
example: 'Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.'
insight:
type: string
example: 'Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.'
affected:
type: string
example: 'Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.'
impact:
type: string
example: 'Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.'
vuldetect:
type: string
example: 'Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.'
priority:
type: string
example: High
qod_type:
type: string
example: package
qod_value:
type: integer
example: 72
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: repudiandae
required: true
schema:
type: string
/v1/webhook-events:
get:
summary: 'List all webhook events'
operationId: listAllWebhookEvents
description: "Lists all webhook events for the authenticated user's company.\n"
parameters:
-
in: query
name: sort
description: 'Sort the results by column(s) (comma separated).'
example: status
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: status
enum:
- webhook_id
- event
- status
- next_retry_at
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: webhook_id
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: webhook_id
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a17a46d5-60ef-48a9-b37c-cfc65e545c01
webhook_id: a17a46d5-6027-4bbd-9491-98875f9563d6
event: similique
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
-
id: a17a46d5-6489-431a-aaa4-c89f43307770
webhook_id: a17a46d5-63bd-4410-8c2c-534971f52ade
event: maxime
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.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: a17a46d5-60ef-48a9-b37c-cfc65e545c01
webhook_id: a17a46d5-6027-4bbd-9491-98875f9563d6
event: similique
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
-
id: a17a46d5-6489-431a-aaa4-c89f43307770
webhook_id: a17a46d5-63bd-4410-8c2c-534971f52ade
event: maxime
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-60ef-48a9-b37c-cfc65e545c01
webhook_id:
type: string
example: a17a46d5-6027-4bbd-9491-98875f9563d6
event:
type: string
example: similique
payload:
type: object
properties:
key:
type: string
example: value
status:
type: string
example: pending
retries:
type: integer
example: 0
next_retry_at:
type: string
example: null
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- 'Webhook Events'
/v1/webhook-events/types:
get:
summary: 'List all available webhook event types'
operationId: listAllAvailableWebhookEventTypes
description: "Lists all webhook event types that can be used.\n"
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Webhook Events'
'/v1/webhook-events/{webhookEvent_id}':
get:
summary: 'Retrieve an webhook event'
operationId: retrieveAnWebhookEvent
description: "Retrieves an webhook event for the current company.\n"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: a17a46d5-6ef6-472d-b433-0ea4f4c65e2c
webhook_id: a17a46d5-6e21-425a-ae7c-a8627eb3e3a3
event: quis
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-6ef6-472d-b433-0ea4f4c65e2c
webhook_id:
type: string
example: a17a46d5-6e21-425a-ae7c-a8627eb3e3a3
event:
type: string
example: quis
payload:
type: object
properties:
key:
type: string
example: value
status:
type: string
example: pending
retries:
type: integer
example: 0
next_retry_at:
type: string
example: null
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.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: a17a46d5-60ef-48a9-b37c-cfc65e545c01
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: a17a46d5-485f-4366-a439-fb4289d2769e
company_id: 642af263-7b20-4c8d-b446-ef99e1831866
url: 'https://gulgowski.com'
description: null
events: []
secret: be36b7db4bdf30c7796bbbe4b13cffdfddd040ecc514c9bc81d942f0f49473e4
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
-
id: a17a46d5-4ce7-4655-8abe-fe5122d9ceb5
company_id: 7ec1f497-8b14-4538-8def-0319903a21d7
url: 'https://muller.net'
description: null
events: []
secret: 386e0f61b66277b4018c43ac58c3d8881ea2c5d3285127b43165fd69db0930df
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
properties:
data:
type: array
example:
-
id: a17a46d5-485f-4366-a439-fb4289d2769e
company_id: 642af263-7b20-4c8d-b446-ef99e1831866
url: 'https://gulgowski.com'
description: null
events: []
secret: be36b7db4bdf30c7796bbbe4b13cffdfddd040ecc514c9bc81d942f0f49473e4
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
-
id: a17a46d5-4ce7-4655-8abe-fe5122d9ceb5
company_id: 7ec1f497-8b14-4538-8def-0319903a21d7
url: 'https://muller.net'
description: null
events: []
secret: 386e0f61b66277b4018c43ac58c3d8881ea2c5d3285127b43165fd69db0930df
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
items:
type: object
properties:
id:
type: string
example: a17a46d5-485f-4366-a439-fb4289d2769e
company_id:
type: string
example: 642af263-7b20-4c8d-b446-ef99e1831866
url:
type: string
example: 'https://gulgowski.com'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: be36b7db4bdf30c7796bbbe4b13cffdfddd040ecc514c9bc81d942f0f49473e4
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.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.daugherty.com/delectus-totam-vel-maiores-animi-facilis-suscipit'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Magnam et ipsum aut accusamus quae.'
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: a17a46d5-53f6-440a-b98c-3913c6d44aec
company_id: c408e998-f8db-4b02-b3be-07ec6ad8eeda
url: 'https://hamill.org'
description: null
events: []
secret: 77b40ccee4f4380a8844ae6e5b98a88fe4345344b9c21c81f300c15f6b084c5d
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-53f6-440a-b98c-3913c6d44aec
company_id:
type: string
example: c408e998-f8db-4b02-b3be-07ec6ad8eeda
url:
type: string
example: 'https://hamill.org'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: 77b40ccee4f4380a8844ae6e5b98a88fe4345344b9c21c81f300c15f6b084c5d
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
tags:
- Webhooks
patch:
summary: 'Update a webhook'
operationId: updateAWebhook
description: "Updates a webhook for the current company.\n"
parameters: []
responses:
200:
description: 'update successful'
content:
text/plain:
schema:
type: string
example: ''
404:
description: 'webhook not found'
content:
application/json:
schema:
type: object
example:
message: 'webhook not found'
properties:
message:
type: string
example: 'webhook not found'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'url is already used by company'
type: object
example:
message: 'The url has already been taken.'
properties:
message:
type: string
example: 'The url has already been taken.'
-
description: 'validation error'
type: object
example:
message: 'invalid url'
properties:
message:
type: string
example: 'invalid url'
tags:
- Webhooks
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL.'
example: 'http://www.goodwin.com/provident-minus-ut-aut-ratione-quam-quia-tempore.html'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Neque aliquam quaerat cum maxime.'
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: a17a46d5-485f-4366-a439-fb4289d2769e
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: a17a46d5-5805-4bcf-ad1e-af6630dcbfcd
company_id: 9168e73c-3149-400c-bca1-f7899ef5c004
url: 'https://mueller.biz'
description: null
events: []
secret: c365e05f78235a55f1b0ae85ae8797b520db51d46992a2848632a603367bb6a9
last_sent_at: null
created_at: '2026-04-06T08:51:04.000000Z'
updated_at: '2026-04-06T08:51:04.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a17a46d5-5805-4bcf-ad1e-af6630dcbfcd
company_id:
type: string
example: 9168e73c-3149-400c-bca1-f7899ef5c004
url:
type: string
example: 'https://mueller.biz'
description:
type: string
example: null
events:
type: array
example: []
secret:
type: string
example: c365e05f78235a55f1b0ae85ae8797b520db51d46992a2848632a603367bb6a9
last_sent_at:
type: string
example: null
created_at:
type: string
example: '2026-04-06T08:51:04.000000Z'
updated_at:
type: string
example: '2026-04-06T08:51:04.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: a17a46d5-485f-4366-a439-fb4289d2769e
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: a17a46d5-485f-4366-a439-fb4289d2769e
required: true
schema:
type: string