SecurityHive API Documentation

Postman collection → OpenAPI spec →

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_PERSONAL_ACCESS_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting the dashboard and clicking Generate new token at your profile.

Applications

Manage the applications that have been discovered on your assets.

List applications.

GET
https://api.securityhive.io
/v1/applications
requires authentication

Retrieve all applications for the current company. Look at the 'Retrieve an application' endpoint for more details on the application object.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[vendor]
Filter applications by vendor.
Example:
microsoft
filter[product]
Filter applications by product.
Example:
windows
filter[version]
Filter applications by version.
Example:
1.2.0
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor
Must be one of:
  • cpe
  • vendor
  • product
  • version
Example:
product
include
Include additional relationships (comma separated).
Must be one of:
  • assets
Example:
assets
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/applications?filter%5Bvendor%5D=microsoft&filter%5Bproduct%5D=windows&filter%5Bversion%5D=1.2.0&sort=product&include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91096-fec5-41f9-9fb1-819e80d632ef",
            "cpe": "cpe:2.3:a:apple:ios:*:*:*:*:*:*:*:*",
            "vendor": "Apple",
            "product": "iOS",
            "version": "8.36.5654",
            "update": "sp1",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z"
        },
        {
            "id": "a0a91097-005b-44c7-998b-9efede5b7fe6",
            "cpe": "cpe:2.3:a:oracle:java:*:*:*:*:*:*:*:*",
            "vendor": "Oracle",
            "product": "Java",
            "version": "6.16.7369",
            "update": "patch1",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.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
    }
}

Export applications.

GET
https://api.securityhive.io
/v1/applications/export
requires authentication

Export all applications for the current company in CSV or XLSX format.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

type
The type of export to generate
required
Must be one of:
  • csv
  • xlsx
Example:
csv
filter[vendor]
Filter applications by vendor.
Example:
microsoft
filter[product]
Filter applications by product.
Example:
windows
filter[version]
Filter applications by version.
Example:
1.2.0
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-vendor
Must be one of:
  • cpe
  • vendor
  • product
  • version
Example:
version

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/applications/export?type=csv&filter%5Bvendor%5D=microsoft&filter%5Bproduct%5D=windows&filter%5Bversion%5D=1.2.0&sort=version" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"csv\"
}"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
content-security-policy-report-only: default-src 'self'; script-src 'self' 'nonce-GlWqQx1iFx0s6N0uC5o5iWCV2Av1Tmib3dVwofnx' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-elem 'self' 'nonce-GlWqQx1iFx0s6N0uC5o5iWCV2Av1Tmib3dVwofnx' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; img-src 'self' data: blob: https://*.intercomcdn.com https://*.intercomcdn.eu https://*.intercomassets.eu https://*.intercom-attachments.eu https://www.gravatar.com https://*.tile.openstreetmap.org; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://app.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost:8090; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data: https://*.intercomcdn.com; upgrade-insecure-requests
content-security-policy: frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none';
permissions-policy: geolocation=(), microphone=(), camera=(), fullscreen=()
x-content-type-options: nosniff
cross-origin-resource-policy: same-site
referrer-policy: strict-origin-when-cross-origin
vary: Origin
{
    "message": "Unauthenticated."
}

Retrieve an application.

GET
https://api.securityhive.io
/v1/applications/{id}
requires authentication

Retrieves an by its ID.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the application.

Example:
sit

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • assets
Example:
assets
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/applications/sit?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91097-04ba-4c4d-a0bf-96aedeb4c132",
        "cpe": "cpe:2.3:a:mozilla:seamonkey:*:*:*:*:*:*:*:*",
        "vendor": "Mozilla",
        "product": "SeaMonkey",
        "version": "7.33.1710",
        "update": "update1",
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}

Assets

Manage assets that have been discovered on your network.

List assets.

GET
https://api.securityhive.io
/v1/assets
requires authentication

Retrieve all assets for the current company. Look at the 'Retrieve an asset' endpoint for more details on the asset object.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[name]
Filter assets by name.
Example:
Laptop-1
filter[host]
Filter assets by their IP-address.
Example:
192.168.1.1
filter[mac_address]
Filter assets by their MAC-address.
Example:
3A:5E:D6:95:BF
filter[hostname]
Filter assets by their hostname.
Example:
laptop-1.local
filter[tags][]
Filter assets by their tags.
Example:
New,Old
filter[licensed]
Filter assets by licensed status.
Example:
true,false
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-name
Must be one of:
  • name
  • host
  • last_seen
  • licensed
Example:
last_seen
include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • software
  • tags
  • scans
Example:
certificates
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/assets?filter%5Bname%5D=Laptop-1&filter%5Bhost%5D=192.168.1.1&filter%5Bmac_address%5D=3A%3A5E%3AD6%3A95%3ABF&filter%5Bhostname%5D=laptop-1.local&filter%5Btags%5D%5B%5D=New%2COld&filter%5Blicensed%5D=true%2Cfalse&sort=last_seen&include=certificates" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91096-b196-4eec-8f3e-8e016e19b72c",
            "company_id": "1683498",
            "name": "Mr. Milford O'Kon V",
            "identifier": "C6:28:02:F4:A3:3C",
            "host": "25.153.151.231",
            "mac_address": "C6:28:02:F4:A3:3C",
            "hostname": "bauch.com",
            "operating_system": "est",
            "operating_system_name": "dolorum",
            "first_seen": "1974-05-26T02:16:17.000000Z",
            "last_seen": "2003-07-04T21:18: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": null
        },
        {
            "id": "a0a91096-b569-47fc-af45-f7549b7642e8",
            "company_id": "5347157",
            "name": "Mr. Kenyon Lockman III",
            "identifier": "D1:15:DC:F4:1C:89",
            "host": "42.33.119.81",
            "mac_address": "D1:15:DC:F4:1C:89",
            "hostname": "marks.info",
            "operating_system": "rerum",
            "operating_system_name": "eos",
            "first_seen": "2021-12-17T19:07:14.000000Z",
            "last_seen": "2009-08-27T23:37:30.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "licensed": true,
            "change_license_at": "2026-01-20T02:32:57.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
    }
}

Bulk asset action.

PATCH
https://api.securityhive.io
/v1/assets/actions
requires authentication

Will perform a bulk action on assets (Add Tags, Remove Tags or delete).

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/assets/actions" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"action\": \"removeLicense\",
            \"id\": \"occaecati\",
            \"data\": []
        }
    ]
}"
Example response:
[Empty response]

Create asset.

POST
https://api.securityhive.io
/v1/assets
requires authentication

Will create a new asset for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"izgqjeukwodcmjzeqdtitnlad\",
    \"host\": \"enim\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "a0a91096-c089-4a66-ae61-2a11f1d8b23b",
        "company_id": "2961552",
        "name": "Chris Steuber",
        "identifier": "42:98:D0:69:1F:65",
        "host": "46.162.185.227",
        "mac_address": "42:98:D0:69:1F:65",
        "hostname": "prosacco.info",
        "operating_system": "temporibus",
        "operating_system_name": "iste",
        "first_seen": "2015-05-24T21:40:09.000000Z",
        "last_seen": "1991-11-06T20:12:47.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2026-01-13T04:24:24.000000Z"
    }
}
{
    "message": "host must be unique"
}

Retrieve an asset.

GET
https://api.securityhive.io
/v1/assets/{id}
requires authentication

Retrieves an asset by its ID.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the asset.

Example:
facere

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • software
  • tags
  • scans
Example:
software
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/assets/facere?include=software" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-c5a0-486a-a0eb-f2dc10378483",
        "company_id": "5930311",
        "name": "Mr. Tillman Walsh Jr.",
        "identifier": "04:B3:D2:1C:C2:76",
        "host": "99.139.73.102",
        "mac_address": "04:B3:D2:1C:C2:76",
        "hostname": "bartell.info",
        "operating_system": "pariatur",
        "operating_system_name": "laborum",
        "first_seen": "1982-08-17T02:17:57.000000Z",
        "last_seen": "1973-05-08T14:17:03.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": false,
        "change_license_at": "2026-01-01T09:28:33.000000Z"
    }
}

Update asset.

PATCH
https://api.securityhive.io
/v1/assets/{id}
requires authentication

Will update an existing asset

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the asset.

Example:
qui

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/assets/qui" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"wwngcaj\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "a0a91096-cade-42f7-993e-f0c8070bdc20",
        "company_id": "5792869",
        "name": "Velva Stoltenberg DDS",
        "identifier": "58.169.40.211",
        "host": "58.169.40.211",
        "mac_address": null,
        "hostname": "senger.com",
        "operating_system": "dolorem",
        "operating_system_name": "id",
        "first_seen": "2020-10-21T19:38:33.000000Z",
        "last_seen": "1993-12-17T11:06:29.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2026-01-10T03:12:49.000000Z"
    }
}
{
    "message": "name is required"
}

Delete asset.

DELETE
https://api.securityhive.io
/v1/assets/{id}
requires authentication

Will delete an existing asset

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the asset.

Example:
culpa
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/assets/culpa" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]

Certificates

Manage certificates that have been discovered on your network.

List certificates.

GET
https://api.securityhive.io
/v1/certificates
requires authentication

Retrieve all certificates for the current company. Look at the 'Retrieve a certificate' endpoint for more details on the certificate object.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[common_name]
Filter certificates by their common name.
Example:
test.nl
filter[organization]
Filter certificates by their organization name.
Example:
Test B.V.
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before
Must be one of:
  • not_valid_after
Example:
not_valid_after
include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • applications
  • tags
  • scans
Example:
applications
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates?filter%5Bcommon_name%5D=test.nl&filter%5Borganization%5D=Test+B.V.&sort=not_valid_after&include=applications" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91096-d37a-42a9-9d82-d0410d484194",
            "company_id": "5451258",
            "common_name": "jakubowski.net",
            "organization": null,
            "organizational_unit": "Group",
            "locality": "Herbertbury",
            "state": "Washington",
            "country": "EE",
            "serial": "CU7A4GCXN0QNILWA2ARBIYTEHN5FLCN2",
            "not_valid_before": "20240406T221242Z",
            "not_valid_after": "20261121T022030Z",
            "value": "-----BEGIN CERTIFICATE-----\n9ZIZ9t9lOYlWJUHAB6VAJ2yk1u35tVrmDULBRJx1/FTe68ByEDhjOQ4REnhRooXR\nq0V8KYkKXexnyFS9FEGJQW5QlvQPbzzfpAIdbIOQp3L+1WBCqFAAZR4wTCUsaRUX\ntNEqvXR+xvC8VjISpaaQlEtdpSoV4sCPDXvM2rf0CrZH+z7N4UtghPpLh8/LAEtg\niN2AuYSzlmzrpAEGoXNOypzrOryguft/KPqDVr7o4MKJzTIWcUss6te3pFlXnduu\nIzMAdsO9NpM030xhGIB8ordd5MWRXfodx50mOYgIc/F/JG5ml4twacY5NBvzbRLl\nevRZGTXaeMHOyRfxHxvrYqpd+k9dIV7l/ZdOEVbUVSDYR0v3POmnJW9494DRVjdb\nDsmzaW8Y5YPFvgL4B/VIcPupy+tIEUGWD6+IzNRKeu9Lmo1wIoFgqbSjqzaaZ3lK\ncSDCZexW+KaOkS8AbNsmNf3i+mqh1xaly+/Yt5vGeiEyiu3lfPFggWSdpAkQVVX7\n3rwx40xQZBO5C5a85Kv1HoKq1eCrKk+Uq2aXtKgjimuIQZzayIWUqhAFtCcS3Mco\nXJQQ8qfawR6zpK00yOwXRJEmYyqZ7lTmTMulwfRbsmOZMuh7wofrUfME2Ch6wWUz\nnL3o3m2pkKFQZhdCXMnFAlmoRvIlTScTkvH5yfBq9F5panBIv2drcrEOLoepKGio\nTWUMjfkYCLTlqUuYIO/FNU7oEZR6MFUEVXblh1MEjpqet1t/T6AFsNyxTJ6slLXu\nu/xB294BycUqrXgOOp0lwcKOAo2JbWKJTLyFf2Z8ymijyLezpJ6Y9lnrwAOhPZqK\nSfxjxVm7aC4cTRGDwRGh0g+m9w3NaZ5W8p2KYpjTrzXNDFgsRXjmu/dZbrC5G8++\nDNmq2pdQ/zKusDM/ISIbgcsyjBdegnrdZl+gVsfPJkcgh3O2jLnqFsRZ7F8tSbH8\nShY9plMEjAgqkZ/Bz8tSF+zdrfYlEMhueggUIIJUa+EnzewmsKN+7VM+4drbEJ6T\ntqHxpyAZjhO0pt1f7RqxGHq9nCHDgS8AcpJNNVdbX92vYzuymp7v/ISPINYrKgf3\nJLWB2pBv8usk/AYAiv8vkaksNMZtq2LWRBU3TCcC/P6VCE+3sqyu7ymgyU0VETPT\nT8AOko8JKLcI4zYCbhYL2hLh0wS61ZPHUwl6Z5tkZ5KPGSNEWSgWsPZdisVf5dRW\n5F913ss/KGm3XEGaSLRUx/NWG452eNjXki70X+rMhpfNKQHXccq5dZSfjxGpyquN\nbspVFaiC4czOnKbLEf696Eps48z3wHDIT9zmOmrO1TLgsF2SM21jO7LukmeZVa13\nnGOc8mB8qc/1/b/Da/34Ww==\n\n-----END CERTIFICATE-----",
            "first_seen": "2024-09-11T02:18:36.000000Z",
            "last_seen": "2025-03-26T04:23:11.000000Z",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z"
        },
        {
            "id": "a0a91096-d695-4f7e-bd75-6ef03a7b70e4",
            "company_id": "4808218",
            "common_name": "shanahan.net",
            "organization": "Doyle LLC",
            "organizational_unit": "PLC",
            "locality": "Kshlerinmouth",
            "state": "Maryland",
            "country": "KN",
            "serial": "TVJYHZ7YMU04KHVAYJFSWY9QNEEENLKI",
            "not_valid_before": "20250914T230545Z",
            "not_valid_after": "20251214T005145Z",
            "value": "-----BEGIN CERTIFICATE-----\ndMtXZJdmupYtbKb3y+APEx2lSLo3gvzgzkVNiU7RMUpFzTI8sw0+cMpjIiMSdsUO\n3fqIO/O2JtqH5gdiDK/0+ECO+8K/ZXv8znw4GVcFV+zStOGF833ciyPmNTqd7FXb\n6gniQPo1/gdNNvgCfN50eqVJ8xN5T5KfTEHiFoiuQV3gFFotKyYP1AeGfp2ER0Pt\nS+Zp50ECHGOPsx72yj+fy0Hqunn5mlhfPeu+fwou+XlOh+tgHeo104c71eaoYSxn\nIKt0EL22kWvJ9focLHETer4a/bx7emn3EJ4/2Brc/bG4SCbbWi4RwlH4618Ne2s6\nHQaTLAT0Rl+Zm6dMDIauxIPLSWBe9pvobyOwHteD/WjqIlmKj8e+wkg16utrWcoP\nluCeP5XeDMLDxtcOiBgZFcm6C7u1g3jc+cvWwUtFrbnLWE0WpCXM5iwQYcByRInq\nKKUP7T+h64crkHFmWj/VQLHcIsgQ+q2NrJCRhciiu2nUcRHfCXv/yV8iG8I4I6+D\nMJ8ZCPuaJAJQKVCbN/rVrIuyuvUBnAi4dXFB0pmXFcnNgHNp70Zjf9HsNj8Czmg0\n1NkzXG4Gkovr/Mk2qbVDhVQIPkdTHGY9clQH7CUytRT0jY3Fl7yNyvA4L7caJCEo\nBZZ9ziIM40S9CkGRzmm91Vvx0DhYWsphdS6OmoSvLLwpSKrR13QMUw3TzScXF2Vj\nfL9T3WRvDROctFLEM6o2oMLloZOwZDWWfWYcxp+0+Ew73roA7pe77E3aOqmkC/Is\nZN/ZlhRhLwKvgmZtF5+zAAPqzrD3C713wTt+4t2vZPCOgNnDoqenuR+HVnV809AD\nTpapNdPj3l0/gADmHwnFhtBB9s5jPm8dogI0qmfErMuwy8lILKOeztEb+5N+gS/w\nkoLRNVRE8e0sHYmadAquMaO6nLbn+hf4gmBPl/QsaIpTq34VsCSS72zVk0wNXVIm\nqXk/zb2ko6qY6mg+txanHxHNpTpxkXaNH4SlPuwPLlE4RpUU1x8438U/cR+O08vt\nb3o4NSLI8OuxsUjHVLtMUAjGwgsWlEtOZhbM4pX8+Lc8q/ly0cjhIXQvd3AjITC6\nRS0nQkg1HOEaXtJX20eSU3Xd+DJns5hTxI/wtPDsetwBdrbWU/emVmeY64pdqX7d\neIHJbspRQJFYmW3F72WcgnlP3ewFHNZbGq7dtZF30ncIALZiygG0RO3nhpKrwKFg\nJ8/TOQH2KdscFAMNFDJvm2i8Sdw5YXA0/EYEFRVtea+l8wI6Un+ZOJ9kzxkx0B1P\n4ttoFzpHtc/yes3AWXmsiMqad3CJJpOru9r9ChihQHTMumNKw5aWDwJqQWqqB83G\n4+P8DmZ3ejB6bUwYiG2beg==\n\n-----END CERTIFICATE-----",
            "first_seen": "2026-01-06T14:10:10.000000Z",
            "last_seen": "2026-06-22T20:16:24.000000Z",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.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
    }
}

Export certificates.

GET
https://api.securityhive.io
/v1/certificates/export
requires authentication

Export all certificates for the current company in CSV or XLSX format.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

type
The type of export to generate
required
Must be one of:
  • csv
  • xlsx
Example:
csv
filter[common_name]
Filter certificates by their common name.
Example:
test.nl
filter[organization]
Filter certificates by their organization name.
Example:
Test B.V.
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before
Must be one of:
  • not_valid_after
Example:
not_valid_after
filter
The column(s) to filter by. Eg filter=common_name:test.nl
Must be one of:
  • common_name
  • organization
Example:
organization
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates/export?type=csv&filter%5Bcommon_name%5D=test.nl&filter%5Borganization%5D=Test+B.V.&sort=not_valid_after&filter=organization" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
content-security-policy-report-only: default-src 'self'; script-src 'self' 'nonce-061b0lSCWPmTRRz8QqttJdAzdZTaT9TtwSEXht38' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-elem 'self' 'nonce-061b0lSCWPmTRRz8QqttJdAzdZTaT9TtwSEXht38' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; img-src 'self' data: blob: https://*.intercomcdn.com https://*.intercomcdn.eu https://*.intercomassets.eu https://*.intercom-attachments.eu https://www.gravatar.com https://*.tile.openstreetmap.org; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://app.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost:8090; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data: https://*.intercomcdn.com; upgrade-insecure-requests
content-security-policy: frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none';
permissions-policy: geolocation=(), microphone=(), camera=(), fullscreen=()
x-content-type-options: nosniff
cross-origin-resource-policy: same-site
referrer-policy: strict-origin-when-cross-origin
vary: Origin
{
    "message": "Unauthenticated."
}

Retrieve a certificate.

GET
https://api.securityhive.io
/v1/certificates/{id}
requires authentication

Retrieves an by its ID.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the certificate.

Example:
accusamus

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • applications
  • tags
  • scans
Example:
tags
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates/accusamus?include=tags" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-dd1b-4451-a611-ba8b87784844",
        "company_id": "2396855",
        "common_name": "tromp.net",
        "organization": "Murazik-Stark",
        "organizational_unit": "Ltd",
        "locality": "Rafaelamouth",
        "state": "Rhode Island",
        "country": "EE",
        "serial": "E2O5JLXEHMJU7I8MHS59BDOGHMG3FXGP",
        "not_valid_before": "20250314T044015Z",
        "not_valid_after": "20260528T084655Z",
        "value": "-----BEGIN CERTIFICATE-----\nL4nrWj/PBBeZXfUFitOqc3ufmBS4CUYJ8c2RwQtpWgxs8/avhj+8EWh6i4yAjpF3\nJjrhW0IsmOkOAl3GSiE2tihfQcuwMIDyax0nL6P6+i47+NMrS8JH0hjlPl0v4V1o\nMDVgubKuVn/2PbPIyiIl2nIOiCnC5Ldvl9Mmb4dq0YLI/OpI5zxBLNU/dgHPFybx\nxDA/puAqjEUOKcdm/TMdegxcY045dMFUSHf4ec2Gc6HxCmsPs0nlkaCo6Wxh6wmp\nx19C/NZpqwZxZPb+WdSqBHIf9iMEqvjNjy3NRdS2w8EPiIwfVj24hZwWnF3KQAwG\nL3yfqH1eunUH5Tb4K0E+oHqNHhEFCKBL+9u1qSWdoDfE3LWathEEN4r+XtnFFRFu\nJt/z4vGDvOiXdkAzfUDa4hsQqKnPCvpyISEPQiw2/EGZXghabP//JoPZ/8BeH1XI\naMn3zHrpL4MhAqglBiYi6Ohr02yU1p7P4hY+bAcsFzBdga4EsvivBPrMas+M0shJ\n/yua1+dwdLH1/RqUMrbFa4VYy180Nc/ocos1Qm3rameKJ2Q6WDG/NgHX+BPLFvqE\n5ncb/kXsAxBHl4VxMRO43fp33XK5KuentiNEawCt94dqCUr8IXMVUBBcOEGscJsX\nXJTJUz7MDrqVDl7+chpuucIqe49GmY+tej3993iu9g21TxpN8ulwTQWykZVqXfSz\n/naGqO7H6hOXFMAKOGJNLG/rbdApYYZzx5z3D3U4I98sile78M4ZlunMbYWAyoln\nAOnIf+BtkGLQ+A6BpjPb32N58u19OPWVqUkK3hebYzszNFuBogQjohXyQY/9DMSH\nx2XT+W3NwR90r/igbi1DvfR9I2b4ZRmSBdf5gCRngCZnTU0zZW/on1rna0IVGlKP\nd8NUyeJLFk1fU3OtkXQn1KEXrNdCkpiATN578k3XYcvgA4ROzUHfWFPA1+Eq+hSk\nQqW/4N8hLLcigbT636FwKABxxg7oEWt3zQJc2dvfaCsNtz+gU4LM3woK7PspWNkb\ntE7yuJeZLIwefL+8IBJAjKeoVVtukuRh/hBGzZVU+JfLyHOW2sQAkCqNNdJe2cK5\nFy4A/WuZPagTj6bQfF13yuy9U+LAW7woLJspLjF+7fgDih5cMwWODARNDPoTQc31\nyl4K9ZmgHqjHjSqvj78QGjJyI/nADlNQX/RR8lWyqAlX46Ohjbk3/fKLenVU0FrN\n9+LN3JHnFaXTQmmp+nj53F77s/W5vog0qSCAXobI35eyOObGwwnFeBs2JFR77bD5\nnkwcrgsUiJxfIErbEGm8zKmimHBFVsjvxcUsFc+/IdtKFindE2fLxyFzopgLOWus\n8GVJFVhVdr7y91fWKo26yQ==\n\n-----END CERTIFICATE-----",
        "first_seen": "2025-05-22T16:23:42.000000Z",
        "last_seen": "2025-09-22T21:20:30.000000Z",
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}

Delete certificate.

DELETE
https://api.securityhive.io
/v1/certificates/{id}
requires authentication

Will delete an existing certificate

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the certificate.

Example:
et
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/certificates/et" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]

Detections

Manage your honeypot detections

List detections.

GET
https://api.securityhive.io
/v1/detections
requires authentication

Retrieve all detections for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[search]
string

Search across multiple fields (src_ip, src_hostname, src_mac, dst_ip, sensor, honeypot alias)

Example:
192.168
filter[sensor]
string

Filter by sensor type

Must be one of:
  • SSH
  • MSSQL
  • Blackhole
  • MySQL
  • SMB
  • FTP
  • UPnP
  • HTTP
  • Ping
  • Portscan
  • Modbus
Example:
UPnP
filter[honeypot_id]
string

Filter by honeypot UUID

Example:
550e8400-e29b-41d4-a716-446655440000
filter[honeypot_alias]
string

Filter by honeypot alias (partial match)

Example:
Production
filter[src_ip]
string

Filter by source IP (partial match)

Example:
192.168
filter[src_hostname]
string

Filter by reverse DNS hostname (partial match)

Example:
attacker.example.com
filter[marked_as_seen]
string

Filter by seen status

Must be one of:
  • true
  • false
Example:
true
include
string

Include related resources

Must be one of:
  • events
Example:
events
sort
string

Sort by field (prefix with - for descending)

Must be one of:
  • timestamp
  • -timestamp
Example:
-timestamp
page
integer

Page number

Example:
1
per_page
integer

Results per page (max 20)

Example:
10

Body Parameters

Response Fields

Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/detections?filter%5Bsearch%5D=192.168&filter%5Bsensor%5D=UPnP&filter%5Bhoneypot_id%5D=550e8400-e29b-41d4-a716-446655440000&filter%5Bhoneypot_alias%5D=Production&filter%5Bsrc_ip%5D=192.168&filter%5Bsrc_hostname%5D=attacker.example.com&filter%5Bmarked_as_seen%5D=true&include=events&sort=-timestamp&page=1&per_page=10" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"search\": \"vob\",
        \"honeypot_id\": \"17d89fd3-0a5c-3b25-adf0-6186d96ce7c5\",
        \"honeypot_alias\": \"ygpcpvvnzkhaulua\",
        \"src_ip\": \"uhgzrzcjuokqfp\",
        \"src_hostname\": \"sh\",
        \"marked_as_seen\": \"true\"
    },
    \"include\": \"events\",
    \"page\": 5,
    \"per_page\": 4,
    \"sort\": \"-timestamp\"
}"
Example response:
{
    "data": [
        {
            "id": "a0a91096-5dd1-43eb-a6d7-92d1dcc04670",
            "company_id": "2a2a122d-fec5-44f1-aa57-b406030acab1",
            "src_ip": "95.170.122.208",
            "dst_ip": "220.180.199.166",
            "sensor": "Modbus",
            "timestamp": "2024-06-04T22:42:24.000000Z",
            "marked_as_seen": true,
            "honeypot_id": "4467b3bb-ef1a-4f27-8a7f-83f6cae9f02e",
            "honeypot_alias": "Honeypot-Datacenter-25",
            "src_port": 54757,
            "src_hostname": "Runolfsson Inc",
            "src_mac": null,
            "dst_port": 816
        },
        {
            "id": "a0a91096-64f0-40b2-b3b4-1d7460da0970",
            "company_id": "b461023d-13c5-4031-98c2-3ddfcbdffd1b",
            "src_ip": "163.162.31.233",
            "dst_ip": "179.155.97.244",
            "sensor": "Modbus",
            "timestamp": "2025-07-12T11:06:04.000000Z",
            "marked_as_seen": false,
            "honeypot_id": "b441454e-e8c1-4a94-8a0e-73710c03cf15",
            "honeypot_alias": "Honeypot-Branch-55",
            "src_port": 46414,
            "src_hostname": "Rowe, Considine and Howe",
            "src_mac": null,
            "dst_port": 35022
        }
    ],
    "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
    }
}

Mark a detection as seen.

PATCH
https://api.securityhive.io
/v1/detections/{detection_id}/seen
requires authentication

Mark a single detection as seen. Idempotent - marking an already seen detection will succeed without side effects.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

detection_id
string
required

The ID of the detection.

Example:
a0a91096-5dd1-43eb-a6d7-92d1dcc04670
detection
string
required

The UUID of the detection to mark as seen

Example:
550e8400-e29b-41d4-a716-446655440000
Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/detections/a0a91096-5dd1-43eb-a6d7-92d1dcc04670/seen" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]

Mark multiple detections as seen.

POST
https://api.securityhive.io
/v1/detections/mark-multiple-seen
requires authentication

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.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/detections/mark-multiple-seen" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"detection_ids\": \"[\\\"550e8400-e29b-41d4-a716-446655440000\\\", \\\"550e8400-e29b-41d4-a716-446655440001\\\"]\"
}"
Example response:
[Empty response]

Endpoints

List integration logs

GET
https://api.securityhive.io
/v1/integrations/{integration_id}/logs
requires authentication

Retrieves all logs for a specific integration.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

integration_id
string
required

The ID of the integration.

Example:
nam
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations/nam/logs" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
content-security-policy-report-only: default-src 'self'; script-src 'self' 'nonce-iH0tOJMfTAje5SKba301hkz2rWQijIYxGsJ7OAMy' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-elem 'self' 'nonce-iH0tOJMfTAje5SKba301hkz2rWQijIYxGsJ7OAMy' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; img-src 'self' data: blob: https://*.intercomcdn.com https://*.intercomcdn.eu https://*.intercomassets.eu https://*.intercom-attachments.eu https://www.gravatar.com https://*.tile.openstreetmap.org; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://app.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost:8090; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data: https://*.intercomcdn.com; upgrade-insecure-requests
content-security-policy: frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none';
permissions-policy: geolocation=(), microphone=(), camera=(), fullscreen=()
x-content-type-options: nosniff
cross-origin-resource-policy: same-site
referrer-policy: strict-origin-when-cross-origin
vary: Origin
{
    "message": "Unauthenticated."
}

Honeypots

Manage your honeypots.

Create honeypot.

POST
https://api.securityhive.io
/v1/honeypots
requires authentication

Will create a new honeypot for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Response Fields

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/honeypots" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"alias\": \"Internal Honeypot\"
}"
Example response:
{
    "data": {
        "id": "1f115603-3530-49e3-ad69-1a8fa5a50ec5",
        "alias": "Honeypot-Office-31",
        "status": 0,
        "activation_status": 1,
        "hostname": "honeypot-xfeg-831.example.com",
        "slane_enabled": true,
        "slane_connected": false,
        "paired": false,
        "provisioned": false,
        "dns1": "66.111.171.135",
        "dns2": "81.138.74.127",
        "configured_as": null,
        "notes": null,
        "checked_at": null,
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}

Integrations

APIs for managing integrations

List Integrations

GET
https://api.securityhive.io
/v1/integrations
requires authentication

Retrieve all enabled integrations for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[{"autotask": {...}, "another_integration": {...}}]

Enable Integration

POST
https://api.securityhive.io
/v1/integrations/{integration}
requires authentication

Enable a new integration for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

integration
string
required

The name of the integration to enable.

Example:
autotask
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/integrations/autotask" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "message": "Integration enabled successfully"
}
{
    "error": "Failed to enable integration"
}
{
    "error": "Integration not found"
}
{
    "message": "The given data was invalid."
}

Show Integration

GET
https://api.securityhive.io
/v1/integrations/{integration}
requires authentication

Retrieve details of a specific enabled integration for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

integration
string
required

The name of the integration to retrieve.

Example:
autotask
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations/autotask" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{"id": 1, "company_id": "uuid", "name": "autotask", "config": {...}}
{
    "error": "Integration not found"
}
{
    "error": "Integration not enabled"
}

Update Integration

PATCH
https://api.securityhive.io
/v1/integrations/{integration}
requires authentication

Update the configuration of an enabled integration for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

integration
string
required

The name of the integration to update.

Example:
autotask
Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/integrations/autotask" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "message": "Integration updated successfully"
}
{
    "error": "Failed to update integration"
}
{
    "error": "Integration not found"
}
{
    "message": "The given data was invalid."
}

Disable Integration

DELETE
https://api.securityhive.io
/v1/integrations/{integration}
requires authentication

Disable a specific integration for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

integration
string
required

The name of the integration to disable.

Example:
autotask
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/integrations/autotask" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "error": "Failed to disable integration"
}

Me

APIs for managing the authenticated user

Retrieve the authenticated user

GET
https://api.securityhive.io
/v1/me
requires authentication

Retrieves the authenticated user and its metadata.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

include
string

Include additional relationships (comma separated).

Must be one of:
  • company
  • company.type
  • company.partner
  • managingCompany
  • managingCompany.type
  • managingCompany.partner
Example:
managingCompany
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/me?include=managingCompany" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "8a7af06a-129a-4824-9dbb-cbba4a4b8ddd",
        "company_id": "5502954",
        "managing_company_id": "5502954",
        "first_name": "Vernice",
        "last_name": "Rohan",
        "two_factor_enabled": false,
        "two_factor_configured": false,
        "email": "[email protected]",
        "email_verified_at": "2025-12-23T08:51:21Z",
        "phonenumber": "657-433-6952",
        "phonenumber_verified_at": "2025-12-23T08:51:21Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "5502954",
                "uuid": "7186af9f-f9ec-4fef-ac1a-1116f99bdb1a",
                "name": "Berge, Steuber and Kiehn"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "abilities": [],
        "need_to_configure_2fa": false,
        "terms_agreed_at": "2025-12-23T08:51:21Z",
        "sso_provider": null,
        "created_at": "2025-12-23T08:51:21Z",
        "updated_at": "2025-12-23T08:51:21Z"
    },
    "links": {
        "self": "http://api.securityhive.io/v1/me"
    }
}

Update the authenticated user

PATCH
https://api.securityhive.io
/v1/me
requires authentication

Updates the authenticated user

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/me" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"phonenumber\": \"+31612345678\",
    \"managing_company_id\": \"1\",
    \"report_interval\": \"weekly\",
    \"terms_agreed_at\": \"2025-12-23T08:51:21\",
    \"role\": \"admin\"
}"
Example response:
[Empty response]
{
    "message": "phonenumber field contains invalid characters"
}

Tags

Tags can be used to categorize assets.

List tags.

GET
https://api.securityhive.io
/v1/tags
requires authentication

Retrieve all tags for the current company. Look at the 'Retrieve a tag' endpoint for more details on the tag object.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[name]
Filter by tag name.
Example:
aliquam
filter[business_impact]
Filter by business impact.
Example:
high
filter[system_tag]
Filter tags that are default.
Example:
true
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=business_impact
Must be one of:
  • business_impact
  • name
  • created_at
Example:
name
include
Include additional relationships (comma separated).
Must be one of:
  • assets
Example:
assets
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/tags?filter%5Bname%5D=aliquam&filter%5Bbusiness_impact%5D=high&filter%5Bsystem_tag%5D=1&sort=name&include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91096-e4fa-4006-ac3d-462565380ec4",
            "company_id": "7573017",
            "name": "6b26db34-bc79-3889-aabe-7111ecbc417c",
            "description": "Inventore dolor esse commodi libero natus quia mollitia. Et sit debitis veniam iusto consequatur autem molestiae sed. Et at fuga aut possimus eos eum.",
            "business_impact": "high",
            "system_tag": false,
            "asset_count": 0,
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z"
        },
        {
            "id": "a0a91096-e7e0-44a4-ad15-14c3717ef429",
            "company_id": "8000390",
            "name": "f3c9ca89-99db-3132-b866-72dc95d168fc",
            "description": "Dolorem voluptatem quo quidem consequuntur assumenda id. Dolore fugiat et nemo consequuntur iusto et dolorem. Consectetur animi temporibus qui qui vel illo aspernatur expedita.",
            "business_impact": "low",
            "system_tag": true,
            "asset_count": 0,
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.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
    }
}

Create tag.

POST
https://api.securityhive.io
/v1/tags
requires authentication

Will create a new tag for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/tags" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"rauvsfamzgqsvmtyqfb\",
    \"description\": \"Eos quae dignissimos ea qui qui.\",
    \"business_impact\": \"low\"
}"
Example response:
{
    "data": {
        "id": "a0a91096-ee1c-4831-af71-88771f9b6f4a",
        "company_id": "1352593",
        "name": "60b7e33a-755d-3377-91cc-fcab8d72c7c1",
        "description": "A autem odit autem aut quod. Quod tempora velit alias eum perspiciatis. Aut deleniti at laboriosam excepturi perspiciatis quia. Labore earum aliquam ab aperiam officiis ut.",
        "business_impact": "low",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}
{
    "message": "name is required"
}

Retrieve a tag.

GET
https://api.securityhive.io
/v1/tags/{id}
requires authentication

Retrieves an tag by its ID.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the tag.

Example:
laudantium

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • assets
Example:
assets
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/tags/laudantium?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-f22e-4b53-9038-980cc48784ac",
        "company_id": "391116",
        "name": "7286d5bb-b94c-3549-b80e-ba133f78681a",
        "description": "Eius ut est cupiditate qui id. Qui ipsum enim ut et consectetur. Quo vero ut sunt qui. Iure eum excepturi distinctio dolorum pariatur.",
        "business_impact": "low",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}

Update tag.

PATCH
https://api.securityhive.io
/v1/tags/{id}
requires authentication

Will update an existing tag

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the tag.

Example:
sequi

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/tags/sequi" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qvvefwhih\",
    \"description\": \"Voluptatum dolorem dolorem fugiat dignissimos natus reprehenderit.\",
    \"business_impact\": \"low\"
}"
Example response:
{
    "data": {
        "id": "a0a91096-f70d-4529-867a-e53fef4c4f86",
        "company_id": "3492369",
        "name": "e37f2d9a-1363-3232-bfc1-32a9c8c63626",
        "description": "Autem praesentium rem rerum hic quia. Quo laboriosam ut blanditiis ab velit. Accusantium quia magni placeat. Sunt optio dolorum dolorem qui eum officiis.",
        "business_impact": "medium",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}
{
    "message": "name is required"
}

Delete tag.

DELETE
https://api.securityhive.io
/v1/tags/{id}
requires authentication

Will delete an existing tag

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the tag.

Example:
aut
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/tags/aut" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]

Users

APIs for managing users

List Users

GET
https://api.securityhive.io
/v1/users
requires authentication

Retrieve all users for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

include
string

Include additional relationships (comma separated).

Must be one of:
  • company
  • company.type
  • company.partner
  • managingCompany
  • managingCompany.type
  • managingCompany.partner
Example:
managingCompany
sort
string

Sort the results by column(s) (comma separated).

Must be one of:
  • first_name
  • last_name
  • email
  • phonenumber
  • report_interval
  • created_at
  • two_factor_enabled
  • role.title
Example:
first_name,-last_name
filter
string

Filter the results by column(s) (comma separated).

Must be one of:
  • first_name
  • last_name
  • email
  • phonenumber
  • report_interval
Example:
first_name:John,last_name:Doe
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/users?include=managingCompany&sort=first_name%2C-last_name&filter=first_name%3AJohn%2Clast_name%3ADoe" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "b022dd92-c614-40c5-bd05-93562366640b",
            "company_id": "9363150",
            "managing_company_id": "9363150",
            "first_name": "Jeffery",
            "last_name": "Watsica",
            "two_factor_enabled": false,
            "email": "[email protected]",
            "email_verified_at": "2025-12-23T08:51:22.000000Z",
            "phonenumber": "+1-617-716-9604",
            "phonenumber_verified_at": "2025-12-23T08:51:22.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "9363150",
                    "uuid": "3468966a-fd33-472f-9951-ed71e365a3dd",
                    "name": "Anderson, Doyle and Stoltenberg"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-12-23T08:51:22.000000Z",
            "sso_provider": null,
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z"
        },
        {
            "id": "d22871d8-7a1e-44bb-b695-7d26da645d5f",
            "company_id": "8051429",
            "managing_company_id": "8051429",
            "first_name": "Mia",
            "last_name": "Tremblay",
            "two_factor_enabled": false,
            "email": "[email protected]",
            "email_verified_at": "2025-12-23T08:51:22.000000Z",
            "phonenumber": "(551) 270-2258",
            "phonenumber_verified_at": "2025-12-23T08:51:22.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "8051429",
                    "uuid": "86f03e9a-82dd-4e8c-9996-a7e42473ae8b",
                    "name": "Klein-O'Reilly"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-12-23T08:51:22.000000Z",
            "sso_provider": null,
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.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
    }
}

Create User

POST
https://api.securityhive.io
/v1/users
requires authentication

Create a new user for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/users" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"frr\",
    \"last_name\": \"luymokxwobgtxnul\",
    \"email\": \"[email protected]\",
    \"phonenumber\": \"+31612345678\",
    \"report_interval\": \"disabled\",
    \"role\": \"admin\"
}"
Example response:
{
    "data": {
        "id": 1,
        "uuid": "00000000-0000-0000-0000-000000000000"
    }
}
{
    "message": "role not found"
}
{
    "message": "phonenumber field contains invalid characters"
}

Retrieve an user

GET
https://api.securityhive.io
/v1/users/{user_uuid}
requires authentication

Retrieves an user for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_uuid
string
required

string The id of the user

Example:
f52a0026-9915-3625-b3bd-471baa50a474

Query Parameters

include
string

Include additional relationships (comma separated).

Must be one of:
  • company
  • company.type
  • company.partner
  • managingCompany
  • managingCompany.type
  • managingCompany.partner
Example:
company.type
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/users/f52a0026-9915-3625-b3bd-471baa50a474?include=company.type" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9732f316-f67f-472c-bc8b-e4f15ed317c3",
        "company_id": "1021410",
        "managing_company_id": "1021410",
        "first_name": "Mary",
        "last_name": "Armstrong",
        "two_factor_enabled": false,
        "email": "[email protected]",
        "email_verified_at": "2025-12-23T08:51:23.000000Z",
        "phonenumber": "872.812.4713",
        "phonenumber_verified_at": "2025-12-23T08:51:23.000000Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "1021410",
                "uuid": "0f06c9e2-d80f-4266-96f3-076b704d70f1",
                "name": "Nader Ltd"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "terms_agreed_at": "2025-12-23T08:51:23.000000Z",
        "sso_provider": null,
        "created_at": "2025-12-23T08:51:23.000000Z",
        "updated_at": "2025-12-23T08:51:23.000000Z"
    }
}
{
    "message": "user not found"
}

Update an user

PATCH
https://api.securityhive.io
/v1/users/{user_uuid}
requires authentication

Updates an user for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_uuid
string
required

string The id of the user

Example:
b03ff923-c084-3875-8b19-b683e80d66c9

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/users/b03ff923-c084-3875-8b19-b683e80d66c9" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email\": \"[email protected]\",
    \"phonenumber\": \"+31612345678\",
    \"report_interval\": \"weekly\",
    \"role\": \"admin\"
}"
Example response:
[Empty response]
{
    "message": "The old password is incorrect."
}
{
    "message": "You are not allowed to change the password of another user."
}
{
    "message": "user not found"
}
{
    "message": "phonenumber field contains invalid characters"
}

Vulnerabilities

Manage vulnerabilities that have been discovered on your network.

List vulnerabilities.

GET
https://api.securityhive.io
/v1/vulnerabilities
requires authentication

Retrieve all vulnerabilities for the current company. Look at the 'Retrieve a vulnerability' endpoint for more details on the vulnerability object.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filter[name]
Filter vulnerabilities by their name
Example:
SQL
filter[host]
Filter vulnerabilities found on host
Example:
192.168.1.1
filter[hostname]
Filter vulnerabilities found on hostname
Example:
laptop-1.local
filter[status]
Filter vulnerabilities by their status
Must be one of:
  • Resolved
  • Unresolved
  • Accepted
  • Detected
  • Expired
Example:
Resolved
filter[threat]
Filter vulnerabilities by their threat level
Must be one of:
  • Log
  • Low
  • Medium
  • High
  • Critical
Example:
Low
filter[scan_id]
Filter vulnerabilities found by given scan_id
Example:
123
filter[family]
Filter vulnerabilities by their family
Example:
SQL Injection
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-name
Must be one of:
  • name
  • port
  • cvss_base_score
  • epss_score
  • qod_type
  • last_seen
Example:
cvss_base_score

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities?filter%5Bname%5D=SQL&filter%5Bhost%5D=192.168.1.1&filter%5Bhostname%5D=laptop-1.local&filter%5Bstatus%5D=Resolved&filter%5Bthreat%5D=Low&filter%5Bscan_id%5D=123&filter%5Bfamily%5D=SQL+Injection&sort=cvss_base_score" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"name\": \"afbhposfwthbr\",
        \"threat_level\": \"Medium\",
        \"host\": \"twtppcmjlgfa\",
        \"hostname\": \"chxiitivhkifghtk\",
        \"status\": \"Accepted\",
        \"scan_id\": \"f846b47d-12e5-3f43-b59e-951a8b18aaff\"
    },
    \"per_page\": 9
}"
Example response:
{
    "data": [
        {
            "id": "a0a91096-88e1-4610-b7c6-a2f6f50af3d2",
            "asset_id": "a0a91096-7db7-4e62-8121-1aca82dcef3c",
            "company_id": "3082442",
            "vulnerability_definition_id": "a0a91096-8765-4f3b-850a-6bc9c7377e7b",
            "vulnerability_definition": {
                "id": "a0a91096-8765-4f3b-850a-6bc9c7377e7b",
                "name": "1 exploitable through repellendus manipulation",
                "description": "Molestiae sunt officia facere porro optio fugiat. Enim sit velit vel omnis dolores iste nesciunt. Sit ut recusandae ducimus et placeat rerum labore illo. Consequuntur autem voluptate quas fugit.",
                "solution": "Dolorem non fuga atque magnam eveniet neque ut. Cum et illo accusantium id omnis. Autem nam modi possimus eveniet ut minima eum tempora. Corporis ipsum accusamus dicta quod. Provident dignissimos facilis est est voluptate enim et.",
                "category": "1",
                "threat_level": "Medium",
                "definition_type": "openvas",
                "definition": {
                    "id": "a0a91096-8397-4e5d-8934-211a7367aacf",
                    "o_id": "86db69c0-9c29-3db8-87fd-535a7984230e",
                    "name": "1 exploitable through repellendus manipulation",
                    "family": "1",
                    "reference_urls": "http://hamill.info/, https://www.auer.com/veniam-quia-omnis-neque-magni-aliquam-harum",
                    "reference_cves": "CVE-2023-7637, CVE-2023-2720",
                    "solution_type": "Mitigation",
                    "solution_description": "Dolorem non fuga atque magnam eveniet neque ut. Cum et illo accusantium id omnis. Autem nam modi possimus eveniet ut minima eum tempora. Corporis ipsum accusamus dicta quod. Provident dignissimos facilis est est voluptate enim et.",
                    "summary": "Molestiae sunt officia facere porro optio fugiat. Enim sit velit vel omnis dolores iste nesciunt. Sit ut recusandae ducimus et placeat rerum labore illo. Consequuntur autem voluptate quas fugit.",
                    "insight": "Velit ex minima ducimus recusandae dolorem in placeat. Aspernatur est modi consequatur autem distinctio aliquam. Voluptatem vel nostrum enim cum. Illum tempore amet deleniti aut recusandae fuga.",
                    "affected": "Corrupti omnis officia consectetur consequatur. Animi deserunt blanditiis quam at est. Iste nisi reiciendis quisquam consequatur sint. Eaque similique magni harum.",
                    "impact": "Id dolorem vero et id aut qui perferendis. Consequatur aut soluta corporis adipisci quis. Repellat modi distinctio quia.",
                    "vuldetect": "Est corporis deserunt assumenda iste quia ipsam error. Exercitationem dolorem quas dolores inventore quasi aut ut incidunt. Nam rerum est molestias sit voluptas ipsam autem enim.",
                    "priority": "Log",
                    "qod_type": "exploit",
                    "qod_value": 84
                },
                "cvss_base_score": 0.8,
                "cvss_base_vector": "AV:L/AC:L/Au:N/C:N/I:P/A:P",
                "epss": null,
                "created_at": "2025-12-23T08:51:22.000000Z",
                "updated_at": "2025-12-23T08:51:22.000000Z"
            },
            "host": "99.155.218.71",
            "hostname": "welch.com",
            "port": "54287/tcp",
            "details": "Aliquid commodi hic maxime inventore. Et tenetur beatae qui pariatur sapiente. Porro sit quidem ut placeat nulla nobis qui. Molestias dolorem ipsum molestiae voluptas.",
            "status": "Accepted",
            "first_seen": "2025-03-14T22:19:24.000000Z",
            "last_seen": "2025-04-03T04:40:24.000000Z",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z",
            "name": "1 exploitable through repellendus manipulation",
            "description": "Aliquid commodi hic maxime inventore. Et tenetur beatae qui pariatur sapiente. Porro sit quidem ut placeat nulla nobis qui. Molestias dolorem ipsum molestiae voluptas.",
            "cvss_base_score": 0.8,
            "cvss_base_vector": "AV:L/AC:L/Au:N/C:N/I:P/A:P",
            "qod_type": "exploit",
            "qod_value": 84,
            "threat": "Medium",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "a0a91096-8397-4e5d-8934-211a7367aacf",
                "o_id": "86db69c0-9c29-3db8-87fd-535a7984230e",
                "name": "1 exploitable through repellendus manipulation",
                "family": "1",
                "reference_urls": "http://hamill.info/, https://www.auer.com/veniam-quia-omnis-neque-magni-aliquam-harum",
                "reference_cves": "CVE-2023-7637, CVE-2023-2720",
                "solution_type": "Mitigation",
                "solution_description": "Dolorem non fuga atque magnam eveniet neque ut. Cum et illo accusantium id omnis. Autem nam modi possimus eveniet ut minima eum tempora. Corporis ipsum accusamus dicta quod. Provident dignissimos facilis est est voluptate enim et.",
                "summary": "Molestiae sunt officia facere porro optio fugiat. Enim sit velit vel omnis dolores iste nesciunt. Sit ut recusandae ducimus et placeat rerum labore illo. Consequuntur autem voluptate quas fugit.",
                "insight": "Velit ex minima ducimus recusandae dolorem in placeat. Aspernatur est modi consequatur autem distinctio aliquam. Voluptatem vel nostrum enim cum. Illum tempore amet deleniti aut recusandae fuga.",
                "affected": "Corrupti omnis officia consectetur consequatur. Animi deserunt blanditiis quam at est. Iste nisi reiciendis quisquam consequatur sint. Eaque similique magni harum.",
                "impact": "Id dolorem vero et id aut qui perferendis. Consequatur aut soluta corporis adipisci quis. Repellat modi distinctio quia.",
                "vuldetect": "Est corporis deserunt assumenda iste quia ipsam error. Exercitationem dolorem quas dolores inventore quasi aut ut incidunt. Nam rerum est molestias sit voluptas ipsam autem enim.",
                "priority": "Log",
                "qod_type": "exploit",
                "qod_value": 84
            }
        },
        {
            "id": "a0a91096-953a-4c9e-96ad-ce84fe120eed",
            "asset_id": "a0a91096-8eb7-42ab-931c-b07360de10b1",
            "company_id": "321464",
            "vulnerability_definition_id": "a0a91096-93c8-4dd5-9e54-9cc51e8c6013",
            "vulnerability_definition": {
                "id": "a0a91096-93c8-4dd5-9e54-9cc51e8c6013",
                "name": "7 via facilis input",
                "description": "Id dolorem mollitia et. At commodi ut qui consectetur tenetur. Voluptas blanditiis rerum impedit fugiat.",
                "solution": "Maiores modi nulla totam consequuntur aut at soluta. Veniam sed amet non voluptatem odio perferendis. Libero praesentium nihil repellendus nostrum. Tempore quis magni voluptas amet nostrum fugiat.",
                "category": "7",
                "threat_level": "Critical",
                "definition_type": "openvas",
                "definition": {
                    "id": "a0a91096-9277-41e4-8404-3a6dd13dc6e8",
                    "o_id": "df6d0eac-e56c-3576-8515-3964eb836617",
                    "name": "7 via facilis input",
                    "family": "7",
                    "reference_urls": "https://www.littel.org/aut-dolores-maiores-quia-tenetur-odio, http://www.bayer.com/ipsa-nihil-praesentium-aspernatur-blanditiis-unde-et-at",
                    "reference_cves": "CVE-2017-6737, CVE-2017-4443",
                    "solution_type": "Mitigation",
                    "solution_description": "Maiores modi nulla totam consequuntur aut at soluta. Veniam sed amet non voluptatem odio perferendis. Libero praesentium nihil repellendus nostrum. Tempore quis magni voluptas amet nostrum fugiat.",
                    "summary": "Id dolorem mollitia et. At commodi ut qui consectetur tenetur. Voluptas blanditiis rerum impedit fugiat.",
                    "insight": "Earum quasi necessitatibus voluptate eaque. Voluptas tenetur est laborum nobis repellendus. Consequatur ratione provident sapiente sunt tempore autem.",
                    "affected": "Dolore quia vel dicta assumenda hic recusandae. Voluptates aliquid qui eos corrupti et. Dolores qui quia voluptas asperiores.",
                    "impact": "Harum atque et dolorum alias totam dolorum doloribus et. Aut voluptatem neque ipsam cupiditate. Enim molestiae sapiente tempore voluptates at libero dolorem. Praesentium minus sed mollitia illum ut. Rerum dolore velit rem.",
                    "vuldetect": "Est repellendus architecto vero non repudiandae exercitationem. Et harum velit eos quas ad. Exercitationem molestias ut molestiae magni. Ut cumque consectetur quia quibusdam.",
                    "priority": "Critical",
                    "qod_type": "remote_active",
                    "qod_value": 89
                },
                "cvss_base_score": 7.9,
                "cvss_base_vector": "AV:N/AC:H/Au:S/C:C/I:P/A:P",
                "epss": null,
                "created_at": "2025-12-23T08:51:22.000000Z",
                "updated_at": "2025-12-23T08:51:22.000000Z"
            },
            "host": "15.179.227.50",
            "hostname": "hammes.com",
            "port": "443/tcp",
            "details": "Et esse laboriosam qui non. Animi ut nesciunt sed dolorem. Porro nobis quia et.",
            "status": "Unresolved",
            "first_seen": "2025-01-01T13:12:37.000000Z",
            "last_seen": "2025-03-14T04:20:06.000000Z",
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z",
            "name": "7 via facilis input",
            "description": "Et esse laboriosam qui non. Animi ut nesciunt sed dolorem. Porro nobis quia et.",
            "cvss_base_score": 7.9,
            "cvss_base_vector": "AV:N/AC:H/Au:S/C:C/I:P/A:P",
            "qod_type": "remote_active",
            "qod_value": 89,
            "threat": "Critical",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "a0a91096-9277-41e4-8404-3a6dd13dc6e8",
                "o_id": "df6d0eac-e56c-3576-8515-3964eb836617",
                "name": "7 via facilis input",
                "family": "7",
                "reference_urls": "https://www.littel.org/aut-dolores-maiores-quia-tenetur-odio, http://www.bayer.com/ipsa-nihil-praesentium-aspernatur-blanditiis-unde-et-at",
                "reference_cves": "CVE-2017-6737, CVE-2017-4443",
                "solution_type": "Mitigation",
                "solution_description": "Maiores modi nulla totam consequuntur aut at soluta. Veniam sed amet non voluptatem odio perferendis. Libero praesentium nihil repellendus nostrum. Tempore quis magni voluptas amet nostrum fugiat.",
                "summary": "Id dolorem mollitia et. At commodi ut qui consectetur tenetur. Voluptas blanditiis rerum impedit fugiat.",
                "insight": "Earum quasi necessitatibus voluptate eaque. Voluptas tenetur est laborum nobis repellendus. Consequatur ratione provident sapiente sunt tempore autem.",
                "affected": "Dolore quia vel dicta assumenda hic recusandae. Voluptates aliquid qui eos corrupti et. Dolores qui quia voluptas asperiores.",
                "impact": "Harum atque et dolorum alias totam dolorum doloribus et. Aut voluptatem neque ipsam cupiditate. Enim molestiae sapiente tempore voluptates at libero dolorem. Praesentium minus sed mollitia illum ut. Rerum dolore velit rem.",
                "vuldetect": "Est repellendus architecto vero non repudiandae exercitationem. Et harum velit eos quas ad. Exercitationem molestias ut molestiae magni. Ut cumque consectetur quia quibusdam.",
                "priority": "Critical",
                "qod_type": "remote_active",
                "qod_value": 89
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Retrieve a vulnerability.

GET
https://api.securityhive.io
/v1/vulnerabilities/{id}
requires authentication

Retrieves a vulnerability by its ID.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the vulnerability.

Example:
ratione
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities/ratione" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-a493-49dc-b257-c06284cef3a6",
        "asset_id": "a0a91096-9fd7-4888-b7fd-7979a8efe7f9",
        "company_id": "5026181",
        "vulnerability_definition_id": "a0a91096-a40c-48cf-8dc5-65b135f338f9",
        "vulnerability_definition": {
            "id": "a0a91096-a40c-48cf-8dc5-65b135f338f9",
            "name": "1 exploitable through modi manipulation",
            "description": "Ipsum asperiores reprehenderit voluptatem quia molestiae molestias architecto. Odio reprehenderit recusandae placeat velit vel minus harum dolore. Esse ipsum laudantium sit alias eius velit voluptatem.",
            "solution": "Modi architecto dolores ea ad iste error id. Consequatur laudantium quae voluptatem quia eum sit non totam. Est et repudiandae sit reprehenderit.",
            "category": "1",
            "threat_level": "Low",
            "definition_type": "openvas",
            "definition": {
                "id": "a0a91096-a2c2-464c-930a-315fc08cb59b",
                "o_id": "2b2a5dd4-70cf-3207-b4ed-046c482329b0",
                "name": "1 exploitable through modi manipulation",
                "family": "1",
                "reference_urls": "https://hoeger.com/et-ut-harum-officia-iure-quod-quaerat-quis-omnis.html, http://mraz.com/et-et-ut-reiciendis-tempore-quisquam-qui-dolores",
                "reference_cves": "CVE-2020-9803, CVE-2017-2954",
                "solution_type": "Configuration Change",
                "solution_description": "Modi architecto dolores ea ad iste error id. Consequatur laudantium quae voluptatem quia eum sit non totam. Est et repudiandae sit reprehenderit.",
                "summary": "Ipsum asperiores reprehenderit voluptatem quia molestiae molestias architecto. Odio reprehenderit recusandae placeat velit vel minus harum dolore. Esse ipsum laudantium sit alias eius velit voluptatem.",
                "insight": "Et ad maxime dolorum voluptatem rerum voluptatem quos. Dolor sapiente dolore iusto aut maxime nulla fugiat et. Beatae cupiditate dolor voluptate exercitationem et. Consectetur dolorem a sunt architecto dolor.",
                "affected": "Id soluta autem dolores quo et. Et ut quia atque modi nostrum officia quia. Laboriosam sunt consectetur quis est eius rerum. Ratione saepe quibusdam dignissimos sed. Et voluptatem iure culpa cumque et totam pariatur.",
                "impact": "Qui consequuntur temporibus est omnis illum. Voluptatem quia doloribus dolor modi aut molestiae dolores. Exercitationem ut ut dolor ducimus atque omnis.",
                "vuldetect": "Facere incidunt dolorem illo. Ducimus maiores officia quis hic voluptas qui. Dolorum quibusdam voluptatem cum error iste repellendus aut aliquam.",
                "priority": "Low",
                "qod_type": "exploit",
                "qod_value": 19
            },
            "cvss_base_score": 4.4,
            "cvss_base_vector": "AV:N/AC:H/Au:N/C:N/I:C/A:C",
            "epss": null,
            "created_at": "2025-12-23T08:51:22.000000Z",
            "updated_at": "2025-12-23T08:51:22.000000Z"
        },
        "host": "1.250.177.22",
        "hostname": "kuhlman.com",
        "port": "49241/tcp",
        "details": "Labore eveniet qui sed ut non sint quo. At aliquam laboriosam adipisci ducimus voluptas. Officia eligendi reiciendis eius animi suscipit ea ea.",
        "status": "Unresolved",
        "first_seen": "2025-04-27T22:48:58.000000Z",
        "last_seen": "2025-06-04T17:06:31.000000Z",
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z",
        "name": "1 exploitable through modi manipulation",
        "description": "Labore eveniet qui sed ut non sint quo. At aliquam laboriosam adipisci ducimus voluptas. Officia eligendi reiciendis eius animi suscipit ea ea.",
        "cvss_base_score": 4.4,
        "cvss_base_vector": "AV:N/AC:H/Au:N/C:N/I:C/A:C",
        "qod_type": "exploit",
        "qod_value": 19,
        "threat": "Low",
        "scanner_id": null,
        "scanner_hostname": null,
        "plugin": {
            "id": "a0a91096-a2c2-464c-930a-315fc08cb59b",
            "o_id": "2b2a5dd4-70cf-3207-b4ed-046c482329b0",
            "name": "1 exploitable through modi manipulation",
            "family": "1",
            "reference_urls": "https://hoeger.com/et-ut-harum-officia-iure-quod-quaerat-quis-omnis.html, http://mraz.com/et-et-ut-reiciendis-tempore-quisquam-qui-dolores",
            "reference_cves": "CVE-2020-9803, CVE-2017-2954",
            "solution_type": "Configuration Change",
            "solution_description": "Modi architecto dolores ea ad iste error id. Consequatur laudantium quae voluptatem quia eum sit non totam. Est et repudiandae sit reprehenderit.",
            "summary": "Ipsum asperiores reprehenderit voluptatem quia molestiae molestias architecto. Odio reprehenderit recusandae placeat velit vel minus harum dolore. Esse ipsum laudantium sit alias eius velit voluptatem.",
            "insight": "Et ad maxime dolorum voluptatem rerum voluptatem quos. Dolor sapiente dolore iusto aut maxime nulla fugiat et. Beatae cupiditate dolor voluptate exercitationem et. Consectetur dolorem a sunt architecto dolor.",
            "affected": "Id soluta autem dolores quo et. Et ut quia atque modi nostrum officia quia. Laboriosam sunt consectetur quis est eius rerum. Ratione saepe quibusdam dignissimos sed. Et voluptatem iure culpa cumque et totam pariatur.",
            "impact": "Qui consequuntur temporibus est omnis illum. Voluptatem quia doloribus dolor modi aut molestiae dolores. Exercitationem ut ut dolor ducimus atque omnis.",
            "vuldetect": "Facere incidunt dolorem illo. Ducimus maiores officia quis hic voluptas qui. Dolorum quibusdam voluptatem cum error iste repellendus aut aliquam.",
            "priority": "Low",
            "qod_type": "exploit",
            "qod_value": 19
        }
    }
}

Webhook Events

APIs for managing webhook events

List all webhook events

GET
https://api.securityhive.io
/v1/webhook-events
requires authentication

Lists all webhook events for the authenticated user's company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

sort
string

Sort the results by column(s) (comma separated).

Must be one of:
  • webhook_id
  • event
  • status
  • next_retry_at
Example:
status
filter
string

Filter the results by column(s) (comma separated).

Must be one of:
  • webhook_id
  • event
  • status
Example:
event
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events?sort=status&filter=event" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91096-33bd-430a-b36e-aa861d26d285",
            "webhook_id": "a0a91096-32d8-4ab1-8e64-857bf22ad6d2",
            "event": "rerum",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-12-23T08:51:21.000000Z",
            "updated_at": "2025-12-23T08:51:21.000000Z"
        },
        {
            "id": "a0a91096-37da-45ec-82bb-f6f1ce462d1a",
            "webhook_id": "a0a91096-3700-48a8-a1a5-c331bb88c3aa",
            "event": "sit",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-12-23T08:51:21.000000Z",
            "updated_at": "2025-12-23T08:51:21.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
    }
}

List all available webhook event types

GET
https://api.securityhive.io
/v1/webhook-events/types
requires authentication

Lists all webhook event types that can be used.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events/types" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
content-security-policy-report-only: default-src 'self'; script-src 'self' 'nonce-9fAZnzmPhtHXhtBZcsGxjJEiPlx9qWav5wyUObZa' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-elem 'self' 'nonce-9fAZnzmPhtHXhtBZcsGxjJEiPlx9qWav5wyUObZa' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com https://unpkg.com https://cdn.jsdelivr.net https://medv.io https://assets.calendly.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com https://unpkg.com; img-src 'self' data: blob: https://*.intercomcdn.com https://*.intercomcdn.eu https://*.intercomassets.eu https://*.intercom-attachments.eu https://www.gravatar.com https://*.tile.openstreetmap.org; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://app.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost:8090; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data: https://*.intercomcdn.com; upgrade-insecure-requests
content-security-policy: frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com https://calendly.com; frame-ancestors 'none';
permissions-policy: geolocation=(), microphone=(), camera=(), fullscreen=()
x-content-type-options: nosniff
cross-origin-resource-policy: same-site
referrer-policy: strict-origin-when-cross-origin
vary: Origin
{
    "message": "Unauthenticated."
}

Retrieve an webhook event

GET
https://api.securityhive.io
/v1/webhook-events/{webhookEvent_id}
requires authentication

Retrieves an webhook event for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhookEvent_id
string
required

The ID of the webhookEvent.

Example:
a0a91096-33bd-430a-b36e-aa861d26d285
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events/a0a91096-33bd-430a-b36e-aa861d26d285" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-4698-491a-92cb-3ab3b9a8d11b",
        "webhook_id": "a0a91096-45e1-4775-b325-8364ea27cbbc",
        "event": "et",
        "payload": {
            "key": "value"
        },
        "status": "pending",
        "retries": 0,
        "next_retry_at": null,
        "last_sent_at": null,
        "created_at": "2025-12-23T08:51:22.000000Z",
        "updated_at": "2025-12-23T08:51:22.000000Z"
    }
}
{
    "message": "webhook event not found"
}

Webhooks

APIs for managing webhooks

List all webhooks

GET
https://api.securityhive.io
/v1/webhooks
requires authentication

Lists all webhooks for the authenticated user's company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a0a91095-ff78-449c-bfbd-ac3446a3af4b",
            "company_id": "13f554c4-2b3f-4c5d-a16d-cb708a6f3d04",
            "url": "https://nolan.net",
            "description": null,
            "events": [],
            "secret": "74a66f4f80636f321737c8ac9ea59d1f34dbbf0f4ef0d3381392b2c23a1e2a3b",
            "last_sent_at": null,
            "created_at": "2025-12-23T08:51:21.000000Z",
            "updated_at": "2025-12-23T08:51:21.000000Z"
        },
        {
            "id": "a0a91096-03cc-4543-8429-d1c3d714f5ae",
            "company_id": "87f82b53-4e38-4d12-9b9f-ca79f24ed324",
            "url": "https://larson.info",
            "description": null,
            "events": [],
            "secret": "62cf53b3905dae8fdc5bb5d59e47827d695118d35e2dfa14694d17f9350a78c8",
            "last_sent_at": null,
            "created_at": "2025-12-23T08:51:21.000000Z",
            "updated_at": "2025-12-23T08:51:21.000000Z"
        }
    ]
}

Create Webhook

POST
https://api.securityhive.io
/v1/webhooks
requires authentication

Create a new webhook for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.beatty.info\\/eligendi-molestias-aut-laudantium-laboriosam\",
    \"description\": \"Recusandae excepturi sapiente ab aut.\"
}"
Example response:
{
    "data": {
        "id": "00000000-0000-0000-0000-000000000000"
    }
}
{
    "message": "The url has already been taken."
}
{
    "message": "invalid url"
}

Retrieve a webhook

GET
https://api.securityhive.io
/v1/webhooks/{webhook_id}
requires authentication

Retrieves a webhook for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhook_id
string
required

The ID of the webhook.

Example:
a0a91095-ff78-449c-bfbd-ac3446a3af4b
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhooks/a0a91095-ff78-449c-bfbd-ac3446a3af4b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-0bfd-44ed-8c7a-8d104e1bcd19",
        "company_id": "94da361a-90f5-4048-aa8d-6f79edb572d6",
        "url": "https://johns.com",
        "description": null,
        "events": [],
        "secret": "3f058125be0f9424402cf41842a31b313fa00a7ea1bf9a57103d38f64ac8b15c",
        "last_sent_at": null,
        "created_at": "2025-12-23T08:51:21.000000Z",
        "updated_at": "2025-12-23T08:51:21.000000Z"
    }
}
{
    "message": "webhook not found"
}

Rotate webhook secret

POST
https://api.securityhive.io
/v1/webhooks/{webhook_id}/rotate-secret
requires authentication

Rotates the secret for the webhook.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhook_id
string
required

The ID of the webhook.

Example:
a0a91095-ff78-449c-bfbd-ac3446a3af4b
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/a0a91095-ff78-449c-bfbd-ac3446a3af4b/rotate-secret" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a0a91096-1076-48bd-b484-7912d57999b5",
        "company_id": "e8c2e8e6-010b-4df3-9719-4c9a4c0b6df7",
        "url": "https://homenick.biz",
        "description": null,
        "events": [],
        "secret": "2ff3a632aa69e6e04cc26fb78ca928255dd94e9b2de0f9135726edcc3e799431",
        "last_sent_at": null,
        "created_at": "2025-12-23T08:51:21.000000Z",
        "updated_at": "2025-12-23T08:51:21.000000Z"
    }
}
{
    "message": "webhook not found"
}

Test a webhook

POST
https://api.securityhive.io
/v1/webhooks/{webhook_id}/test
requires authentication

Tests the webhook by sending a test event.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhook_id
string
required

The ID of the webhook.

Example:
a0a91095-ff78-449c-bfbd-ac3446a3af4b
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/a0a91095-ff78-449c-bfbd-ac3446a3af4b/test" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "webhook not found"
}

Update a webhook

PATCH
https://api.securityhive.io
/v1/webhooks/{webhook_id}
requires authentication

Updates a webhook for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhook_id
string
required

The ID of the webhook.

Example:
a0a91095-ff78-449c-bfbd-ac3446a3af4b

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/webhooks/a0a91095-ff78-449c-bfbd-ac3446a3af4b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/www.okeefe.info\\/error-facere-consequuntur-aut-nihil-qui-culpa-fuga-commodi\",
    \"description\": \"Temporibus eum quidem est fugiat.\"
}"
Example response:
{
    "message": "webhook not found"
}
{
    "message": "The url has already been taken."
}
{
    "message": "invalid url"
}

Delete an webhook

DELETE
https://api.securityhive.io
/v1/webhooks/{webhook_id}
requires authentication

Deletes an webhook for the current company.

Headers

Authorization
Example:
Bearer {YOUR_PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhook_id
string
required

The ID of the webhook.

Example:
a0a91095-ff78-449c-bfbd-ac3446a3af4b
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/webhooks/a0a91095-ff78-449c-bfbd-ac3446a3af4b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "webhook not found"
}