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: cpe
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: cpe
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: a26c80f2-db22-40b4-8e0a-574d495169be
cpe: 'cpe:2.3:a:apple:macos:*:*:*:*:*:*:*:*'
vendor: Apple
product: macOS
version: 15.54.9448
update: build1097
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-dcd3-43c5-9db3-1d5463f3b0e4
cpe: 'cpe:2.3:a:mozilla:thunderbird:*:*:*:*:*:*:*:*'
vendor: Mozilla
product: Thunderbird
version: 16.33.159
update: update1
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.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: a26c80f2-db22-40b4-8e0a-574d495169be
cpe: 'cpe:2.3:a:apple:macos:*:*:*:*:*:*:*:*'
vendor: Apple
product: macOS
version: 15.54.9448
update: build1097
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-dcd3-43c5-9db3-1d5463f3b0e4
cpe: 'cpe:2.3:a:mozilla:thunderbird:*:*:*:*:*:*:*:*'
vendor: Mozilla
product: Thunderbird
version: 16.33.159
update: update1
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f2-db22-40b4-8e0a-574d495169be
cpe:
type: string
example: 'cpe:2.3:a:apple:macos:*:*:*:*:*:*:*:*'
vendor:
type: string
example: Apple
product:
type: string
example: macOS
version:
type: string
example: 15.54.9448
update:
type: string
example: build1097
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Applications
/v1/applications/export:
get:
summary: 'Export applications.'
operationId: exportApplications
description: " Export all applications for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: csv
required: true
schema:
type: 'The type of export to generate'
description: ''
example: csv
enum:
- csv
- xlsx
-
in: query
name: 'filter[vendor]'
description: ''
example: microsoft
required: false
schema:
type: 'Filter applications by vendor.'
description: ''
example: microsoft
-
in: query
name: 'filter[product]'
description: ''
example: windows
required: false
schema:
type: 'Filter applications by product.'
description: ''
example: windows
-
in: query
name: 'filter[version]'
description: ''
example: 1.2.0
required: false
schema:
type: 'Filter applications by version.'
description: ''
example: 1.2.0
-
in: query
name: sort
description: ''
example: version
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor'
description: ''
example: version
enum:
- cpe
- vendor
- product
- version
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: ''
example: csv
enum:
- csv
- xlsx
required:
- type
'/v1/applications/{id}':
get:
summary: 'Retrieve an application.'
operationId: retrieveAnApplication
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: assets
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: assets
enum:
- assets
responses:
200:
description: 'Successfully retrieved application'
content:
application/json:
schema:
type: object
example:
data:
id: a26c80f2-e1e2-4950-82ed-5d97a01cf6db
cpe: 'cpe:2.3:a:ibm:websphere:*:*:*:*:*:*:*:*'
vendor: IBM
product: WebSphere
version: 11.42.57
update: build5921
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-e1e2-4950-82ed-5d97a01cf6db
cpe:
type: string
example: 'cpe:2.3:a:ibm:websphere:*:*:*:*:*:*:*:*'
vendor:
type: string
example: IBM
product:
type: string
example: WebSphere
version:
type: string
example: 11.42.57
update:
type: string
example: build5921
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
tags:
- Applications
parameters:
-
in: path
name: id
description: 'The ID of the application.'
example: dolorem
required: true
schema:
type: string
/v1/assets:
get:
summary: 'List assets.'
operationId: listAssets
description: " Retrieve all assets for the current company. Look at the 'Retrieve an asset' endpoint for more details on the asset object.\n "
parameters:
-
in: query
name: 'filter[name]'
description: ''
example: Laptop-1
required: false
schema:
type: 'Filter assets by name.'
description: ''
example: Laptop-1
-
in: query
name: 'filter[host]'
description: ''
example: 192.168.1.1
required: false
schema:
type: 'Filter assets by their IP-address.'
description: ''
example: 192.168.1.1
-
in: query
name: 'filter[mac_address]'
description: ''
example: '3A:5E:D6:95:BF'
required: false
schema:
type: 'Filter assets by their MAC-address.'
description: ''
example: '3A:5E:D6:95:BF'
-
in: query
name: 'filter[hostname]'
description: ''
example: laptop-1.local
required: false
schema:
type: 'Filter assets by their hostname.'
description: ''
example: laptop-1.local
-
in: query
name: 'filter[tags][]'
description: ''
example: 'New,Old'
required: false
schema:
type: 'Filter assets by their tags.'
description: ''
example: 'New,Old'
-
in: query
name: 'filter[licensed]'
description: ''
example: 'true,false'
required: false
schema:
type: 'Filter assets by licensed status.'
description: ''
example: 'true,false'
-
in: query
name: sort
description: ''
example: 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: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a26c80f2-8467-4160-81af-253402478a5a
company_id: '4225376'
name: 'Chyna Weimann'
identifier: '29:7A:32:BC:29:F9'
host: 184.249.233.0
mac_address: '29:7A:32:BC:29:F9'
hostname: jacobson.com
operating_system: soluta
operating_system_name: fugiat
first_seen: '2006-08-11T16:40:43.000000Z'
last_seen: '1995-05-04T05:21:27.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: null
-
id: a26c80f2-88fb-4634-9b7d-fc3b5f46bfc5
company_id: '1982836'
name: 'Payton Tillman'
identifier: '0A:AF:6F:33:17:8D'
host: 113.15.67.254
mac_address: '0A:AF:6F:33:17:8D'
hostname: nolan.com
operating_system: voluptas
operating_system_name: accusamus
first_seen: '1983-10-21T21:17:45.000000Z'
last_seen: '2024-01-08T12:53:43.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-09-03T18:09:03.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: a26c80f2-8467-4160-81af-253402478a5a
company_id: '4225376'
name: 'Chyna Weimann'
identifier: '29:7A:32:BC:29:F9'
host: 184.249.233.0
mac_address: '29:7A:32:BC:29:F9'
hostname: jacobson.com
operating_system: soluta
operating_system_name: fugiat
first_seen: '2006-08-11T16:40:43.000000Z'
last_seen: '1995-05-04T05:21:27.000000Z'
open_tcp_ports: '80,443'
open_udp_ports: '53,123'
traceroute: []
ssh_key: null
average_scan_duration: 0
licensed: true
change_license_at: null
-
id: a26c80f2-88fb-4634-9b7d-fc3b5f46bfc5
company_id: '1982836'
name: 'Payton Tillman'
identifier: '0A:AF:6F:33:17:8D'
host: 113.15.67.254
mac_address: '0A:AF:6F:33:17:8D'
hostname: nolan.com
operating_system: voluptas
operating_system_name: accusamus
first_seen: '1983-10-21T21:17:45.000000Z'
last_seen: '2024-01-08T12:53:43.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-09-03T18:09:03.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f2-8467-4160-81af-253402478a5a
company_id:
type: string
example: '4225376'
name:
type: string
example: 'Chyna Weimann'
identifier:
type: string
example: '29:7A:32:BC:29:F9'
host:
type: string
example: 184.249.233.0
mac_address:
type: string
example: '29:7A:32:BC:29:F9'
hostname:
type: string
example: jacobson.com
operating_system:
type: string
example: soluta
operating_system_name:
type: string
example: fugiat
first_seen:
type: string
example: '2006-08-11T16:40:43.000000Z'
last_seen:
type: string
example: '1995-05-04T05:21:27.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: null
nullable: true
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- 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: a26c80f2-92d3-448a-bbb7-10b8d7264981
company_id: '6576090'
name: 'Summer Kunde'
identifier: '27:C5:7C:39:11:0E'
host: 8.93.96.190
mac_address: '27:C5:7C:39:11:0E'
hostname: mraz.biz
operating_system: distinctio
operating_system_name: aspernatur
first_seen: '2002-06-01T09:43:21.000000Z'
last_seen: '1983-06-30T16:52:29.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-09-02T10:43:16.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-92d3-448a-bbb7-10b8d7264981
company_id:
type: string
example: '6576090'
name:
type: string
example: 'Summer Kunde'
identifier:
type: string
example: '27:C5:7C:39:11:0E'
host:
type: string
example: 8.93.96.190
mac_address:
type: string
example: '27:C5:7C:39:11:0E'
hostname:
type: string
example: mraz.biz
operating_system:
type: string
example: distinctio
operating_system_name:
type: string
example: aspernatur
first_seen:
type: string
example: '2002-06-01T09:43:21.000000Z'
last_seen:
type: string
example: '1983-06-30T16:52:29.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-09-02T10:43:16.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: agunrnahiyktmwek
host:
type: string
description: 'A valid IPv4 or IPv6 address. Must be unique'
example: qui
licensed:
type: boolean
description: ''
example: false
required:
- name
- host
/v1/assets/actions:
patch:
summary: 'Bulk asset action.'
operationId: bulkAssetAction
description: "Will perform a bulk action on assets (Add Tags, Remove Tags or delete). \n "
parameters: []
responses:
204:
description: 'bulk action performed successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Assets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: 'Must have at least 1 items.'
example:
- []
items:
type: object
properties:
action:
type: string
description: ''
example: assignLicense
enum:
- addTags
- removeTags
- delete
- assignLicense
- removeLicense
id:
type: string
description: ''
example: explicabo
data:
type: object
description: ''
example: []
properties:
tags:
type: object
description: ''
example: null
properties: { }
required:
- action
- id
required:
- data
'/v1/assets/{id}':
get:
summary: 'Retrieve an asset.'
operationId: retrieveAnAsset
description: " Retrieves an asset by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: tags
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: tags
enum:
- certificates
- software
- tags
- scans
responses:
200:
description: 'Successfully retrieved asset'
content:
application/json:
schema:
type: object
example:
data:
id: a26c80f2-987d-43a9-9f9a-f3790c78c02a
company_id: '4798319'
name: 'Ms. Duane Schowalter'
identifier: 'E5:90:F5:42:53:4A'
host: 6.240.54.100
mac_address: 'E5:90:F5:42:53:4A'
hostname: williamson.com
operating_system: inventore
operating_system_name: nihil
first_seen: '1978-11-29T19:10:32.000000Z'
last_seen: '2006-03-19T22:15: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-08-16T17:00:22.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-987d-43a9-9f9a-f3790c78c02a
company_id:
type: string
example: '4798319'
name:
type: string
example: 'Ms. Duane Schowalter'
identifier:
type: string
example: 'E5:90:F5:42:53:4A'
host:
type: string
example: 6.240.54.100
mac_address:
type: string
example: 'E5:90:F5:42:53:4A'
hostname:
type: string
example: williamson.com
operating_system:
type: string
example: inventore
operating_system_name:
type: string
example: nihil
first_seen:
type: string
example: '1978-11-29T19:10:32.000000Z'
last_seen:
type: string
example: '2006-03-19T22:15: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
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: true
change_license_at:
type: string
example: '2026-08-16T17:00:22.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: a26c80f2-9e58-4e68-a5ee-a8b25b74094e
company_id: '2911130'
name: 'Gerry Roberts Sr.'
identifier: '32:36:9E:1D:EA:F7'
host: 170.52.63.215
mac_address: '32:36:9E:1D:EA:F7'
hostname: mraz.com
operating_system: necessitatibus
operating_system_name: quaerat
first_seen: '2025-05-25T11:18:04.000000Z'
last_seen: '2018-07-16T17:02:17.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-08-31T23:59:14.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-9e58-4e68-a5ee-a8b25b74094e
company_id:
type: string
example: '2911130'
name:
type: string
example: 'Gerry Roberts Sr.'
identifier:
type: string
example: '32:36:9E:1D:EA:F7'
host:
type: string
example: 170.52.63.215
mac_address:
type: string
example: '32:36:9E:1D:EA:F7'
hostname:
type: string
example: mraz.com
operating_system:
type: string
example: necessitatibus
operating_system_name:
type: string
example: quaerat
first_seen:
type: string
example: '2025-05-25T11:18:04.000000Z'
last_seen:
type: string
example: '2018-07-16T17:02:17.000000Z'
open_tcp_ports:
type: string
example: '80,443'
open_udp_ports:
type: string
example: '53,123'
traceroute:
type: array
example: []
ssh_key:
type: string
example: null
nullable: true
average_scan_duration:
type: integer
example: 0
licensed:
type: boolean
example: false
change_license_at:
type: string
example: '2026-08-31T23:59:14.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: xhxcdnywbwxooonhowaztjqbu
licensed:
type: boolean
description: ''
example: false
delete:
summary: 'Delete asset.'
operationId: deleteAsset
description: "Will delete an existing asset \n "
parameters: []
responses:
204:
description: 'asset deleted successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Assets
parameters:
-
in: path
name: id
description: 'The ID of the asset.'
example: culpa
required: true
schema:
type: string
/v1/certificates:
get:
summary: 'List certificates.'
operationId: listCertificates
description: " Retrieve all certificates for the current company. Look at the 'Retrieve a certificate' endpoint for more details on the certificate object.\n "
parameters:
-
in: query
name: 'filter[common_name]'
description: ''
example: test.nl
required: false
schema:
type: 'Filter certificates by their common name.'
description: ''
example: test.nl
-
in: query
name: 'filter[organization]'
description: ''
example: 'Test B.V.'
required: false
schema:
type: 'Filter certificates by their organization name.'
description: ''
example: 'Test B.V.'
-
in: query
name: sort
description: ''
example: not_valid_after
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before'
description: ''
example: not_valid_after
enum:
- not_valid_after
-
in: query
name: include
description: ''
example: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a26c80f2-a815-4d20-ab26-f958131dfc80
company_id: '7175818'
common_name: quitzon.com
organization: Boyer-West
organizational_unit: Group
locality: null
state: Washington
country: SK
serial: BXM6P6EUGOHKQH3OJFTN2H4QIRET3Y0L
not_valid_before: 20260507T165815Z
not_valid_after: 20260919T071406Z
value: "-----BEGIN CERTIFICATE-----\n2o2pWeFTal7AC7DdymEn7lH8zDBINNg52fdXuWp1Xa88b7qz9UMrCaGkT+uciNqs\nqlTnkFUOMR6ZSCWBHzn80wYDg9m64xLXu9iaGjwxKga6AUgJbTydAH38V6RuGS6r\nfGDpgI6H4MHvHBvON0Dm2RtuO7UiKnbK6IQnQP6DyZzKMqItPKe9dMHQ+6ZRaAI6\nvGdfs2DRPt19crT7ZM0KbX87i4zDasYia3MfsZzfc/07Og9pq9j73sDRTuLPVwl4\nnxeogHlYBCvkKZdkHIOP6ou9f5cj+bGg8PHTzQxRsa+VZAmYYg/OwSUZMVZoPYqv\nd5W0Lrfdva/2qn8t7kkQ5Z8ZrfljJfos+LPjquUloRlwu5AzPQ4+EabBhWp9WeWd\n+Y27NQQudaGVFMlP0hVt/SCd405TRzWrAKUYCZCY7mxvSMHle9TDAY28GceLBRrS\n3dv0q6kyBvLy8t7XxDCBhQWI3soiaBIy46Yc8gEIywmEfFOacAl2JdvLTtmn2MJm\nhytzGevblm5bJik3QuJlQeo7ZBkd8YB4FpKtYBEH61n+8uL51MjYSvKEVIDfYHn6\nFs+v+FWkJrkKOb6X7jiu3ZgiUu/OwRe9IIoydgNTpXihVzE+0qp/orXuoXjtJs4Q\n+98E6M5dVaB15o08206Z+/4RikfehZfnWxN9khzGVtnrXK3lJroRs+zrDu9btaPe\nNBoggFc00fX28GAysCS+mzSvo5UEtMDtKTgoXFHg4zJ5N4cb9eMANQ7oKH+ViClh\nr0yIlGE17EQQ640bVvyZao1sq7cy62lIK+l3vneihHXeWJlmMReLMX15H9pWn0Az\nEtVZ0ZVm9+b3r9ISYLhfHRSW6N2C9BTXKE7sO2pBGh/BPXHQpEkmIeU9Y+gFl2nc\njXUsl5Z3s23qypW7B5BZNZYfeQyVMh3G2V+sEuP8xzcMICzyxmfRUIRERH66EkpS\nM2uYAhVK4EHWZs7w5m7OM8PZ6IBHVs0e7uDHc7q3UW0fpuQBJTwulW/k4fjuWoz+\nNyWBqSOiyjPw2p2Efvx5VgFwm/50kxNKy12xtnzJ20tNhZv0LWnHJCazNB0GxoEL\nMh9And8v/PlFEbEPe4AHcFqx+kycxBJQWtVzAY7ad6rmyqRS80F+jarMuJA6g1Ha\nLzYuMTR3b5362zitPGyzWaq+stEqaKX0cnEbL/dO8u7g/CmK5EyPqIqvni0IAVh7\nF2lCVA1oSpCPdPyj/z2iR2tw/TfN6oYty3lry5i/BttjRRmm+wbsuvLITU7/IoYP\ntnEGokt/UxePNub0LXdlWY2ZulG1CWllc3mjjHLBsd1YnS9Hwuwv8jFxNG9a2kom\n48ZzusfR97PDxuaf596BtA==\n\n-----END CERTIFICATE-----"
first_seen: '2026-06-16T13:21:37.000000Z'
last_seen: '2026-06-25T15:11:32.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-ab8b-4f78-9190-1a0218d2ecfc
company_id: '6180751'
common_name: champlin.com
organization: 'Marvin Group'
organizational_unit: null
locality: Dillanhaven
state: Hawaii
country: BI
serial: QWVGHSAIBFXAKXHN4ZMPFJPFVGWMJUIM
not_valid_before: 20250613T213228Z
not_valid_after: 20270420T160259Z
value: "-----BEGIN CERTIFICATE-----\n46W1zvfbNRMqye4PE7/423m7MURcLtx5EXducL27Wta1t0GD2H/xtunte58Ss6y0\nhiYRemmAh79elJb/giVu3vBI978M9l5yRjmuA/3+8c68BPjXLhA7EFSL6eYWUTC+\nZrEYop8q64viuG7g9jATuMYRQyYe1A59sGyHiVXTnf1AKtscPJzgVv7H5nsrTe88\nVn6meVOMEcTQNF8t/Ld/6BH2Xtz0HwMs4cyBULhxrbFxdAQMIKhNfxyqWLGvolmm\nuHrKJ/UXDLz5gpCg2xiiJI+dkZOVp5oNiplyV7E0qcEtE8XL8w7S1U/qb56S3fF5\nfjVRe8oN//c8pKD9DkG+bB8Z0O/IQSqnj0o1pnh+QdcMOwkwu9Uodlr8pDCQhudm\n3ZTjaoKDJqweBAobQD0Dv/NgBHHHkfZ5XGweLIMxJuS3q4Sos64u21wbXWTZiXQ5\n2AHg5nGdeLyEK80NNqcf4svTc5zB9ykBIALJ9Vsz7YqeY+P74YKLCbEGG7ZycG4g\nJI2LYPsKIzhAcSXU/xuAJ0/aN1NP+Fnpr1uvBslKAp1JG9cur8/uC4w5+ZkjCk/u\nwg1XaAVn2Kl1H6myaM+MpvN1EdmY0XhehTnZWZdHImt9rTg7H0soIWlpf8lmJgGe\nauY9d0YkLEGaCO8fCLLPz4BNEXziXbSvPb4UvQniHvqRBb4FJ/wuqvZvqXecD76T\n1ZNya4IdL7g3RtO6bsB+1nAGHxVMvFvxYzfgT/vfZJNi1Li8iVZ6Hx/6RaLI45C/\nVWXtPmcifgGsqRVGXUdlsQMiVeRBUaCTlZzASMR+p5OIbMye1bE8WgTKs37giCyy\nv0KecDYK2vKvHzyPXz/8UqJrORTQ0HKi5ZSk6haABLVVYF42RHGo+4tT0dwzs5FT\nlvDISRVQs2SC18yE53XDJFAJjgNl11mX791UuyJhm4FEZsme1IfGt1+YLuLY3ZO9\nq278NuZM5iMUrmktjGIhyMNSarKYoQ+80dRu9v1WMgbqIFSrJjXaBllhmieafI/9\nlDnPa6aUFcwORTm4BJGceE/wnDCe3nxnI4dtaFIlLT2Z2vLQB/mxzoDyyGK5+ior\n2rU5xOQJ9hZjsdNj86Mg8nic9uTnr1K8FhI/U4vg3xuU+bEbJUEV1N1nkn3XEzG8\nQ4RoQYCmLRVp0gt5TbTzQWPk7umRDD1jqYik27iPKdtA3rDdnK6ZsywUHF9e9YEA\nZmbP5MCU+Bg3p4iDHZpGxqa+LKEaCswG3qnexnTP67fDG6oNM7RFdL5GQV5MrcQF\nYxpQS4jAuW8CCBx1OU8P/x5xK86URPiV9VMP2mcCJbPAd/Kkr0PMNV2uBpbEahaA\nzwy51ru2FocnHP6r/kag4w==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-04T14:40:09.000000Z'
last_seen: '2025-07-23T13:10:46.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.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: a26c80f2-a815-4d20-ab26-f958131dfc80
company_id: '7175818'
common_name: quitzon.com
organization: Boyer-West
organizational_unit: Group
locality: null
state: Washington
country: SK
serial: BXM6P6EUGOHKQH3OJFTN2H4QIRET3Y0L
not_valid_before: 20260507T165815Z
not_valid_after: 20260919T071406Z
value: "-----BEGIN CERTIFICATE-----\n2o2pWeFTal7AC7DdymEn7lH8zDBINNg52fdXuWp1Xa88b7qz9UMrCaGkT+uciNqs\nqlTnkFUOMR6ZSCWBHzn80wYDg9m64xLXu9iaGjwxKga6AUgJbTydAH38V6RuGS6r\nfGDpgI6H4MHvHBvON0Dm2RtuO7UiKnbK6IQnQP6DyZzKMqItPKe9dMHQ+6ZRaAI6\nvGdfs2DRPt19crT7ZM0KbX87i4zDasYia3MfsZzfc/07Og9pq9j73sDRTuLPVwl4\nnxeogHlYBCvkKZdkHIOP6ou9f5cj+bGg8PHTzQxRsa+VZAmYYg/OwSUZMVZoPYqv\nd5W0Lrfdva/2qn8t7kkQ5Z8ZrfljJfos+LPjquUloRlwu5AzPQ4+EabBhWp9WeWd\n+Y27NQQudaGVFMlP0hVt/SCd405TRzWrAKUYCZCY7mxvSMHle9TDAY28GceLBRrS\n3dv0q6kyBvLy8t7XxDCBhQWI3soiaBIy46Yc8gEIywmEfFOacAl2JdvLTtmn2MJm\nhytzGevblm5bJik3QuJlQeo7ZBkd8YB4FpKtYBEH61n+8uL51MjYSvKEVIDfYHn6\nFs+v+FWkJrkKOb6X7jiu3ZgiUu/OwRe9IIoydgNTpXihVzE+0qp/orXuoXjtJs4Q\n+98E6M5dVaB15o08206Z+/4RikfehZfnWxN9khzGVtnrXK3lJroRs+zrDu9btaPe\nNBoggFc00fX28GAysCS+mzSvo5UEtMDtKTgoXFHg4zJ5N4cb9eMANQ7oKH+ViClh\nr0yIlGE17EQQ640bVvyZao1sq7cy62lIK+l3vneihHXeWJlmMReLMX15H9pWn0Az\nEtVZ0ZVm9+b3r9ISYLhfHRSW6N2C9BTXKE7sO2pBGh/BPXHQpEkmIeU9Y+gFl2nc\njXUsl5Z3s23qypW7B5BZNZYfeQyVMh3G2V+sEuP8xzcMICzyxmfRUIRERH66EkpS\nM2uYAhVK4EHWZs7w5m7OM8PZ6IBHVs0e7uDHc7q3UW0fpuQBJTwulW/k4fjuWoz+\nNyWBqSOiyjPw2p2Efvx5VgFwm/50kxNKy12xtnzJ20tNhZv0LWnHJCazNB0GxoEL\nMh9And8v/PlFEbEPe4AHcFqx+kycxBJQWtVzAY7ad6rmyqRS80F+jarMuJA6g1Ha\nLzYuMTR3b5362zitPGyzWaq+stEqaKX0cnEbL/dO8u7g/CmK5EyPqIqvni0IAVh7\nF2lCVA1oSpCPdPyj/z2iR2tw/TfN6oYty3lry5i/BttjRRmm+wbsuvLITU7/IoYP\ntnEGokt/UxePNub0LXdlWY2ZulG1CWllc3mjjHLBsd1YnS9Hwuwv8jFxNG9a2kom\n48ZzusfR97PDxuaf596BtA==\n\n-----END CERTIFICATE-----"
first_seen: '2026-06-16T13:21:37.000000Z'
last_seen: '2026-06-25T15:11:32.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-ab8b-4f78-9190-1a0218d2ecfc
company_id: '6180751'
common_name: champlin.com
organization: 'Marvin Group'
organizational_unit: null
locality: Dillanhaven
state: Hawaii
country: BI
serial: QWVGHSAIBFXAKXHN4ZMPFJPFVGWMJUIM
not_valid_before: 20250613T213228Z
not_valid_after: 20270420T160259Z
value: "-----BEGIN CERTIFICATE-----\n46W1zvfbNRMqye4PE7/423m7MURcLtx5EXducL27Wta1t0GD2H/xtunte58Ss6y0\nhiYRemmAh79elJb/giVu3vBI978M9l5yRjmuA/3+8c68BPjXLhA7EFSL6eYWUTC+\nZrEYop8q64viuG7g9jATuMYRQyYe1A59sGyHiVXTnf1AKtscPJzgVv7H5nsrTe88\nVn6meVOMEcTQNF8t/Ld/6BH2Xtz0HwMs4cyBULhxrbFxdAQMIKhNfxyqWLGvolmm\nuHrKJ/UXDLz5gpCg2xiiJI+dkZOVp5oNiplyV7E0qcEtE8XL8w7S1U/qb56S3fF5\nfjVRe8oN//c8pKD9DkG+bB8Z0O/IQSqnj0o1pnh+QdcMOwkwu9Uodlr8pDCQhudm\n3ZTjaoKDJqweBAobQD0Dv/NgBHHHkfZ5XGweLIMxJuS3q4Sos64u21wbXWTZiXQ5\n2AHg5nGdeLyEK80NNqcf4svTc5zB9ykBIALJ9Vsz7YqeY+P74YKLCbEGG7ZycG4g\nJI2LYPsKIzhAcSXU/xuAJ0/aN1NP+Fnpr1uvBslKAp1JG9cur8/uC4w5+ZkjCk/u\nwg1XaAVn2Kl1H6myaM+MpvN1EdmY0XhehTnZWZdHImt9rTg7H0soIWlpf8lmJgGe\nauY9d0YkLEGaCO8fCLLPz4BNEXziXbSvPb4UvQniHvqRBb4FJ/wuqvZvqXecD76T\n1ZNya4IdL7g3RtO6bsB+1nAGHxVMvFvxYzfgT/vfZJNi1Li8iVZ6Hx/6RaLI45C/\nVWXtPmcifgGsqRVGXUdlsQMiVeRBUaCTlZzASMR+p5OIbMye1bE8WgTKs37giCyy\nv0KecDYK2vKvHzyPXz/8UqJrORTQ0HKi5ZSk6haABLVVYF42RHGo+4tT0dwzs5FT\nlvDISRVQs2SC18yE53XDJFAJjgNl11mX791UuyJhm4FEZsme1IfGt1+YLuLY3ZO9\nq278NuZM5iMUrmktjGIhyMNSarKYoQ+80dRu9v1WMgbqIFSrJjXaBllhmieafI/9\nlDnPa6aUFcwORTm4BJGceE/wnDCe3nxnI4dtaFIlLT2Z2vLQB/mxzoDyyGK5+ior\n2rU5xOQJ9hZjsdNj86Mg8nic9uTnr1K8FhI/U4vg3xuU+bEbJUEV1N1nkn3XEzG8\nQ4RoQYCmLRVp0gt5TbTzQWPk7umRDD1jqYik27iPKdtA3rDdnK6ZsywUHF9e9YEA\nZmbP5MCU+Bg3p4iDHZpGxqa+LKEaCswG3qnexnTP67fDG6oNM7RFdL5GQV5MrcQF\nYxpQS4jAuW8CCBx1OU8P/x5xK86URPiV9VMP2mcCJbPAd/Kkr0PMNV2uBpbEahaA\nzwy51ru2FocnHP6r/kag4w==\n\n-----END CERTIFICATE-----"
first_seen: '2025-07-04T14:40:09.000000Z'
last_seen: '2025-07-23T13:10:46.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f2-a815-4d20-ab26-f958131dfc80
company_id:
type: string
example: '7175818'
common_name:
type: string
example: quitzon.com
organization:
type: string
example: Boyer-West
organizational_unit:
type: string
example: Group
locality:
type: string
example: null
nullable: true
state:
type: string
example: Washington
country:
type: string
example: SK
serial:
type: string
example: BXM6P6EUGOHKQH3OJFTN2H4QIRET3Y0L
not_valid_before:
type: string
example: 20260507T165815Z
not_valid_after:
type: string
example: 20260919T071406Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\n2o2pWeFTal7AC7DdymEn7lH8zDBINNg52fdXuWp1Xa88b7qz9UMrCaGkT+uciNqs\nqlTnkFUOMR6ZSCWBHzn80wYDg9m64xLXu9iaGjwxKga6AUgJbTydAH38V6RuGS6r\nfGDpgI6H4MHvHBvON0Dm2RtuO7UiKnbK6IQnQP6DyZzKMqItPKe9dMHQ+6ZRaAI6\nvGdfs2DRPt19crT7ZM0KbX87i4zDasYia3MfsZzfc/07Og9pq9j73sDRTuLPVwl4\nnxeogHlYBCvkKZdkHIOP6ou9f5cj+bGg8PHTzQxRsa+VZAmYYg/OwSUZMVZoPYqv\nd5W0Lrfdva/2qn8t7kkQ5Z8ZrfljJfos+LPjquUloRlwu5AzPQ4+EabBhWp9WeWd\n+Y27NQQudaGVFMlP0hVt/SCd405TRzWrAKUYCZCY7mxvSMHle9TDAY28GceLBRrS\n3dv0q6kyBvLy8t7XxDCBhQWI3soiaBIy46Yc8gEIywmEfFOacAl2JdvLTtmn2MJm\nhytzGevblm5bJik3QuJlQeo7ZBkd8YB4FpKtYBEH61n+8uL51MjYSvKEVIDfYHn6\nFs+v+FWkJrkKOb6X7jiu3ZgiUu/OwRe9IIoydgNTpXihVzE+0qp/orXuoXjtJs4Q\n+98E6M5dVaB15o08206Z+/4RikfehZfnWxN9khzGVtnrXK3lJroRs+zrDu9btaPe\nNBoggFc00fX28GAysCS+mzSvo5UEtMDtKTgoXFHg4zJ5N4cb9eMANQ7oKH+ViClh\nr0yIlGE17EQQ640bVvyZao1sq7cy62lIK+l3vneihHXeWJlmMReLMX15H9pWn0Az\nEtVZ0ZVm9+b3r9ISYLhfHRSW6N2C9BTXKE7sO2pBGh/BPXHQpEkmIeU9Y+gFl2nc\njXUsl5Z3s23qypW7B5BZNZYfeQyVMh3G2V+sEuP8xzcMICzyxmfRUIRERH66EkpS\nM2uYAhVK4EHWZs7w5m7OM8PZ6IBHVs0e7uDHc7q3UW0fpuQBJTwulW/k4fjuWoz+\nNyWBqSOiyjPw2p2Efvx5VgFwm/50kxNKy12xtnzJ20tNhZv0LWnHJCazNB0GxoEL\nMh9And8v/PlFEbEPe4AHcFqx+kycxBJQWtVzAY7ad6rmyqRS80F+jarMuJA6g1Ha\nLzYuMTR3b5362zitPGyzWaq+stEqaKX0cnEbL/dO8u7g/CmK5EyPqIqvni0IAVh7\nF2lCVA1oSpCPdPyj/z2iR2tw/TfN6oYty3lry5i/BttjRRmm+wbsuvLITU7/IoYP\ntnEGokt/UxePNub0LXdlWY2ZulG1CWllc3mjjHLBsd1YnS9Hwuwv8jFxNG9a2kom\n48ZzusfR97PDxuaf596BtA==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2026-06-16T13:21:37.000000Z'
last_seen:
type: string
example: '2026-06-25T15:11:32.000000Z'
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Certificates
/v1/certificates/export:
get:
summary: 'Export certificates.'
operationId: exportCertificates
description: " Export all certificates for the current company in CSV or XLSX format.\n "
parameters:
-
in: query
name: type
description: ''
example: xlsx
required: true
schema:
type: 'The type of export to generate'
description: ''
example: xlsx
enum:
- csv
- xlsx
-
in: query
name: 'filter[common_name]'
description: ''
example: test.nl
required: false
schema:
type: 'Filter certificates by their common name.'
description: ''
example: test.nl
-
in: query
name: 'filter[organization]'
description: ''
example: 'Test B.V.'
required: false
schema:
type: 'Filter certificates by their organization name.'
description: ''
example: 'Test B.V.'
-
in: query
name: sort
description: ''
example: not_valid_after
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before'
description: ''
example: not_valid_after
enum:
- not_valid_after
-
in: query
name: filter
description: ''
example: organization
required: false
schema:
type: 'The column(s) to filter by. Eg filter=common_name:test.nl'
description: ''
example: organization
enum:
- common_name
- organization
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Certificates
'/v1/certificates/{id}':
get:
summary: 'Retrieve a certificate.'
operationId: retrieveACertificate
description: " Retrieves an by its ID.\n "
parameters:
-
in: query
name: include
description: ''
example: certificates
required: false
schema:
type: 'Include additional relationships (comma separated).'
description: ''
example: certificates
enum:
- certificates
- applications
- tags
- scans
responses:
200:
description: 'Successfully retrieved certificate'
content:
application/json:
schema:
type: object
example:
data:
id: a26c80f2-b354-4847-b796-083ff86e5170
company_id: '5378056'
common_name: smith.com
organization: Toy-Stanton
organizational_unit: null
locality: null
state: Alabama
country: MY
serial: HPLJATM5OYKQAWJSZ5IQXVTXCKPJYQ3H
not_valid_before: 20260206T080324Z
not_valid_after: 20270304T231114Z
value: "-----BEGIN CERTIFICATE-----\nrSxjudd3gxB1p9ewvy7Q/NhNpvTiyF0csuCSEEtbipNbJ1RH4Gt9dn1d/QP5ugC0\n1csPH1Depd9EqWZik7bpRBxiLBC7lGmqf7pKrwMGuqrXXv4ouo39oRy8wAwVQH1z\nLa0jwS18lCapGXmBi8afywUUC+SsU3vuzU20RfFyBVIArCwZebAEpqq8A/ESjdKd\n0TUNgBjPIud8gzlsGQv7t7iiQ9FPWr8t35jjo8iteXGrGjlAsNE6Xhd+d+Xwzybr\nIK7/OGJoNpcffYbswmOebm4QORHFQif3VIXLSwfqb1Ed4JVUdLxXLeNreTz/Rpet\n9QxJgnVJhhxE1uPX6RZaNS+aPhzz70KpEYzUQgR5pc1sRin96AkSlS4QrE/drLLU\n5wNzeNcgU0v4WXVw+fSQlP+lnw6h+UJbCkQOrS6b9+fWnkJ3dmNSp3RJkZA1floM\nb5IQt48XU5+adsDezQImhgmwUVCakZiZw4LN9B1EC7lpQxbjbHuT722dzmNLK7PF\ntB2PYVhpc6g8t+9TpPbnNygU+vpF/zsRsNmm/UVE/NgrkT2anzeD7YFABJKM3LqK\nEWvHaTqjsbaA3kJkFut0K/6uHP38uY9laB4/hyYO5190ghHXYU3vyJtnZ9D+3mnK\nWJzj7XPXtK6EUb3fLk3hgno3IX1L6cjQr/wht0wTiw/pyIsXYPFWha4zFllsS1vT\ngzJvq4WXqbPQytKX5tdSksDB8DNTnrdNldgdMdNmB8XKTwy3FfLFhHqHS3UZcR7v\nAUsHEwJF5D3i3w+IEvl6H/9GKROsvwgAyMVDHPdfw7rjnnNS2z2T8Yc4SGLT+ySo\n74g67yfs37k+nwDXxL+LxNJbnYXNE5EO2gk1LFnF7Gyk+NTcwvXJbfuw6OPnCUe1\nEvWO5VbMijVjOk3taSr7v9u+/hv2y7drK9UVnbVvmNa205iM0m+z4PnY913c9Ptd\nT4Z6xHBKIGH/EJKGHZYjkN80Z3IBophggAbjoUuswKtI6yJLBqUnRJEq48lx4w1Y\nA6rkKN0DWGeUsJkZJFuH9dLDKjVMxXunQF/kgggrQaxIyJgPuGThcx7LdqrAAemG\nU4CD8Rioa6ASITdjuuyW1LfhYqrQav83XE0UiRSyVSixWb+b94mhNNk+lyZbRZ86\ntFPVQAFkMbPF5EcV1dgcC025uRdEk/2PRPg596/JkCrl89Xv0Z19foxmNjPJaACq\nNHrQkJBKNJc8E/LJc9fouzxelexgOeAXiZ0r55N27E+uPNB9LsY4bRbzkE/Vt3ox\nLwX+cVqjeOzu/8iGKB8w+E4DCekDm5xgL4ZFcMfJSepihZD2zf+l1mXPug3L/bZP\nClQyas7r9bEHYMOe+iLZdQ==\n\n-----END CERTIFICATE-----"
first_seen: '2026-02-26T04:50:55.000000Z'
last_seen: '2026-03-13T13:28:48.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-b354-4847-b796-083ff86e5170
company_id:
type: string
example: '5378056'
common_name:
type: string
example: smith.com
organization:
type: string
example: Toy-Stanton
organizational_unit:
type: string
example: null
nullable: true
locality:
type: string
example: null
nullable: true
state:
type: string
example: Alabama
country:
type: string
example: MY
serial:
type: string
example: HPLJATM5OYKQAWJSZ5IQXVTXCKPJYQ3H
not_valid_before:
type: string
example: 20260206T080324Z
not_valid_after:
type: string
example: 20270304T231114Z
value:
type: string
example: "-----BEGIN CERTIFICATE-----\nrSxjudd3gxB1p9ewvy7Q/NhNpvTiyF0csuCSEEtbipNbJ1RH4Gt9dn1d/QP5ugC0\n1csPH1Depd9EqWZik7bpRBxiLBC7lGmqf7pKrwMGuqrXXv4ouo39oRy8wAwVQH1z\nLa0jwS18lCapGXmBi8afywUUC+SsU3vuzU20RfFyBVIArCwZebAEpqq8A/ESjdKd\n0TUNgBjPIud8gzlsGQv7t7iiQ9FPWr8t35jjo8iteXGrGjlAsNE6Xhd+d+Xwzybr\nIK7/OGJoNpcffYbswmOebm4QORHFQif3VIXLSwfqb1Ed4JVUdLxXLeNreTz/Rpet\n9QxJgnVJhhxE1uPX6RZaNS+aPhzz70KpEYzUQgR5pc1sRin96AkSlS4QrE/drLLU\n5wNzeNcgU0v4WXVw+fSQlP+lnw6h+UJbCkQOrS6b9+fWnkJ3dmNSp3RJkZA1floM\nb5IQt48XU5+adsDezQImhgmwUVCakZiZw4LN9B1EC7lpQxbjbHuT722dzmNLK7PF\ntB2PYVhpc6g8t+9TpPbnNygU+vpF/zsRsNmm/UVE/NgrkT2anzeD7YFABJKM3LqK\nEWvHaTqjsbaA3kJkFut0K/6uHP38uY9laB4/hyYO5190ghHXYU3vyJtnZ9D+3mnK\nWJzj7XPXtK6EUb3fLk3hgno3IX1L6cjQr/wht0wTiw/pyIsXYPFWha4zFllsS1vT\ngzJvq4WXqbPQytKX5tdSksDB8DNTnrdNldgdMdNmB8XKTwy3FfLFhHqHS3UZcR7v\nAUsHEwJF5D3i3w+IEvl6H/9GKROsvwgAyMVDHPdfw7rjnnNS2z2T8Yc4SGLT+ySo\n74g67yfs37k+nwDXxL+LxNJbnYXNE5EO2gk1LFnF7Gyk+NTcwvXJbfuw6OPnCUe1\nEvWO5VbMijVjOk3taSr7v9u+/hv2y7drK9UVnbVvmNa205iM0m+z4PnY913c9Ptd\nT4Z6xHBKIGH/EJKGHZYjkN80Z3IBophggAbjoUuswKtI6yJLBqUnRJEq48lx4w1Y\nA6rkKN0DWGeUsJkZJFuH9dLDKjVMxXunQF/kgggrQaxIyJgPuGThcx7LdqrAAemG\nU4CD8Rioa6ASITdjuuyW1LfhYqrQav83XE0UiRSyVSixWb+b94mhNNk+lyZbRZ86\ntFPVQAFkMbPF5EcV1dgcC025uRdEk/2PRPg596/JkCrl89Xv0Z19foxmNjPJaACq\nNHrQkJBKNJc8E/LJc9fouzxelexgOeAXiZ0r55N27E+uPNB9LsY4bRbzkE/Vt3ox\nLwX+cVqjeOzu/8iGKB8w+E4DCekDm5xgL4ZFcMfJSepihZD2zf+l1mXPug3L/bZP\nClQyas7r9bEHYMOe+iLZdQ==\n\n-----END CERTIFICATE-----"
first_seen:
type: string
example: '2026-02-26T04:50:55.000000Z'
last_seen:
type: string
example: '2026-03-13T13:28:48.000000Z'
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: aut
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: HTTP
required: false
schema:
type: string
description: 'Filter by sensor type'
example: HTTP
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: a26c80f2-3796-42a7-be46-4a49ed44eaa1
company_id: fba0df96-fbd7-4a50-b3c8-51a482c51a00
src_ip: 12.225.223.65
dst_ip: 230.240.23.59
sensor: Modbus
timestamp: '2026-04-05T11:34:25.000000Z'
marked_as_seen: false
honeypot_id: a2d02433-d992-46ac-a868-01ffce929577
honeypot_alias: Honeypot-Office-67
src_port: null
src_hostname: null
src_mac: 'C4:68:67:BD:3F:0F'
dst_port: 54574
-
id: a26c80f2-3f0a-4e70-9503-303bf92fac22
company_id: e3058357-d291-4100-b90c-91c3746d3cf4
src_ip: 243.106.86.39
dst_ip: 148.193.18.230
sensor: Modbus
timestamp: '2025-12-06T20:55:49.000000Z'
marked_as_seen: true
honeypot_id: 15753105-199e-486b-b865-27025cb58cd2
honeypot_alias: Honeypot-Branch-72
src_port: 62253
src_hostname: 'Krajcik, Gorczany and Yost'
src_mac: '79:EA:4D:64:F3:30'
dst_port: 6875
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: a26c80f2-3796-42a7-be46-4a49ed44eaa1
company_id: fba0df96-fbd7-4a50-b3c8-51a482c51a00
src_ip: 12.225.223.65
dst_ip: 230.240.23.59
sensor: Modbus
timestamp: '2026-04-05T11:34:25.000000Z'
marked_as_seen: false
honeypot_id: a2d02433-d992-46ac-a868-01ffce929577
honeypot_alias: Honeypot-Office-67
src_port: null
src_hostname: null
src_mac: 'C4:68:67:BD:3F:0F'
dst_port: 54574
-
id: a26c80f2-3f0a-4e70-9503-303bf92fac22
company_id: e3058357-d291-4100-b90c-91c3746d3cf4
src_ip: 243.106.86.39
dst_ip: 148.193.18.230
sensor: Modbus
timestamp: '2025-12-06T20:55:49.000000Z'
marked_as_seen: true
honeypot_id: 15753105-199e-486b-b865-27025cb58cd2
honeypot_alias: Honeypot-Branch-72
src_port: 62253
src_hostname: 'Krajcik, Gorczany and Yost'
src_mac: '79:EA:4D:64:F3:30'
dst_port: 6875
items:
type: object
properties:
id:
type: string
example: a26c80f2-3796-42a7-be46-4a49ed44eaa1
description: 'The unique identifier (UUID) of the detection'
company_id:
type: string
example: fba0df96-fbd7-4a50-b3c8-51a482c51a00
description: 'The company UUID this detection belongs to'
src_ip:
type: string
example: 12.225.223.65
description: 'Source IP address of the attacker'
dst_ip:
type: string
example: 230.240.23.59
description: 'Destination IP address (honeypot)'
sensor:
type: string
example: Modbus
description: 'The sensor type that triggered the detection'
enum:
- SSH
- MSSQL
- Blackhole
- MySQL
- SMB
- FTP
- UPnP
- HTTP
- Ping
- Portscan
- Modbus
timestamp:
type: string
example: '2026-04-05T11:34:25.000000Z'
description: 'When the detection occurred'
marked_as_seen:
type: boolean
example: false
description: 'Whether the detection has been marked as seen'
honeypot_id:
type: string
example: a2d02433-d992-46ac-a868-01ffce929577
description: 'The honeypot UUID that captured this detection'
nullable: true
honeypot_alias:
type: string
example: Honeypot-Office-67
description: 'The alias of the honeypot'
nullable: true
src_port:
type: string
example: null
description: 'Source port number'
nullable: true
src_hostname:
type: string
example: null
description: 'Reverse DNS hostname of source IP'
nullable: true
src_mac:
type: string
example: 'C4:68:67:BD:3F:0F'
description: 'Source MAC address'
nullable: true
dst_port:
type: integer
example: 54574
description: 'Destination port number'
nullable: true
required:
- id
- company_id
- src_ip
- dst_ip
- sensor
- timestamp
- marked_as_seen
- honeypot_id
- honeypot_alias
- src_port
- src_hostname
- src_mac
- dst_port
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Detections
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
properties:
search:
type: string
description: 'Must not be greater than 255 characters.'
example: labe
sensor:
type: string
description: ''
example: FTP
enum:
- SSH
- MSSQL
- Blackhole
- MySQL
- SMB
- FTP
- UPnP
- HTTP
- Ping
- Portscan
- Modbus
honeypot_id:
type: string
description: 'Must be a valid UUID.'
example: 4033def7-3d50-35bf-816e-cddd1634e0c2
honeypot_alias:
type: string
description: 'Must not be greater than 255 characters.'
example: zuamxhcvzqgor
src_ip:
type: string
description: 'Must not be greater than 255 characters.'
example: ratseaseyphzdbnghw
src_hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: khnfhqdjeuljvex
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: 61
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 20.'
example: 8
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: a26c80f2-3796-42a7-be46-4a49ed44eaa1
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: et
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: e28fc79f-d248-4c8b-928e-5e173b3046e9
alias: Honeypot-Datacenter-94
status: 5
activation_status: 1
hostname: honeypot-hdsb-835.example.com
slane_enabled: true
slane_connected: true
paired: true
provisioned: true
dns1: 138.190.233.83
dns2: 71.44.76.132
configured_as: null
notes: null
checked_at: '2026-06-02T03:38:59.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: e28fc79f-d248-4c8b-928e-5e173b3046e9
description: 'The id (uuid) of the Honeypot'
alias:
type: string
example: Honeypot-Datacenter-94
description: 'The alias used to identify the Honeypot'
status:
type: integer
example: 5
description: 'The status of the Honeypot (0 = Offline, 1 = Online, 5 = Rebooting, 6 = Testing)'
enum:
- 0
- 1
- 5
- 6
activation_status:
type: integer
example: 1
description: 'Whether the Honeypot has been activated'
hostname:
type: string
example: honeypot-hdsb-835.example.com
description: 'The hostname of the Honeypot'
slane_enabled:
type: boolean
example: true
description: 'Whether SLANE is enabled on the Honeypot'
nullable: true
slane_connected:
type: boolean
example: true
description: 'Whether the Honeypot is connected using SLANE'
nullable: true
paired:
type: boolean
example: true
description: 'Whether the Honeypot is successfully paired with your environment'
provisioned:
type: boolean
example: true
description: 'Whether the Honeypot is provisioned'
dns1:
type: string
example: 138.190.233.83
description: 'The primary DNS server'
dns2:
type: string
example: 71.44.76.132
description: 'The primary DNS server'
configured_as:
type: string
example: null
description: 'The identity that the Honeypot is configured as'
nullable: true
notes:
type: string
example: null
description: 'Internal notes'
nullable: true
checked_at:
type: string
example: '2026-06-02T03:38:59.000000Z'
description: 'When the Honeypot last connected to your environment'
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
description: 'When the Honeypot was created'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
description: 'When the Honeypot was last updated'
required:
- id
- alias
- status
- activation_status
- hostname
- slane_enabled
- slane_connected
- paired
- provisioned
- dns1
- dns2
- configured_as
- notes
- checked_at
- created_at
- updated_at
tags:
- Honeypots
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
alias:
type: string
description: 'Alias is used to identify the Honeypot (not visible to the attacker).'
example: 'Internal Honeypot'
required:
- alias
/v1/integrations:
get:
summary: 'List Integrations'
operationId: listIntegrations
description: "Retrieve all enabled integrations for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '[{"autotask": {...}, "another_integration": {...}}]'
tags:
- Integrations
'/v1/integrations/{integration}':
post:
summary: 'Enable Integration'
operationId: enableIntegration
description: "Enable a new integration for the current company.\n"
parameters: []
responses:
201:
description: 'integration enabled'
content:
application/json:
schema:
type: object
example:
message: 'Integration enabled successfully'
properties:
message:
type: string
example: 'Integration enabled successfully'
400:
description: 'enable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to enable integration'
properties:
error:
type: string
example: 'Failed to enable integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
get:
summary: 'Show Integration'
operationId: showIntegration
description: "Retrieve details of a specific enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
text/plain:
schema:
type: string
example: '{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'integration not found'
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
-
description: 'integration not enabled'
type: object
example:
error: 'Integration not enabled'
properties:
error:
type: string
example: 'Integration not enabled'
tags:
- Integrations
patch:
summary: 'Update Integration'
operationId: updateIntegration
description: "Update the configuration of an enabled integration for the current company.\n"
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
message: 'Integration updated successfully'
properties:
message:
type: string
example: 'Integration updated successfully'
400:
description: 'update failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to update integration'
properties:
error:
type: string
example: 'Failed to update integration'
404:
description: 'integration not found'
content:
application/json:
schema:
type: object
example:
error: 'Integration not found'
properties:
error:
type: string
example: 'Integration not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
properties:
message:
type: string
example: 'The given data was invalid.'
tags:
- Integrations
delete:
summary: 'Disable Integration'
operationId: disableIntegration
description: "Disable a specific integration for the current company.\n"
parameters: []
responses:
204:
description: 'disable successful'
content:
text/plain:
schema:
type: string
example: ''
400:
description: 'disable failed'
content:
application/json:
schema:
type: object
example:
error: 'Failed to disable integration'
properties:
error:
type: string
example: 'Failed to disable integration'
tags:
- Integrations
parameters:
-
in: path
name: integration
description: 'The name of the integration to enable.'
example: autotask
required: true
schema:
type: string
/v1/me:
get:
summary: 'Retrieve the authenticated user'
operationId: retrieveTheAuthenticatedUser
description: 'Retrieves the authenticated user and its metadata.'
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: company.type
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: company.type
enum:
- company
- company.type
- company.partner
- managingCompany
- managingCompany.type
- managingCompany.partner
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: c9411542-3b3d-468a-8811-0fe90539882a
company_id: '3154995'
managing_company_id: '3154995'
first_name: Jonas
last_name: Lubowitz
two_factor_enabled: false
two_factor_configured: false
email: hillary56@gmail.com
email_verified_at: '2026-08-04T18:43:54Z'
phonenumber: 657.731.1547
phonenumber_verified_at: '2026-08-04T18:43:54Z'
report_interval: weekly
manageable_companies:
-
id: '3154995'
uuid: 537b733f-d08f-46a1-af6c-2bf8ce795359
name: 'Kshlerin, Bashirian and Collins'
role:
name: norole
title: 'No role assigned'
abilities: []
need_to_configure_2fa: false
terms_agreed_at: '2026-08-04T18:43:54Z'
sso_provider: null
created_at: '2026-08-04T18:43:54Z'
updated_at: '2026-08-04T18:43:54Z'
links:
self: 'http://api.securityhive.io/v1/me'
properties:
data:
type: object
properties:
id:
type: string
example: c9411542-3b3d-468a-8811-0fe90539882a
company_id:
type: string
example: '3154995'
managing_company_id:
type: string
example: '3154995'
first_name:
type: string
example: Jonas
last_name:
type: string
example: Lubowitz
two_factor_enabled:
type: boolean
example: false
two_factor_configured:
type: boolean
example: false
email:
type: string
example: hillary56@gmail.com
email_verified_at:
type: string
example: '2026-08-04T18:43:54Z'
phonenumber:
type: string
example: 657.731.1547
phonenumber_verified_at:
type: string
example: '2026-08-04T18:43:54Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '3154995'
uuid: 537b733f-d08f-46a1-af6c-2bf8ce795359
name: 'Kshlerin, Bashirian and Collins'
items:
type: object
properties:
id:
type: string
example: '3154995'
uuid:
type: string
example: 537b733f-d08f-46a1-af6c-2bf8ce795359
name:
type: string
example: 'Kshlerin, Bashirian and Collins'
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-08-04T18:43:54Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:54Z'
updated_at:
type: string
example: '2026-08-04T18:43:54Z'
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-08-04T18:43:54'
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: maiores
required: false
schema:
type: 'Filter by tag name.'
description: ''
example: maiores
-
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: a26c80f2-bcfa-42a5-ba8e-fc1feb9f8e64
company_id: '9032255'
name: d8d36ca7-0f7e-34d0-b425-ae9cfde65f31
description: 'Laudantium animi at soluta soluta porro. Quasi facere non ducimus voluptas. Qui veniam officiis quaerat voluptate odit quasi nam. Quae officia praesentium velit odio qui.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-c062-47a3-b743-f2660893decd
company_id: '4255493'
name: bfaf72b3-427a-3a2c-b2b1-7454a928aea5
description: 'Quia ab quibusdam illum quis ab vel numquam. Suscipit adipisci ut quas blanditiis. Vel ullam dolores ipsum qui. Delectus ex dolorem ea non. Consequatur laboriosam atque quos.'
business_impact: critical
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.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: a26c80f2-bcfa-42a5-ba8e-fc1feb9f8e64
company_id: '9032255'
name: d8d36ca7-0f7e-34d0-b425-ae9cfde65f31
description: 'Laudantium animi at soluta soluta porro. Quasi facere non ducimus voluptas. Qui veniam officiis quaerat voluptate odit quasi nam. Quae officia praesentium velit odio qui.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-c062-47a3-b743-f2660893decd
company_id: '4255493'
name: bfaf72b3-427a-3a2c-b2b1-7454a928aea5
description: 'Quia ab quibusdam illum quis ab vel numquam. Suscipit adipisci ut quas blanditiis. Vel ullam dolores ipsum qui. Delectus ex dolorem ea non. Consequatur laboriosam atque quos.'
business_impact: critical
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f2-bcfa-42a5-ba8e-fc1feb9f8e64
company_id:
type: string
example: '9032255'
name:
type: string
example: d8d36ca7-0f7e-34d0-b425-ae9cfde65f31
description:
type: string
example: 'Laudantium animi at soluta soluta porro. Quasi facere non ducimus voluptas. Qui veniam officiis quaerat voluptate odit quasi nam. Quae officia praesentium velit odio qui.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Tags
post:
summary: 'Create tag.'
operationId: createTag
description: "Will create a new tag for the current company. \n "
parameters: []
responses:
201:
description: 'Successfully created tag'
content:
application/json:
schema:
type: object
example:
data:
id: a26c80f2-c6ac-4bf5-b6af-41de45179f69
company_id: '9804308'
name: 194e560a-747e-39eb-a9bb-80581929d0c8
description: 'Officia aut nihil maiores eius. Rerum et aspernatur laudantium assumenda quo. Est nisi beatae sed temporibus sint illum.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-c6ac-4bf5-b6af-41de45179f69
company_id:
type: string
example: '9804308'
name:
type: string
example: 194e560a-747e-39eb-a9bb-80581929d0c8
description:
type: string
example: 'Officia aut nihil maiores eius. Rerum et aspernatur laudantium assumenda quo. Est nisi beatae sed temporibus sint illum.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: lf
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Explicabo nostrum ea est rerum quia et quo.'
business_impact:
type: string
description: ''
example: high
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: a26c80f2-cd4d-4db8-8a27-b739cb667287
company_id: '1515168'
name: 5d91fd74-4ee0-34fa-beb0-48c2ac16710b
description: 'Possimus non id itaque a. Nesciunt et qui vel sit placeat maxime. Explicabo laboriosam aut ea commodi. Quia et ullam delectus perspiciatis.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-cd4d-4db8-8a27-b739cb667287
company_id:
type: string
example: '1515168'
name:
type: string
example: 5d91fd74-4ee0-34fa-beb0-48c2ac16710b
description:
type: string
example: 'Possimus non id itaque a. Nesciunt et qui vel sit placeat maxime. Explicabo laboriosam aut ea commodi. Quia et ullam delectus perspiciatis.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: a26c80f2-d2d0-40a7-804b-d3e8c2c8f057
company_id: '822764'
name: 10292890-ea00-3c6f-8efe-db8cf5ee40fa
description: 'Blanditiis dolor consequatur quod libero. Nemo aspernatur beatae nulla ad in necessitatibus accusantium. Voluptatem ratione odio alias at porro consequatur.'
business_impact: high
system_tag: true
asset_count: 0
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-d2d0-40a7-804b-d3e8c2c8f057
company_id:
type: string
example: '822764'
name:
type: string
example: 10292890-ea00-3c6f-8efe-db8cf5ee40fa
description:
type: string
example: 'Blanditiis dolor consequatur quod libero. Nemo aspernatur beatae nulla ad in necessitatibus accusantium. Voluptatem ratione odio alias at porro consequatur.'
business_impact:
type: string
example: high
system_tag:
type: boolean
example: true
asset_count:
type: integer
example: 0
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: ehaxycgtkzbimzjfn
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Alias omnis hic repudiandae.'
business_impact:
type: string
description: ''
example: low
enum:
- low
- medium
- high
- critical
delete:
summary: 'Delete tag.'
operationId: deleteTag
description: "Will delete an existing tag \n "
parameters: []
responses:
204:
description: 'tag deleted successfully'
content:
application/json:
schema:
type: array
items:
type: object
example: []
tags:
- Tags
parameters:
-
in: path
name: id
description: 'The ID of the tag.'
example: quia
required: true
schema:
type: string
/v1/users:
get:
summary: 'List Users'
operationId: listUsers
description: "Retrieve all users for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: managingCompany.type
required: false
schema:
type: string
description: 'Include additional relationships (comma separated).'
example: managingCompany.type
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: eebc47e9-d30d-4b70-b9dc-92e60f1ac354
company_id: '5584835'
managing_company_id: '5584835'
first_name: Aaron
last_name: Wehner
two_factor_enabled: false
email: strosin.mallie@gmail.com
email_verified_at: '2026-08-04T18:43:55.000000Z'
phonenumber: '+1 (341) 299-5342'
phonenumber_verified_at: '2026-08-04T18:43:55.000000Z'
report_interval: weekly
manageable_companies:
-
id: '5584835'
uuid: b3054b68-5cff-4082-9253-3bc766375384
name: 'Block, Grady and Kuvalis'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-08-04T18:43:55.000000Z'
sso_provider: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
last_login_at: null
-
id: f178ae23-a07a-463b-9d6b-ae969123e859
company_id: '2598030'
managing_company_id: '2598030'
first_name: Tristian
last_name: Rowe
two_factor_enabled: false
email: annie20@gmail.com
email_verified_at: '2026-08-04T18:43:55.000000Z'
phonenumber: 1-718-593-0697
phonenumber_verified_at: '2026-08-04T18:43:55.000000Z'
report_interval: weekly
manageable_companies:
-
id: '2598030'
uuid: eac187ce-93f9-4c49-bf43-88974421f2da
name: 'Harris PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-08-04T18:43:55.000000Z'
sso_provider: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:56.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: eebc47e9-d30d-4b70-b9dc-92e60f1ac354
company_id: '5584835'
managing_company_id: '5584835'
first_name: Aaron
last_name: Wehner
two_factor_enabled: false
email: strosin.mallie@gmail.com
email_verified_at: '2026-08-04T18:43:55.000000Z'
phonenumber: '+1 (341) 299-5342'
phonenumber_verified_at: '2026-08-04T18:43:55.000000Z'
report_interval: weekly
manageable_companies:
-
id: '5584835'
uuid: b3054b68-5cff-4082-9253-3bc766375384
name: 'Block, Grady and Kuvalis'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-08-04T18:43:55.000000Z'
sso_provider: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
last_login_at: null
-
id: f178ae23-a07a-463b-9d6b-ae969123e859
company_id: '2598030'
managing_company_id: '2598030'
first_name: Tristian
last_name: Rowe
two_factor_enabled: false
email: annie20@gmail.com
email_verified_at: '2026-08-04T18:43:55.000000Z'
phonenumber: 1-718-593-0697
phonenumber_verified_at: '2026-08-04T18:43:55.000000Z'
report_interval: weekly
manageable_companies:
-
id: '2598030'
uuid: eac187ce-93f9-4c49-bf43-88974421f2da
name: 'Harris PLC'
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-08-04T18:43:55.000000Z'
sso_provider: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:56.000000Z'
last_login_at: null
items:
type: object
properties:
id:
type: string
example: eebc47e9-d30d-4b70-b9dc-92e60f1ac354
company_id:
type: string
example: '5584835'
managing_company_id:
type: string
example: '5584835'
first_name:
type: string
example: Aaron
last_name:
type: string
example: Wehner
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: strosin.mallie@gmail.com
email_verified_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
phonenumber:
type: string
example: '+1 (341) 299-5342'
phonenumber_verified_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '5584835'
uuid: b3054b68-5cff-4082-9253-3bc766375384
name: 'Block, Grady and Kuvalis'
items:
type: object
properties:
id:
type: string
example: '5584835'
uuid:
type: string
example: b3054b68-5cff-4082-9253-3bc766375384
name:
type: string
example: 'Block, Grady and Kuvalis'
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
last_login_at:
type: string
example: null
nullable: true
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Users
post:
summary: 'Create User'
operationId: createUser
description: "Create a new user for the current company.\n"
parameters: []
responses:
201:
description: 'user created'
content:
application/json:
schema:
type: object
example:
data:
id: 1
uuid: 00000000-0000-0000-0000-000000000000
properties:
data:
type: object
properties:
id:
type: integer
example: 1
uuid:
type: string
example: 00000000-0000-0000-0000-000000000000
404:
description: 'role not found'
content:
application/json:
schema:
type: object
example:
message: 'role not found'
properties:
message:
type: string
example: 'role not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Must not be greater than 100 characters.'
example: gbvcwdhp
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: glkchszclvpxin
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: jerde.hillary@example.org
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: ''
example: disabled
enum:
- disabled
- weekly
- monthly
- quarterly
role:
type: required
description: 'string Must be a valid role name.'
example: admin
required:
- first_name
- last_name
- email
'/v1/users/{user_uuid}':
get:
summary: 'Retrieve an user'
operationId: retrieveAnUser
description: "Retrieves an user for the current company.\n"
parameters:
-
in: query
name: include
description: 'Include additional relationships (comma separated).'
example: 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: 34e246fb-6977-451a-bace-c7fa5c30eb64
company_id: '4454445'
managing_company_id: '4454445'
first_name: Elijah
last_name: Fadel
two_factor_enabled: false
email: rkilback@gmail.com
email_verified_at: '2026-08-04T18:43:56.000000Z'
phonenumber: +1-680-842-4223
phonenumber_verified_at: '2026-08-04T18:43:56.000000Z'
report_interval: weekly
manageable_companies:
-
id: '4454445'
uuid: 537aa28f-8e5d-4120-a15e-6df3135be2e3
name: Jenkins-Waelchi
role:
name: norole
title: 'No role assigned'
terms_agreed_at: '2026-08-04T18:43:56.000000Z'
sso_provider: null
created_at: '2026-08-04T18:43:56.000000Z'
updated_at: '2026-08-04T18:43:56.000000Z'
last_login_at: null
properties:
data:
type: object
properties:
id:
type: string
example: 34e246fb-6977-451a-bace-c7fa5c30eb64
company_id:
type: string
example: '4454445'
managing_company_id:
type: string
example: '4454445'
first_name:
type: string
example: Elijah
last_name:
type: string
example: Fadel
two_factor_enabled:
type: boolean
example: false
email:
type: string
example: rkilback@gmail.com
email_verified_at:
type: string
example: '2026-08-04T18:43:56.000000Z'
phonenumber:
type: string
example: +1-680-842-4223
phonenumber_verified_at:
type: string
example: '2026-08-04T18:43:56.000000Z'
report_interval:
type: string
example: weekly
manageable_companies:
type: array
example:
-
id: '4454445'
uuid: 537aa28f-8e5d-4120-a15e-6df3135be2e3
name: Jenkins-Waelchi
items:
type: object
properties:
id:
type: string
example: '4454445'
uuid:
type: string
example: 537aa28f-8e5d-4120-a15e-6df3135be2e3
name:
type: string
example: Jenkins-Waelchi
role:
type: object
properties:
name:
type: string
example: norole
title:
type: string
example: 'No role assigned'
terms_agreed_at:
type: string
example: '2026-08-04T18:43:56.000000Z'
sso_provider:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:56.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:56.000000Z'
last_login_at:
type: string
example: null
nullable: true
404:
description: 'user not found'
content:
application/json:
schema:
type: object
example:
message: 'user not found'
properties:
message:
type: string
example: 'user not found'
tags:
- Users
patch:
summary: 'Update an user'
operationId: updateAnUser
description: "Updates an user for the current company.\n"
parameters: []
responses:
204:
description: 'update successful'
content:
text/plain:
schema:
type: string
example: ''
403:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'invalid password'
type: object
example:
message: 'The old password is incorrect.'
properties:
message:
type: string
example: 'The old password is incorrect.'
-
description: 'change password of other user'
type: object
example:
message: 'You are not allowed to change the password of another user.'
properties:
message:
type: string
example: 'You are not allowed to change the password of another user.'
404:
description: 'user not found'
content:
application/json:
schema:
type: object
example:
message: 'user not found'
properties:
message:
type: string
example: 'user not found'
422:
description: 'validation error'
content:
application/json:
schema:
type: object
example:
message: 'phonenumber field contains invalid characters'
properties:
message:
type: string
example: 'phonenumber field contains invalid characters'
tags:
- Users
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'Must not be greater than 100 characters.'
example: John
last_name:
type: string
description: 'Must not be greater than 100 characters.'
example: Doe
email:
type: string
description: 'Must be a valid email address. Must not be greater than 255 characters.'
example: john@doe.com
phonenumber:
type: string
description: 'Must be a valid phone number.'
example: '+31612345678'
nullable: true
report_interval:
type: string
description: 'Must be one of the following values: disabled, weekly, monthly, quarterly.'
example: weekly
role:
type: string
description: 'Must be a valid role name.'
example: admin
parameters:
-
in: path
name: user_uuid
description: 'string The id of the user'
example: ebbe0ad1-6c8f-306d-aade-7a1bc989263e
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: Resolved
required: false
schema:
type: 'Filter vulnerabilities by their status'
description: ''
example: Resolved
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
-
in: query
name: 'filter[threat]'
description: ''
example: High
required: false
schema:
type: 'Filter vulnerabilities by their threat level'
description: ''
example: High
enum:
- Log
- Low
- Medium
- High
- Critical
-
in: query
name: 'filter[scan_id]'
description: ''
example: '123'
required: false
schema:
type: 'Filter vulnerabilities found by given scan_id'
description: ''
example: '123'
-
in: query
name: 'filter[family]'
description: ''
example: 'SQL Injection'
required: false
schema:
type: 'Filter vulnerabilities by their family'
description: ''
example: 'SQL Injection'
-
in: query
name: sort
description: ''
example: epss_score
required: false
schema:
type: 'The column(s) to sort by. Prefix with - for descending order. Eg sort=-name'
description: ''
example: epss_score
enum:
- name
- port
- cvss_base_score
- epss_score
- qod_type
- last_seen
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a26c80f2-5d13-4383-842f-7b82fc890691
asset_id: a26c80f2-51f1-4360-a0e9-20608d4305d2
company_id: '2839908'
vulnerability_definition_id: a26c80f2-5c23-4a32-b1ff-4e35391584f7
vulnerability_definition:
id: a26c80f2-5c23-4a32-b1ff-4e35391584f7
name: 'Remote File Inclusion in alias'
description: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
solution: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
category: 'Remote File Inclusion'
threat_level: High
definition_type: openvas
definition:
id: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name: 'Remote File Inclusion in alias'
family: 'Remote File Inclusion'
reference_urls: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves: 'CVE-2019-4526, CVE-2016-3183'
solution_type: WorkAround
solution_description: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority: Low
qod_type: registry
qod_value: 77
cvss_base_score: 1.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
epss: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
host: 54.11.174.35
hostname: armstrong.com
port: 8080/tcp
details: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
status: Accepted
first_seen: '2026-05-06T19:21:17.000000Z'
last_seen: '2026-05-29T12:33:49.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
name: 'Remote File Inclusion in alias'
description: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
cvss_base_score: 1.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
qod_type: registry
qod_value: 77
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name: 'Remote File Inclusion in alias'
family: 'Remote File Inclusion'
reference_urls: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves: 'CVE-2019-4526, CVE-2016-3183'
solution_type: WorkAround
solution_description: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority: Low
qod_type: registry
qod_value: 77
-
id: a26c80f2-665d-4cd8-afbf-19f25b7a1d20
asset_id: a26c80f2-6131-43b7-831c-8d363080ae33
company_id: '8833155'
vulnerability_definition_id: a26c80f2-65c2-4d6f-aa5d-6c7eb68dcf07
vulnerability_definition:
id: a26c80f2-65c2-4d6f-aa5d-6c7eb68dcf07
name: '6 due to improper sunt handling'
description: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
solution: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
category: '6'
threat_level: Low
definition_type: openvas
definition:
id: a26c80f2-6452-4629-994c-625d6f1f3931
o_id: bcc56717-a242-31ae-9007-f7b274384c74
name: '6 due to improper sunt handling'
family: '6'
reference_urls: 'http://www.medhurst.com/nemo-et-similique-illo-labore-minima-sed-cumque-voluptatum, http://gorczany.com/odit-ullam-velit-saepe-maiores-omnis.html'
reference_cves: 'CVE-2021-1366, CVE-2017-6346'
solution_type: 'Configuration Change'
solution_description: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
summary: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
insight: 'Harum sunt dolorum sit non aliquam. Tenetur delectus quos est corporis vero occaecati minus. Voluptatem soluta beatae recusandae sunt. Ullam dolor asperiores illo iste eos quia.'
affected: 'Quas et pariatur magni aut. Impedit eos veniam accusamus distinctio ut repellat culpa. Maxime et soluta voluptatem. Possimus consequatur ea expedita suscipit nulla recusandae quia et.'
impact: 'Vel veniam laborum amet et vero dolor qui. Architecto doloremque eligendi fugiat saepe qui odit. Nisi occaecati et ut occaecati. Est voluptatem est ut non. Voluptatum quo necessitatibus id dolores. Facere nobis est impedit.'
vuldetect: 'Est animi omnis amet deserunt ut cumque. Quia omnis sed delectus ab inventore sint sapiente. Est ea minus sit et nam incidunt voluptatibus.'
priority: Log
qod_type: remote_active
qod_value: 29
cvss_base_score: 4.6
cvss_base_vector: 'AV:P/AC:L/Au:N/C:P/I:C/A:N'
epss: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
host: 225.67.5.142
hostname: bernhard.com
port: 21/tcp
details: 'Et quisquam asperiores alias quia quo facilis et. Aspernatur quia quod debitis culpa tempora vitae. Hic nobis excepturi asperiores accusantium recusandae.'
status: Resolved
first_seen: '2025-09-03T15:40:39.000000Z'
last_seen: '2026-02-26T12:59:34.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
name: '6 due to improper sunt handling'
description: 'Et quisquam asperiores alias quia quo facilis et. Aspernatur quia quod debitis culpa tempora vitae. Hic nobis excepturi asperiores accusantium recusandae.'
cvss_base_score: 4.6
cvss_base_vector: 'AV:P/AC:L/Au:N/C:P/I:C/A:N'
qod_type: remote_active
qod_value: 29
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a26c80f2-6452-4629-994c-625d6f1f3931
o_id: bcc56717-a242-31ae-9007-f7b274384c74
name: '6 due to improper sunt handling'
family: '6'
reference_urls: 'http://www.medhurst.com/nemo-et-similique-illo-labore-minima-sed-cumque-voluptatum, http://gorczany.com/odit-ullam-velit-saepe-maiores-omnis.html'
reference_cves: 'CVE-2021-1366, CVE-2017-6346'
solution_type: 'Configuration Change'
solution_description: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
summary: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
insight: 'Harum sunt dolorum sit non aliquam. Tenetur delectus quos est corporis vero occaecati minus. Voluptatem soluta beatae recusandae sunt. Ullam dolor asperiores illo iste eos quia.'
affected: 'Quas et pariatur magni aut. Impedit eos veniam accusamus distinctio ut repellat culpa. Maxime et soluta voluptatem. Possimus consequatur ea expedita suscipit nulla recusandae quia et.'
impact: 'Vel veniam laborum amet et vero dolor qui. Architecto doloremque eligendi fugiat saepe qui odit. Nisi occaecati et ut occaecati. Est voluptatem est ut non. Voluptatum quo necessitatibus id dolores. Facere nobis est impedit.'
vuldetect: 'Est animi omnis amet deserunt ut cumque. Quia omnis sed delectus ab inventore sint sapiente. Est ea minus sit et nam incidunt voluptatibus.'
priority: Log
qod_type: remote_active
qod_value: 29
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: a26c80f2-5d13-4383-842f-7b82fc890691
asset_id: a26c80f2-51f1-4360-a0e9-20608d4305d2
company_id: '2839908'
vulnerability_definition_id: a26c80f2-5c23-4a32-b1ff-4e35391584f7
vulnerability_definition:
id: a26c80f2-5c23-4a32-b1ff-4e35391584f7
name: 'Remote File Inclusion in alias'
description: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
solution: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
category: 'Remote File Inclusion'
threat_level: High
definition_type: openvas
definition:
id: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name: 'Remote File Inclusion in alias'
family: 'Remote File Inclusion'
reference_urls: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves: 'CVE-2019-4526, CVE-2016-3183'
solution_type: WorkAround
solution_description: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority: Low
qod_type: registry
qod_value: 77
cvss_base_score: 1.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
epss: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
host: 54.11.174.35
hostname: armstrong.com
port: 8080/tcp
details: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
status: Accepted
first_seen: '2026-05-06T19:21:17.000000Z'
last_seen: '2026-05-29T12:33:49.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
name: 'Remote File Inclusion in alias'
description: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
cvss_base_score: 1.8
cvss_base_vector: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
qod_type: registry
qod_value: 77
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name: 'Remote File Inclusion in alias'
family: 'Remote File Inclusion'
reference_urls: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves: 'CVE-2019-4526, CVE-2016-3183'
solution_type: WorkAround
solution_description: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority: Low
qod_type: registry
qod_value: 77
-
id: a26c80f2-665d-4cd8-afbf-19f25b7a1d20
asset_id: a26c80f2-6131-43b7-831c-8d363080ae33
company_id: '8833155'
vulnerability_definition_id: a26c80f2-65c2-4d6f-aa5d-6c7eb68dcf07
vulnerability_definition:
id: a26c80f2-65c2-4d6f-aa5d-6c7eb68dcf07
name: '6 due to improper sunt handling'
description: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
solution: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
category: '6'
threat_level: Low
definition_type: openvas
definition:
id: a26c80f2-6452-4629-994c-625d6f1f3931
o_id: bcc56717-a242-31ae-9007-f7b274384c74
name: '6 due to improper sunt handling'
family: '6'
reference_urls: 'http://www.medhurst.com/nemo-et-similique-illo-labore-minima-sed-cumque-voluptatum, http://gorczany.com/odit-ullam-velit-saepe-maiores-omnis.html'
reference_cves: 'CVE-2021-1366, CVE-2017-6346'
solution_type: 'Configuration Change'
solution_description: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
summary: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
insight: 'Harum sunt dolorum sit non aliquam. Tenetur delectus quos est corporis vero occaecati minus. Voluptatem soluta beatae recusandae sunt. Ullam dolor asperiores illo iste eos quia.'
affected: 'Quas et pariatur magni aut. Impedit eos veniam accusamus distinctio ut repellat culpa. Maxime et soluta voluptatem. Possimus consequatur ea expedita suscipit nulla recusandae quia et.'
impact: 'Vel veniam laborum amet et vero dolor qui. Architecto doloremque eligendi fugiat saepe qui odit. Nisi occaecati et ut occaecati. Est voluptatem est ut non. Voluptatum quo necessitatibus id dolores. Facere nobis est impedit.'
vuldetect: 'Est animi omnis amet deserunt ut cumque. Quia omnis sed delectus ab inventore sint sapiente. Est ea minus sit et nam incidunt voluptatibus.'
priority: Log
qod_type: remote_active
qod_value: 29
cvss_base_score: 4.6
cvss_base_vector: 'AV:P/AC:L/Au:N/C:P/I:C/A:N'
epss: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
host: 225.67.5.142
hostname: bernhard.com
port: 21/tcp
details: 'Et quisquam asperiores alias quia quo facilis et. Aspernatur quia quod debitis culpa tempora vitae. Hic nobis excepturi asperiores accusantium recusandae.'
status: Resolved
first_seen: '2025-09-03T15:40:39.000000Z'
last_seen: '2026-02-26T12:59:34.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
name: '6 due to improper sunt handling'
description: 'Et quisquam asperiores alias quia quo facilis et. Aspernatur quia quod debitis culpa tempora vitae. Hic nobis excepturi asperiores accusantium recusandae.'
cvss_base_score: 4.6
cvss_base_vector: 'AV:P/AC:L/Au:N/C:P/I:C/A:N'
qod_type: remote_active
qod_value: 29
threat: Low
scanner_id: null
scanner_hostname: null
plugin:
id: a26c80f2-6452-4629-994c-625d6f1f3931
o_id: bcc56717-a242-31ae-9007-f7b274384c74
name: '6 due to improper sunt handling'
family: '6'
reference_urls: 'http://www.medhurst.com/nemo-et-similique-illo-labore-minima-sed-cumque-voluptatum, http://gorczany.com/odit-ullam-velit-saepe-maiores-omnis.html'
reference_cves: 'CVE-2021-1366, CVE-2017-6346'
solution_type: 'Configuration Change'
solution_description: 'Consequatur rerum odit aperiam et rem expedita. Ullam et est officia iste sit ex. Expedita tempora ab quod sint possimus accusamus.'
summary: 'Sit odit non mollitia tenetur. Deserunt nam itaque sit est aut ut. Natus perferendis et vero et possimus.'
insight: 'Harum sunt dolorum sit non aliquam. Tenetur delectus quos est corporis vero occaecati minus. Voluptatem soluta beatae recusandae sunt. Ullam dolor asperiores illo iste eos quia.'
affected: 'Quas et pariatur magni aut. Impedit eos veniam accusamus distinctio ut repellat culpa. Maxime et soluta voluptatem. Possimus consequatur ea expedita suscipit nulla recusandae quia et.'
impact: 'Vel veniam laborum amet et vero dolor qui. Architecto doloremque eligendi fugiat saepe qui odit. Nisi occaecati et ut occaecati. Est voluptatem est ut non. Voluptatum quo necessitatibus id dolores. Facere nobis est impedit.'
vuldetect: 'Est animi omnis amet deserunt ut cumque. Quia omnis sed delectus ab inventore sint sapiente. Est ea minus sit et nam incidunt voluptatibus.'
priority: Log
qod_type: remote_active
qod_value: 29
items:
type: object
properties:
id:
type: string
example: a26c80f2-5d13-4383-842f-7b82fc890691
asset_id:
type: string
example: a26c80f2-51f1-4360-a0e9-20608d4305d2
company_id:
type: string
example: '2839908'
vulnerability_definition_id:
type: string
example: a26c80f2-5c23-4a32-b1ff-4e35391584f7
vulnerability_definition:
type: object
properties:
id:
type: string
example: a26c80f2-5c23-4a32-b1ff-4e35391584f7
name:
type: string
example: 'Remote File Inclusion in alias'
description:
type: string
example: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
solution:
type: string
example: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
category:
type: string
example: 'Remote File Inclusion'
threat_level:
type: string
example: High
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id:
type: string
example: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name:
type: string
example: 'Remote File Inclusion in alias'
family:
type: string
example: 'Remote File Inclusion'
reference_urls:
type: string
example: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves:
type: string
example: 'CVE-2019-4526, CVE-2016-3183'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary:
type: string
example: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight:
type: string
example: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected:
type: string
example: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact:
type: string
example: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect:
type: string
example: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority:
type: string
example: Low
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 77
cvss_base_score:
type: number
example: 1.8
cvss_base_vector:
type: string
example: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
epss:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
host:
type: string
example: 54.11.174.35
hostname:
type: string
example: armstrong.com
port:
type: string
example: 8080/tcp
details:
type: string
example: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
status:
type: string
example: Accepted
first_seen:
type: string
example: '2026-05-06T19:21:17.000000Z'
last_seen:
type: string
example: '2026-05-29T12:33:49.000000Z'
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
name:
type: string
example: 'Remote File Inclusion in alias'
description:
type: string
example: 'Consequatur ea accusamus necessitatibus qui temporibus. Delectus enim nemo cum.'
cvss_base_score:
type: number
example: 1.8
cvss_base_vector:
type: string
example: 'AV:A/AC:H/Au:S/C:C/I:C/A:P'
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 77
threat:
type: string
example: High
scanner_id:
type: string
example: null
nullable: true
scanner_hostname:
type: string
example: null
nullable: true
plugin:
type: object
properties:
id:
type: string
example: a26c80f2-5998-45c9-b47f-1f48e7b761eb
o_id:
type: string
example: 97004158-7d0c-3f0b-9ae5-d7e48dd3e95f
name:
type: string
example: 'Remote File Inclusion in alias'
family:
type: string
example: 'Remote File Inclusion'
reference_urls:
type: string
example: 'http://www.smitham.com/accusamus-quibusdam-vitae-nulla-laborum.html, http://senger.net/in-voluptas-eum-dolor-et'
reference_cves:
type: string
example: 'CVE-2019-4526, CVE-2016-3183'
solution_type:
type: string
example: WorkAround
solution_description:
type: string
example: 'Suscipit esse voluptatibus officiis maxime aut ex aut. Vel eum quia facilis mollitia consequuntur possimus nulla. Est esse eos ipsam quia.'
summary:
type: string
example: 'Vitae quis accusantium porro dolorum. Voluptates quo dolorem labore est iure. Et perspiciatis voluptatem qui ducimus reiciendis accusantium. Doloremque dolor ut quis est sequi.'
insight:
type: string
example: 'Consectetur et accusamus voluptas facilis adipisci qui. Cumque et autem id nulla rerum et. Voluptas illum adipisci dolorum totam nihil. Natus saepe non repudiandae et at blanditiis ea culpa. Voluptatum corrupti praesentium quo ea vel.'
affected:
type: string
example: 'Facilis quia ad et adipisci tempora odio. Labore similique provident tempore facere aspernatur qui eum.'
impact:
type: string
example: 'Fugit fugit molestiae saepe similique consequuntur. Nulla cupiditate minus quos qui. Similique laborum labore accusamus veniam vitae magnam praesentium commodi.'
vuldetect:
type: string
example: 'Aspernatur voluptates est reiciendis aut perspiciatis modi. Ipsam beatae veniam tempore et numquam sapiente iste.'
priority:
type: string
example: Low
qod_type:
type: string
example: registry
qod_value:
type: integer
example: 77
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- Vulnerabilities
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: ''
example: []
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: dyqarisklhhavsmeetapc
threat_level:
type: string
description: ''
example: Log
enum:
- Log
- Low
- Medium
- High
- Critical
host:
type: string
description: 'Must not be greater than 255 characters.'
example: qhbwqcdrzwgoj
hostname:
type: string
description: 'Must not be greater than 255 characters.'
example: ypyhjjtcvajrwhbveobivh
status:
type: string
description: ''
example: Accepted
enum:
- Resolved
- Unresolved
- Accepted
- Detected
- Expired
scan_id:
type: string
description: 'Must be a valid UUID.'
example: 905034a0-2a1b-3685-8d63-c8152a929e27
per_page:
type: integer
description: 'Must be at least 1. Must not be greater than 200.'
example: 7
'/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: a26c80f2-7688-490c-94de-e19bc449bed1
asset_id: a26c80f2-7100-4e1c-92af-927071c56474
company_id: '8039863'
vulnerability_definition_id: a26c80f2-75ef-49d8-8f09-9a0f785cd7cf
vulnerability_definition:
id: a26c80f2-75ef-49d8-8f09-9a0f785cd7cf
name: '5 in exercitationem'
description: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
solution: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
category: '5'
threat_level: High
definition_type: openvas
definition:
id: a26c80f2-747a-4a1d-b321-b006e0a9baf1
o_id: 344cb617-b112-3b6d-8780-08ebddf55a74
name: '5 in exercitationem'
family: '5'
reference_urls: 'http://www.borer.com/autem-vel-eos-omnis-velit-et, http://gorczany.com/animi-molestiae-facilis-cum-temporibus.html'
reference_cves: 'CVE-2016-3191, CVE-2017-7519'
solution_type: 'Configuration Change'
solution_description: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
summary: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
insight: 'Corporis est expedita veniam est laboriosam. Qui itaque vel inventore non quia iste deleniti. Numquam vel recusandae vero numquam nam nihil rerum.'
affected: 'Laboriosam debitis cumque et aut magni aliquid quia. Tenetur rerum expedita et temporibus. Doloribus a odit velit voluptate qui in. Labore nulla architecto et et beatae autem repudiandae. Fugit est alias praesentium molestiae et eaque.'
impact: 'Quia occaecati et eaque fuga quod. Totam occaecati eligendi maiores ipsum quas quo aut. Ad sit adipisci quos aut voluptate possimus ut. At eligendi suscipit placeat reprehenderit porro.'
vuldetect: 'Nobis ut nihil officiis excepturi. Est eum blanditiis cumque exercitationem. Occaecati rerum velit perspiciatis vitae rerum nihil. Molestias est qui ea omnis sit enim soluta.'
priority: Low
qod_type: remote_active
qod_value: 29
cvss_base_score: 0.4
cvss_base_vector: 'AV:P/AC:H/Au:N/C:N/I:P/A:N'
epss: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
host: 32.79.121.239
hostname: considine.com
port: 8080/tcp
details: 'Explicabo et repellat illo necessitatibus voluptatem aspernatur. Fuga magni fuga impedit rerum perferendis quibusdam ea nesciunt.'
status: Resolved
first_seen: '2025-09-08T21:07:51.000000Z'
last_seen: '2026-06-03T08:17:58.000000Z'
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
name: '5 in exercitationem'
description: 'Explicabo et repellat illo necessitatibus voluptatem aspernatur. Fuga magni fuga impedit rerum perferendis quibusdam ea nesciunt.'
cvss_base_score: 0.4
cvss_base_vector: 'AV:P/AC:H/Au:N/C:N/I:P/A:N'
qod_type: remote_active
qod_value: 29
threat: High
scanner_id: null
scanner_hostname: null
plugin:
id: a26c80f2-747a-4a1d-b321-b006e0a9baf1
o_id: 344cb617-b112-3b6d-8780-08ebddf55a74
name: '5 in exercitationem'
family: '5'
reference_urls: 'http://www.borer.com/autem-vel-eos-omnis-velit-et, http://gorczany.com/animi-molestiae-facilis-cum-temporibus.html'
reference_cves: 'CVE-2016-3191, CVE-2017-7519'
solution_type: 'Configuration Change'
solution_description: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
summary: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
insight: 'Corporis est expedita veniam est laboriosam. Qui itaque vel inventore non quia iste deleniti. Numquam vel recusandae vero numquam nam nihil rerum.'
affected: 'Laboriosam debitis cumque et aut magni aliquid quia. Tenetur rerum expedita et temporibus. Doloribus a odit velit voluptate qui in. Labore nulla architecto et et beatae autem repudiandae. Fugit est alias praesentium molestiae et eaque.'
impact: 'Quia occaecati et eaque fuga quod. Totam occaecati eligendi maiores ipsum quas quo aut. Ad sit adipisci quos aut voluptate possimus ut. At eligendi suscipit placeat reprehenderit porro.'
vuldetect: 'Nobis ut nihil officiis excepturi. Est eum blanditiis cumque exercitationem. Occaecati rerum velit perspiciatis vitae rerum nihil. Molestias est qui ea omnis sit enim soluta.'
priority: Low
qod_type: remote_active
qod_value: 29
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-7688-490c-94de-e19bc449bed1
asset_id:
type: string
example: a26c80f2-7100-4e1c-92af-927071c56474
company_id:
type: string
example: '8039863'
vulnerability_definition_id:
type: string
example: a26c80f2-75ef-49d8-8f09-9a0f785cd7cf
vulnerability_definition:
type: object
properties:
id:
type: string
example: a26c80f2-75ef-49d8-8f09-9a0f785cd7cf
name:
type: string
example: '5 in exercitationem'
description:
type: string
example: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
solution:
type: string
example: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
category:
type: string
example: '5'
threat_level:
type: string
example: High
definition_type:
type: string
example: openvas
definition:
type: object
properties:
id:
type: string
example: a26c80f2-747a-4a1d-b321-b006e0a9baf1
o_id:
type: string
example: 344cb617-b112-3b6d-8780-08ebddf55a74
name:
type: string
example: '5 in exercitationem'
family:
type: string
example: '5'
reference_urls:
type: string
example: 'http://www.borer.com/autem-vel-eos-omnis-velit-et, http://gorczany.com/animi-molestiae-facilis-cum-temporibus.html'
reference_cves:
type: string
example: 'CVE-2016-3191, CVE-2017-7519'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
summary:
type: string
example: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
insight:
type: string
example: 'Corporis est expedita veniam est laboriosam. Qui itaque vel inventore non quia iste deleniti. Numquam vel recusandae vero numquam nam nihil rerum.'
affected:
type: string
example: 'Laboriosam debitis cumque et aut magni aliquid quia. Tenetur rerum expedita et temporibus. Doloribus a odit velit voluptate qui in. Labore nulla architecto et et beatae autem repudiandae. Fugit est alias praesentium molestiae et eaque.'
impact:
type: string
example: 'Quia occaecati et eaque fuga quod. Totam occaecati eligendi maiores ipsum quas quo aut. Ad sit adipisci quos aut voluptate possimus ut. At eligendi suscipit placeat reprehenderit porro.'
vuldetect:
type: string
example: 'Nobis ut nihil officiis excepturi. Est eum blanditiis cumque exercitationem. Occaecati rerum velit perspiciatis vitae rerum nihil. Molestias est qui ea omnis sit enim soluta.'
priority:
type: string
example: Low
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
cvss_base_score:
type: number
example: 0.4
cvss_base_vector:
type: string
example: 'AV:P/AC:H/Au:N/C:N/I:P/A:N'
epss:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
host:
type: string
example: 32.79.121.239
hostname:
type: string
example: considine.com
port:
type: string
example: 8080/tcp
details:
type: string
example: 'Explicabo et repellat illo necessitatibus voluptatem aspernatur. Fuga magni fuga impedit rerum perferendis quibusdam ea nesciunt.'
status:
type: string
example: Resolved
first_seen:
type: string
example: '2025-09-08T21:07:51.000000Z'
last_seen:
type: string
example: '2026-06-03T08:17:58.000000Z'
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
name:
type: string
example: '5 in exercitationem'
description:
type: string
example: 'Explicabo et repellat illo necessitatibus voluptatem aspernatur. Fuga magni fuga impedit rerum perferendis quibusdam ea nesciunt.'
cvss_base_score:
type: number
example: 0.4
cvss_base_vector:
type: string
example: 'AV:P/AC:H/Au:N/C:N/I:P/A:N'
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
threat:
type: string
example: High
scanner_id:
type: string
example: null
nullable: true
scanner_hostname:
type: string
example: null
nullable: true
plugin:
type: object
properties:
id:
type: string
example: a26c80f2-747a-4a1d-b321-b006e0a9baf1
o_id:
type: string
example: 344cb617-b112-3b6d-8780-08ebddf55a74
name:
type: string
example: '5 in exercitationem'
family:
type: string
example: '5'
reference_urls:
type: string
example: 'http://www.borer.com/autem-vel-eos-omnis-velit-et, http://gorczany.com/animi-molestiae-facilis-cum-temporibus.html'
reference_cves:
type: string
example: 'CVE-2016-3191, CVE-2017-7519'
solution_type:
type: string
example: 'Configuration Change'
solution_description:
type: string
example: 'Quia praesentium ipsa labore maiores a itaque aut. Libero dignissimos maiores pariatur error voluptatibus. Aspernatur voluptatibus doloribus accusamus reiciendis.'
summary:
type: string
example: 'Non necessitatibus fugiat qui eos nam et eum ut. Est aut ducimus a eligendi qui libero omnis. Hic cumque atque repellat voluptate rerum nemo. Eos et sunt quia culpa repudiandae dolores laudantium odio.'
insight:
type: string
example: 'Corporis est expedita veniam est laboriosam. Qui itaque vel inventore non quia iste deleniti. Numquam vel recusandae vero numquam nam nihil rerum.'
affected:
type: string
example: 'Laboriosam debitis cumque et aut magni aliquid quia. Tenetur rerum expedita et temporibus. Doloribus a odit velit voluptate qui in. Labore nulla architecto et et beatae autem repudiandae. Fugit est alias praesentium molestiae et eaque.'
impact:
type: string
example: 'Quia occaecati et eaque fuga quod. Totam occaecati eligendi maiores ipsum quas quo aut. Ad sit adipisci quos aut voluptate possimus ut. At eligendi suscipit placeat reprehenderit porro.'
vuldetect:
type: string
example: 'Nobis ut nihil officiis excepturi. Est eum blanditiis cumque exercitationem. Occaecati rerum velit perspiciatis vitae rerum nihil. Molestias est qui ea omnis sit enim soluta.'
priority:
type: string
example: Low
qod_type:
type: string
example: remote_active
qod_value:
type: integer
example: 29
tags:
- Vulnerabilities
parameters:
-
in: path
name: id
description: 'The ID of the vulnerability.'
example: deleniti
required: true
schema:
type: string
/v1/webhook-events:
get:
summary: 'List all webhook events'
operationId: listAllWebhookEvents
description: "Lists all webhook events for the authenticated user's company.\n"
parameters:
-
in: query
name: sort
description: 'Sort the results by column(s) (comma separated).'
example: event
required: false
schema:
type: string
description: 'Sort the results by column(s) (comma separated).'
example: event
enum:
- webhook_id
- event
- status
- next_retry_at
-
in: query
name: filter
description: 'Filter the results by column(s) (comma separated).'
example: status
required: false
schema:
type: string
description: 'Filter the results by column(s) (comma separated).'
example: status
enum:
- webhook_id
- event
- status
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: a26c80f2-0fee-437b-89c1-a37c927cc6a8
webhook_id: a26c80f2-0f10-4b23-a128-6e1156d36fe7
event: dolorum
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-140d-4f06-bf04-74feb81cf8b7
webhook_id: a26c80f2-1321-4786-8631-4d67f97d9406
event: sit
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.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: a26c80f2-0fee-437b-89c1-a37c927cc6a8
webhook_id: a26c80f2-0f10-4b23-a128-6e1156d36fe7
event: dolorum
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f2-140d-4f06-bf04-74feb81cf8b7
webhook_id: a26c80f2-1321-4786-8631-4d67f97d9406
event: sit
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f2-0fee-437b-89c1-a37c927cc6a8
webhook_id:
type: string
example: a26c80f2-0f10-4b23-a128-6e1156d36fe7
event:
type: string
example: dolorum
payload:
type: object
properties:
key:
type: string
example: value
status:
type: string
example: pending
retries:
type: integer
example: 0
next_retry_at:
type: string
example: null
nullable: true
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: '/?page=1'
label: '1'
page: 1
active: true
-
url: null
label: 'Next »'
page: null
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
page:
type: string
example: null
nullable: true
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 10
to:
type: integer
example: 2
total:
type: integer
example: 2
tags:
- 'Webhook Events'
/v1/webhook-events/types:
get:
summary: 'List all available webhook event types'
operationId: listAllAvailableWebhookEventTypes
description: "Lists all webhook event types that can be used.\n"
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Webhook Events'
'/v1/webhook-events/{webhookEvent_id}':
get:
summary: 'Retrieve an webhook event'
operationId: retrieveAnWebhookEvent
description: "Retrieves an webhook event for the current company.\n"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: a26c80f2-2098-4ba8-b10c-d9cd2382c853
webhook_id: a26c80f2-1fa6-473c-b839-b7cd08dad64d
event: qui
payload:
key: value
status: pending
retries: 0
next_retry_at: null
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-2098-4ba8-b10c-d9cd2382c853
webhook_id:
type: string
example: a26c80f2-1fa6-473c-b839-b7cd08dad64d
event:
type: string
example: qui
payload:
type: object
properties:
key:
type: string
example: value
status:
type: string
example: pending
retries:
type: integer
example: 0
next_retry_at:
type: string
example: null
nullable: true
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: a26c80f2-0fee-437b-89c1-a37c927cc6a8
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: a26c80f1-f17c-45f7-846e-50ae93a801cd
company_id: 17946ea5-01bc-4c04-bbb8-bbd621cd5748
url: 'https://quigley.com'
description: null
events: []
secret: 5fcccb985cb03136660f510937ed9b754016a98b9ce502a6d5f2a4447d70fcd8
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f1-f638-4c8e-8c18-7942ca5760a8
company_id: 66f01850-2948-4bca-b588-5ac936bafdea
url: 'https://cole.com'
description: null
events: []
secret: 64f7510df977da7e45a93d87a857cb552a9d39df79c0b6a94ff8327705520ff7
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: array
example:
-
id: a26c80f1-f17c-45f7-846e-50ae93a801cd
company_id: 17946ea5-01bc-4c04-bbb8-bbd621cd5748
url: 'https://quigley.com'
description: null
events: []
secret: 5fcccb985cb03136660f510937ed9b754016a98b9ce502a6d5f2a4447d70fcd8
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
-
id: a26c80f1-f638-4c8e-8c18-7942ca5760a8
company_id: 66f01850-2948-4bca-b588-5ac936bafdea
url: 'https://cole.com'
description: null
events: []
secret: 64f7510df977da7e45a93d87a857cb552a9d39df79c0b6a94ff8327705520ff7
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
items:
type: object
properties:
id:
type: string
example: a26c80f1-f17c-45f7-846e-50ae93a801cd
company_id:
type: string
example: 17946ea5-01bc-4c04-bbb8-bbd621cd5748
url:
type: string
example: 'https://quigley.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: 5fcccb985cb03136660f510937ed9b754016a98b9ce502a6d5f2a4447d70fcd8
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
tags:
- Webhooks
post:
summary: 'Create Webhook'
operationId: createWebhook
description: "Create a new webhook for the current company.\n"
parameters: []
responses:
201:
description: 'webhook created'
content:
application/json:
schema:
type: object
example:
data:
id: 00000000-0000-0000-0000-000000000000
properties:
data:
type: object
properties:
id:
type: string
example: 00000000-0000-0000-0000-000000000000
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'url is already used by company'
type: object
example:
message: 'The url has already been taken.'
properties:
message:
type: string
example: 'The url has already been taken.'
-
description: 'validation error'
type: object
example:
message: 'invalid url'
properties:
message:
type: string
example: 'invalid url'
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 'Must be a valid URL. Must not be greater than 2048 characters.'
example: 'https://www.gutmann.info/asperiores-illum-omnis-illo-aliquid-eos-et'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Rerum perspiciatis similique quo quis sit qui id.'
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: a26c80f1-ff24-4c2b-a41c-be675b46687e
company_id: f07a0dda-75e9-4e69-a927-4456da8f404a
url: 'https://cole.com'
description: null
events: []
secret: 3d9fc0905ca9ec052db1023adb12596419fdf95a920abc7fc59d5c38ebc03d51
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f1-ff24-4c2b-a41c-be675b46687e
company_id:
type: string
example: f07a0dda-75e9-4e69-a927-4456da8f404a
url:
type: string
example: 'https://cole.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: 3d9fc0905ca9ec052db1023adb12596419fdf95a920abc7fc59d5c38ebc03d51
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: 'https://renner.com/est-voluptatem-inventore-voluptatem.html'
description:
type: string
description: 'Must not be greater than 255 characters.'
example: 'Placeat ipsam quia aspernatur doloribus id dolores ducimus.'
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: a26c80f1-f17c-45f7-846e-50ae93a801cd
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: a26c80f2-0428-4fae-9628-af9e044e3284
company_id: 192c94c7-e868-4c52-892d-414a65c488de
url: 'https://moore.com'
description: null
events: []
secret: 8cc2bfea5df5b8402a5a9d014b6fa2dfc0af60ed006bd540e11e4840636d9a54
last_sent_at: null
created_at: '2026-08-04T18:43:55.000000Z'
updated_at: '2026-08-04T18:43:55.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: a26c80f2-0428-4fae-9628-af9e044e3284
company_id:
type: string
example: 192c94c7-e868-4c52-892d-414a65c488de
url:
type: string
example: 'https://moore.com'
description:
type: string
example: null
nullable: true
events:
type: array
example: []
secret:
type: string
example: 8cc2bfea5df5b8402a5a9d014b6fa2dfc0af60ed006bd540e11e4840636d9a54
last_sent_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2026-08-04T18:43:55.000000Z'
updated_at:
type: string
example: '2026-08-04T18:43:55.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: a26c80f1-f17c-45f7-846e-50ae93a801cd
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: a26c80f1-f17c-45f7-846e-50ae93a801cd
required: true
schema:
type: string