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": "a17a46d5-f6f1-4f50-b7d4-e606095a074a",
            "cpe": "cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*",
            "vendor": "Google",
            "product": "Workspace",
            "version": "13.53.431",
            "update": "sp1",
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        },
        {
            "id": "a17a46d5-f819-4a3e-907f-9845a5c22fc8",
            "cpe": "cpe:2.3:a:google:workspace:*:*:*:*:*:*:*:*",
            "vendor": "Google",
            "product": "Workspace",
            "version": "18.10.9956",
            "update": "sp2",
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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:
vendor

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=vendor" \
    --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-LEChDzqMh2kVbQBKiYqcpPXpCc7IQJJsA6ZuzLzX' 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-LEChDzqMh2kVbQBKiYqcpPXpCc7IQJJsA6ZuzLzX' 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:
est

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/est?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-fb91-4c08-9582-236842e1f6aa",
        "cpe": "cpe:2.3:a:microsoft:windows:*:*:*:*:*:*:*:*",
        "vendor": "Microsoft",
        "product": "Windows",
        "version": "20.94.2287",
        "update": "sp2",
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z"
    }
}

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:
host
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?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=host&include=software" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-bc58-4b35-bf22-0715ccb5bd56",
            "company_id": "294250",
            "name": "Jena Conroy",
            "identifier": "88.8.178.6",
            "host": "88.8.178.6",
            "mac_address": null,
            "hostname": "zulauf.com",
            "operating_system": "quam",
            "operating_system_name": "dignissimos",
            "first_seen": "1986-12-08T09:53:33.000000Z",
            "last_seen": "1975-05-22T03:39:18.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "licensed": true,
            "change_license_at": "2026-04-29T20:49:30.000000Z"
        },
        {
            "id": "a17a46d5-bee2-4d17-8af3-9c818d04f6eb",
            "company_id": "8296156",
            "name": "Eve Beatty",
            "identifier": "60:F6:37:C4:FA:3B",
            "host": "172.48.89.86",
            "mac_address": "60:F6:37:C4:FA:3B",
            "hostname": "block.info",
            "operating_system": "reiciendis",
            "operating_system_name": "inventore",
            "first_seen": "1988-12-21T21:37:43.000000Z",
            "last_seen": "1992-03-27T19:02:02.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "licensed": false,
            "change_license_at": "2026-04-17T11:16:18.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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\": \"assignLicense\",
            \"id\": \"eum\",
            \"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\": \"au\",
    \"host\": \"aut\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "a17a46d5-c639-41de-992b-b36e4784389b",
        "company_id": "9053797",
        "name": "Dr. Kirstin Ernser",
        "identifier": "E8:81:D4:CE:4C:DA",
        "host": "78.190.226.181",
        "mac_address": "E8:81:D4:CE:4C:DA",
        "hostname": "cronin.info",
        "operating_system": "quo",
        "operating_system_name": "quia",
        "first_seen": "2007-03-09T01:47:26.000000Z",
        "last_seen": "2001-11-22T02:56:13.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": false,
        "change_license_at": "2026-04-16T05:09:29.000000Z"
    }
}
{
    "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:
ullam

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • software
  • tags
  • scans
Example:
scans
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/assets/ullam?include=scans" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-c9bf-4847-a4cf-104f635c666b",
        "company_id": "2643712",
        "name": "Abigail Homenick",
        "identifier": "3E:A4:83:75:61:EA",
        "host": "123.124.61.143",
        "mac_address": "3E:A4:83:75:61:EA",
        "hostname": "botsford.org",
        "operating_system": "quam",
        "operating_system_name": "ullam",
        "first_seen": "1994-11-22T14:53:01.000000Z",
        "last_seen": "1974-09-03T05:04:42.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": false,
        "change_license_at": "2026-04-15T13:20:38.000000Z"
    }
}

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:
unde

Body Parameters

Example request:
curl --request PATCH \
    "https://api.securityhive.io/v1/assets/unde" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"hoxyzixjypbjmbi\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "a17a46d5-ce59-48c2-91cb-c54efc69e9d3",
        "company_id": "7454614",
        "name": "Francesco Littel",
        "identifier": "D1:46:47:2E:9E:0C",
        "host": "80.52.130.78",
        "mac_address": "D1:46:47:2E:9E:0C",
        "hostname": "reichert.com",
        "operating_system": "fugit",
        "operating_system_name": "itaque",
        "first_seen": "2007-12-26T23:06:51.000000Z",
        "last_seen": "2025-11-27T00:37:20.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2026-05-05T04:59:17.000000Z"
    }
}
{
    "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:
hic
Example request:
curl --request DELETE \
    "https://api.securityhive.io/v1/assets/hic" \
    --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:
scans
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=scans" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-d4b9-43f0-b410-0c334a8fd545",
            "company_id": "9401673",
            "common_name": "stokes.com",
            "organization": "Grant, Osinski and Schmidt",
            "organizational_unit": null,
            "locality": null,
            "state": null,
            "country": "PF",
            "serial": "5IS1XCCURMQAVC9NGKOIUPBSYCUQKIQQ",
            "not_valid_before": "20240714T030108Z",
            "not_valid_after": "20261023T203514Z",
            "value": "-----BEGIN CERTIFICATE-----\ns0NF5/Xn7SA4jL26JlHxsAqz3wXuGnH3LBhSg4lXLlskcq3UiwewssFAFlDVyN92\nMhlNavXKpO8YCyduAtNsm1+fPZVG7rCkKQmNJfxseWgms4k43BM3FUvEfdgzBsIF\nJvl0qohS4EQKZoeqT9XEHqJ1Mcdl6V8T54q2jOw4wUgIUWFdQJqHc6zh3ZQX/k7f\nndumnSjg/jzF8fowyWsTRy14p/lsjYz+tCYPTYP7doO3s0bFXsHjm5oEUvIVAP5r\nZp6OqC/VIgoWKCSGxuUaXFlOMOgoMp8+r39ZudnMPJcxIkJ2xONTsA0Fbk3UmDIJ\nqBzSF78jfL+PwpHRa3ZptcP9IA+aSpoGTEc8nfQubsE63RMOhn3HABvQ4IiAVtQl\nZPLJ/dpBEW/PTmeso8lkwJti7jkgcloU2aQKaBV0fR6ldu1fWgz3tV4IcZeyEBrj\nLdS3N7WWrmgciLEtZLJAphW6e5ZpZ457ClXJddWuOauZ4fzdNj2+iaOacMe0Dye6\npce3sUdoGfbXncIzi3mgZ82RnLs4hcs/EzZWa5IbZQtHhL8NlQxM3riEHFSkqRbu\nEV7KNVjJT+DzTwN+MAwigu5B5/CWfe+kKbsyCY+g04Szj4TtIOmqp0yuI+gud12q\nAjiCN0eJKYhroBa5ZNbtoEJk0IVHTqWudSQqt5nhWHcAqbUA9eq8yiF6GVNp622m\nW8d4J+PJ8yEKVhCP4P12t7nfwvNbuZ9TF4rhRLMRBowGEJ/QfUOO9dEGDaqBrd42\nQx1LF+3e7oUNWSSkVHL/lHwafP4iiilafSXqtczTNU1BfUxt4Cau+2j8h/39xi+X\nY9IHE1IBqJ7ocKvOSGrQKG90RR1Qh6ue1YIWIsuDxRrJ2ofFuUqK+ti9oumpViPE\nL49D+lLZVzUyoG4ua020cTXLt6hoFUy6URn/U7pGuXYKozSTPT/7DVXPqztCh7sP\nCELzPAJo+9mGEfDPYx9SAor3LHpe9xEVwikpON7tf7Zv0ZCLiDjxuSF9ybHKMxTi\n+ckMj0yd/mtvc96MK/29ki8xlGSMn11q3Cy3WxDofv45T7rfb8hM+A4+FOEKnNPd\nazZL/QGkmwvHA0xRsMg8vpq+aVWFoO/ykAcjYrBDjM6kpgqU6t3VU31N7p0yUj4X\n7+jvfQMcu6fqRciazgYQEqWfKeROk0hJD6HlKy1oXRwo+n32I1JZCAUktXtG0CyX\nSMhQTuNvMu4oNdx5d2Kucxa1kGRhkC8Y+LYQpPewf5yiNOGPCw/gLh/sBzFRlJQR\nN+UlcK8YkiHROL8cseJuh4xkgCtBUnAql9ZN5c0jl52O2Z8zBS9IpyoKL2duwdnX\n0zSuludw5tAdlZF1ZJSoyg==\n\n-----END CERTIFICATE-----",
            "first_seen": "2024-09-15T03:44:20.000000Z",
            "last_seen": "2024-10-26T07:20:42.000000Z",
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        },
        {
            "id": "a17a46d5-d74f-42d2-8345-b25b193f6d40",
            "company_id": "147404",
            "common_name": "gibson.com",
            "organization": null,
            "organizational_unit": "PLC",
            "locality": "North Domenic",
            "state": null,
            "country": "PK",
            "serial": "UNMMXSCCSHSSEO9JHMDNYN20SQZOXRTQ",
            "not_valid_before": "20241126T205631Z",
            "not_valid_after": "20271228T230712Z",
            "value": "-----BEGIN CERTIFICATE-----\nghUuK0gp4YrCFgyZ4C/At314IFHxcWFHqT5KmPhkH6WM5jF70Eg8nIWh4H1N1LNp\nTWzCB3Uzc9dsldXA2WuBKwWqKIkNJm2fhWmuQjLfC+pDiJtyQ3YP/F4Tl6DSNs2Y\nmRvmI/dvEU3KPfIVzniC4xa7kH8ckdhxzSAFOL662jQdiroC4zyjPhnEMGRXkj3B\nQu7NGXafrjMrdrVJKSr7Gv2DbxoET1chUcpu9NcCQJLw/8XRWoE0SHR9VzRrOjpZ\n7RCRZeu+DKVc5AAzvoGPjP2wzXa9z03A2BqC8ETOTaMI+3QKOJmg9iTRWblw4iDS\nltyyWRLdo4nH68m1KSRkx4bO6h0SO5Q1mD0CwFXOzbo8RJ/05BdFhb9SlDjgy+a4\ne1PyPlvu1ol/ySi2xT5dSc0zKJfX1iYQhukQR1iwrSvkh/ng3jhBxpOa1+ugAgO7\nOcFxzmIVk2Lzuz0PZ9K2EljMVnv3MAy+tYLEHWt4wp7cVM+TGBZyC7j7fKWz+Nsk\no3M+0RuyCyHblVfgjF8RDWUNy03oSfkq2NE6wi3Lgd7Vmgqm2oCc2Z6RnrUUVK8n\nD05c6Z2xhLHt8Mv6TUD+w6JC15qZ/sm6apMVOb8DQuBjdJxq2gXjnCOw/BeEZPe4\n5MoSLbqByVUwiy9i0FE85pFGyleIPT2Rvg6V1nqB5ZwIK/t1peglel+HSag8mSXM\nSZZGDQ7SEnSgKB5x/7UJ6LuDaoq1vYy514PjZqWle5+Cp/rieONNra4CCvZHkw5j\n/Hy2sKnpXgkg6KcHn1Q11xy3oGy4E62gAxq9b74edQob4YZGuA5OmJrxPbz6XtmE\njlp2ZNSSvgnuQxtYVsRdaAwqPJni6cJKmYTi2D9U6ZRdWTdDyI6ZUw6X88vWUqSS\nyNwj5YoAq7qILP4UKs+ESoFkCyRZ8Jm4OSKBEzxhTpNsjT3s66ffbjKTxRpUcZd9\nm+XxEhVfv0VdBo89AVuHOsuWk8qI8WRurGbZpRJv4kJIfJGR6WqRtO82ZFGAI+v7\n5hsAsaXMGyjrs1BDGfJlm+/CuZBLC1dNi/Btg1iZ4Prlfa6r+KDQn5LxLq/lo/3e\nV+qrvzxMOaEF/kESV+W3NRS15DEWDBaXRl+DgfVOit7K4yULvT2Zavd5l4B2VMnh\nyyL9KJ0smtDrHpn5hbiecHOTQLXlRWIVVP8zaFgKC0Qkx6qbCXKzV2sGqsqE2M9F\nyqnCcOwzk1srcOg436XWYvZkBLlMPVqD9WNf+Pp78ow8zkxf66bFzo/wqc2Wjouy\nk2tUfXm3SBwcrOMcJFVME43hHO2rU9xHSlJCmQQq78+F2gmk1AUeUd3H686DEx46\nUEulUgPARum31ZjsBTDoag==\n\n-----END CERTIFICATE-----",
            "first_seen": "2025-07-14T02:59:07.000000Z",
            "last_seen": "2026-02-10T01:00:04.000000Z",
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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:
xlsx
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:
common_name
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates/export?type=xlsx&filter%5Bcommon_name%5D=test.nl&filter%5Borganization%5D=Test+B.V.&sort=not_valid_after&filter=common_name" \
    --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-Fw2EJSlY71mwQeJE6FdDGGha8cgn36d4AZvS3BXl' 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-Fw2EJSlY71mwQeJE6FdDGGha8cgn36d4AZvS3BXl' 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:
id

Query Parameters

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/id?include=applications" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-dc9a-4577-a5f3-8fb7823ce9b3",
        "company_id": "3389963",
        "common_name": "okuneva.net",
        "organization": "Rippin and Sons",
        "organizational_unit": null,
        "locality": "West Kraig",
        "state": "California",
        "country": "BM",
        "serial": "YLB568TTGBL1O8BAUERCWX9UZJTXXACQ",
        "not_valid_before": "20240723T012949Z",
        "not_valid_after": "20240905T220006Z",
        "value": "-----BEGIN CERTIFICATE-----\nwmvnxvcB9u9SHTLTxKVmtLpXGlPSwUDBlr3OBIaMEOwKl0mQ2LbygFPDeS9n8rbW\ngPzWTzQ5wyjDTHjfIv5oQtzW2acnS5TijVPLSy7GeonhxcnbSLfmmSJtPbaw7O4C\n+pl8mVI4iqGjbLeCk9U7FKHMstVlZuNiBENNElUZ28gHfpQx6GI9KDGs5jZVdGvB\nAWaHlj/AEJlbePpZc12vHAyUDW6Pv2Refyes8w0Kf9py9FunSe0enMjf73ODXtr7\nc2mipY7SlqM+8HGp0QOIBfHA0QOCg8Y0PTEh02GNdS3OnuJkiSqhCjMQOvB6ygnq\n1RW5DL8oE8AP8J+lwukwDw9M88Eqn/Z/K2p+uKzYwlqWo3KeSBrX1uL/y0WjqSfc\ni9aoKBaO8ae01Aqb06bRlmD96ZJaM5RzzBmJRWNdf6OQaL9c2zUOp1Nwow2IEiX5\nY8Fxu3lQnZHgFZK28Wq61dbWOukVrHL3M8q3TCF5D3RjWk6+sq7BjfGUSCL2V9M1\nwP5OmwyRNojaMYR6/D+7pmi73njnfM2opePJsU2dELf9KyUHs0dKxtk3wpkkGVm5\n0kFP3cTkSfamM+1rpbITQfPfDPzN4NylwXkL16HWjXZfWst2af46PUBitAKQU2EN\ns3KoXpVL4YhRqx0jhy7VLL/bQ3LUHPxTPKILCvJVwzwwU4826x9Faj/ZX92c/SSI\nRjvJRFpAppFxF27dvir9bUZ+ry5AQkK12eevq+RKqlo+Y9VTlNtK6KgNbp+KuERJ\nIGZv++rLeNkN9WQv1WIoHF9YNCZipiJtWOUxEiM/wTBSIuGC7A5JJRsqHlrqANcU\nHOoTHJA6WlfDwhUzOw3WbGeIISFRwupaT7OYxq5CQyK7x5Uh2/SEYjR/RrizcTc/\ncGs67tKi3d2lV740J1Q9+5LCGVJHml/YkW3HcHuTLXi0OR4XMcASHnX43i6VZXsU\nzA2peJd+H/tZQIcee5YPi3K9gb02fKCXmZTpZj92H6jyrqN3He7Dd4v1mXPyP1g4\nOJVrH3Pmb42HEf9mw3zYSo7iTYFw6OKvKhO9aw7otKI7eGApSNt1pEOU2meu1TON\nYwQBdr6aLHWgOQrV6aNLlCoO8YURhfvzsxMuXrY6vvPiskoxRpswuW60uEZIYz+8\nzgKMWFkhUtdWb13qgMUlbYq1eaR6NCc6nE538zdKFKIXbEZI+nN5LfI7aXjiwWa3\nf8DlQsPSCdBNpSsy8/LGcPhjAHxz+1wrqKz9iknYani5Kk0zrHZ00pYkvjZa+fYN\n/I5pt5+lvD9/GYA8sMu0tmt6PDPdQ2m1thc2xH+xxkabBmh/JHT4X9Hisp1qW5CC\nUpZguDtAt0lOtD4RXx00jQ==\n\n-----END CERTIFICATE-----",
        "first_seen": "2026-02-20T15:05:12.000000Z",
        "last_seen": "2026-06-19T10:50:59.000000Z",
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z"
    }
}

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:
laborum
Example request:
curl --request DELETE \
    "https://api.securityhive.io/v1/certificates/laborum" \
    --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:
Modbus
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=Modbus&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\": \"mv\",
        \"honeypot_id\": \"ed3d25c2-ab22-350c-a728-17574dd314b4\",
        \"honeypot_alias\": \"mdwjedtffjxnhseh\",
        \"src_ip\": \"hjpganpfdoujfeqrvvmyh\",
        \"src_hostname\": \"ycsxatorbgug\",
        \"marked_as_seen\": \"true\"
    },
    \"include\": \"events\",
    \"page\": 89,
    \"per_page\": 15,
    \"sort\": \"-timestamp\"
}"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-8185-4f03-aab9-68e4a5817650",
            "company_id": "b655e546-6ada-49a6-9489-2d1c7f6e9d20",
            "src_ip": "211.253.129.247",
            "dst_ip": "2.24.228.103",
            "sensor": "Modbus",
            "timestamp": "2025-01-25T20:21:16.000000Z",
            "marked_as_seen": true,
            "honeypot_id": "c0e2122a-30d5-44db-8dbb-3966db5049ce",
            "honeypot_alias": "Honeypot-Office-67",
            "src_port": null,
            "src_hostname": "Kshlerin, Parisian and Adams",
            "src_mac": "1F:19:75:1B:28:24",
            "dst_port": 16964
        },
        {
            "id": "a17a46d5-87c4-4c8b-8adf-98e148a3523d",
            "company_id": "a6e5762b-223e-421d-b969-89ef69a5576d",
            "src_ip": "18.54.67.135",
            "dst_ip": "78.20.125.9",
            "sensor": "Modbus",
            "timestamp": "2025-07-03T03:21:44.000000Z",
            "marked_as_seen": false,
            "honeypot_id": "ce929507-007d-4c34-99dd-9286a6f304aa",
            "honeypot_alias": "Honeypot-Datacenter-93",
            "src_port": null,
            "src_hostname": null,
            "src_mac": null,
            "dst_port": 21577
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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:
a17a46d5-8185-4f03-aab9-68e4a5817650
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/a17a46d5-8185-4f03-aab9-68e4a5817650/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:
officiis
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations/officiis/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-tbTRdHa6VnV8KATsPJaCjXS4empTu0WpB1q7YsPO' 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-tbTRdHa6VnV8KATsPJaCjXS4empTu0WpB1q7YsPO' 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": "7633350a-f6ad-40fa-874a-50cc077c4b16",
        "alias": "Honeypot-HQ-67",
        "status": 1,
        "activation_status": 1,
        "hostname": "honeypot-djyp-942.example.com",
        "slane_enabled": true,
        "slane_connected": false,
        "paired": true,
        "provisioned": false,
        "dns1": "158.238.35.28",
        "dns2": "62.15.96.153",
        "configured_as": null,
        "notes": null,
        "checked_at": null,
        "created_at": "2026-04-06T08:51:04.000000Z",
        "updated_at": "2026-04-06T08:51:04.000000Z"
    }
}

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:
company
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/me?include=company" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "0d33dbda-7d3f-45ae-a904-0d4eec8585a6",
        "company_id": "1910128",
        "managing_company_id": "1910128",
        "first_name": "Jaylon",
        "last_name": "Reinger",
        "two_factor_enabled": false,
        "two_factor_configured": false,
        "email": "[email protected]",
        "email_verified_at": "2026-04-06T08:51:04Z",
        "phonenumber": "(224) 731-4052",
        "phonenumber_verified_at": "2026-04-06T08:51:04Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "1910128",
                "uuid": "31dcf3a6-850a-483f-aa22-01b7c4232451",
                "name": "Lynch-Goyette"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "abilities": [],
        "need_to_configure_2fa": false,
        "terms_agreed_at": "2026-04-06T08:51:04Z",
        "sso_provider": null,
        "created_at": "2026-04-06T08:51:04Z",
        "updated_at": "2026-04-06T08:51:04Z"
    },
    "links": {
        "self": "http://api.securityhive.io/v1/me"
    }
}

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\": \"2026-04-06T08:51:04\",
    \"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:
dicta
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:
created_at
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=dicta&filter%5Bbusiness_impact%5D=high&filter%5Bsystem_tag%5D=1&sort=created_at&include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-e362-495a-898a-ffea1348fe90",
            "company_id": "8636420",
            "name": "88d0c42d-2e81-3088-bac0-da52d9107437",
            "description": "Sint ullam voluptatem itaque illum. Tempora dolorem et nisi ipsum eligendi voluptates rem. Adipisci quam consequatur tempora ut quidem facere. Enim dolorem repellat iusto fugiat.",
            "business_impact": "medium",
            "system_tag": true,
            "asset_count": 0,
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        },
        {
            "id": "a17a46d5-e5c8-43c9-ae53-8f046d481f4c",
            "company_id": "3235480",
            "name": "e52271b2-d8e6-3963-86bf-2e34a307222d",
            "description": "Laudantium voluptatem dignissimos numquam dicta. Hic perspiciatis sed voluptatem. Ut praesentium nulla sit. Doloribus sed vero sequi.",
            "business_impact": "low",
            "system_tag": false,
            "asset_count": 0,
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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\": \"gitavwocetfhzdpbaadn\",
    \"description\": \"Repellat autem enim velit dolores dolores.\",
    \"business_impact\": \"medium\"
}"
Example response:
{
    "data": {
        "id": "a17a46d5-ea48-4c47-8565-d9348c89c809",
        "company_id": "3220893",
        "name": "30040281-0178-387f-8e3a-79bb3d733037",
        "description": "Et ut aut libero eveniet aut. Id similique sed voluptates. Eligendi corrupti quia optio et quis ab perferendis.",
        "business_impact": "medium",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z"
    }
}
{
    "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:
et

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/et?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-ed97-4ff2-82c5-a3795e994cc0",
        "company_id": "2757565",
        "name": "a7976013-6352-32f6-88c2-6a2f4ffb17fa",
        "description": "Et qui rem libero dolores. Beatae et vero quisquam est aliquam est ut. Ad id sequi tenetur provident hic blanditiis est.",
        "business_impact": "high",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z"
    }
}

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:
quam

Body Parameters

Example request:
curl --request PATCH \
    "https://api.securityhive.io/v1/tags/quam" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ibytzccvfepi\",
    \"description\": \"Officiis at totam impedit hic impedit fugit eveniet quos.\",
    \"business_impact\": \"high\"
}"
Example response:
{
    "data": {
        "id": "a17a46d5-f169-4c01-b515-3579c805de00",
        "company_id": "3555315",
        "name": "16660858-8e58-3b00-a0e2-3e18a0bdcb55",
        "description": "Enim sit omnis sed laudantium sed necessitatibus. Quibusdam ut sint illum quaerat. Consequatur eveniet veniam explicabo inventore neque voluptas delectus.",
        "business_impact": "low",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z"
    }
}
{
    "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:
id
Example request:
curl --request DELETE \
    "https://api.securityhive.io/v1/tags/id" \
    --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": "94e73e44-499d-4805-99df-6107c3d166bd",
            "company_id": "6772728",
            "managing_company_id": "6772728",
            "first_name": "Madge",
            "last_name": "Borer",
            "two_factor_enabled": false,
            "email": "[email protected]",
            "email_verified_at": "2026-04-06T08:51:05.000000Z",
            "phonenumber": "803-424-2882",
            "phonenumber_verified_at": "2026-04-06T08:51:05.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "6772728",
                    "uuid": "8745c228-7324-4a8f-8529-d6808ccf93c2",
                    "name": "Luettgen-Emmerich"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2026-04-06T08:51:05.000000Z",
            "sso_provider": null,
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z",
            "last_login_at": null
        },
        {
            "id": "8c94e237-f856-4733-a2c5-793db83cf311",
            "company_id": "455754",
            "managing_company_id": "455754",
            "first_name": "Jocelyn",
            "last_name": "Harber",
            "two_factor_enabled": false,
            "email": "[email protected]",
            "email_verified_at": "2026-04-06T08:51:05.000000Z",
            "phonenumber": "628.528.0823",
            "phonenumber_verified_at": "2026-04-06T08:51:05.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "455754",
                    "uuid": "e8bd4c9b-c545-449b-be80-ae98154be5c1",
                    "name": "Heathcote-Welch"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2026-04-06T08:51:05.000000Z",
            "sso_provider": null,
            "created_at": "2026-04-06T08:51:05.000000Z",
            "updated_at": "2026-04-06T08:51:05.000000Z",
            "last_login_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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\": \"xytvjrkwobalsfalqoov\",
    \"last_name\": \"zstyivxvfhbaqegh\",
    \"email\": \"[email protected]\",
    \"phonenumber\": \"+31612345678\",
    \"report_interval\": \"weekly\",
    \"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:
d468b64c-5286-3334-a638-8da711dd3112

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
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/users/d468b64c-5286-3334-a638-8da711dd3112?include=company" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "d410934b-5f8d-4e0c-ac9b-6c33384fc168",
        "company_id": "434984",
        "managing_company_id": "434984",
        "first_name": "Eriberto",
        "last_name": "Grant",
        "two_factor_enabled": false,
        "email": "[email protected]",
        "email_verified_at": "2026-04-06T08:51:05.000000Z",
        "phonenumber": "1-951-953-2611",
        "phonenumber_verified_at": "2026-04-06T08:51:05.000000Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "434984",
                "uuid": "d90c4851-bac3-473a-9e3f-d63b0d26aa5b",
                "name": "Jones, Torp and Jacobi"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "terms_agreed_at": "2026-04-06T08:51:05.000000Z",
        "sso_provider": null,
        "created_at": "2026-04-06T08:51:05.000000Z",
        "updated_at": "2026-04-06T08:51:05.000000Z",
        "last_login_at": null
    }
}
{
    "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:
f5ed342d-f82b-37b4-8f77-127a61be3e69

Body Parameters

Example request:
curl --request PATCH \
    "https://api.securityhive.io/v1/users/f5ed342d-f82b-37b4-8f77-127a61be3e69" \
    --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:
Detected
filter[threat]
Filter vulnerabilities by their threat level
Must be one of:
  • Log
  • Low
  • Medium
  • High
  • Critical
Example:
Critical
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:
name

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=Detected&filter%5Bthreat%5D=Critical&filter%5Bscan_id%5D=123&filter%5Bfamily%5D=SQL+Injection&sort=name" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"name\": \"hjcbuwpsyujcbjxnkbvlijzmf\",
        \"threat_level\": \"Low\",
        \"host\": \"opopichwmdkmywyfkqgcmk\",
        \"hostname\": \"ptggbfniyuah\",
        \"status\": \"Expired\",
        \"scan_id\": \"4d35bfd8-69d7-3b27-9b6d-95c2014efe32\"
    },
    \"per_page\": 19
}"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-9ee1-496a-b4a8-af9d452ed2c1",
            "asset_id": "a17a46d5-94d5-433b-9efa-284fae3a61d6",
            "company_id": "8845855",
            "vulnerability_definition_id": "a17a46d5-9e1d-4ca3-b870-da7dd46efcef",
            "vulnerability_definition": {
                "id": "a17a46d5-9e1d-4ca3-b870-da7dd46efcef",
                "name": "10 exploitable through fugit manipulation",
                "description": "Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.",
                "solution": "Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.",
                "category": "10",
                "threat_level": "Medium",
                "definition_type": "openvas",
                "definition": {
                    "id": "a17a46d5-9bec-408a-8927-ef0ee111e503",
                    "o_id": "c35cd687-b3a6-3500-8a6a-ac9df7aa0a84",
                    "name": "10 exploitable through fugit manipulation",
                    "family": "10",
                    "reference_urls": "http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in",
                    "reference_cves": "CVE-2023-3119, CVE-2019-1854",
                    "solution_type": "WorkAround",
                    "solution_description": "Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.",
                    "summary": "Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.",
                    "insight": "Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.",
                    "affected": "Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.",
                    "impact": "Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.",
                    "vuldetect": "Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.",
                    "priority": "Log",
                    "qod_type": "registry",
                    "qod_value": 32
                },
                "cvss_base_score": 2.9,
                "cvss_base_vector": "AV:P/AC:L/Au:S/C:P/I:P/A:P",
                "epss": null,
                "created_at": "2026-04-06T08:51:04.000000Z",
                "updated_at": "2026-04-06T08:51:04.000000Z"
            },
            "host": "34.131.122.99",
            "hostname": "schaden.com",
            "port": "34308/tcp",
            "details": "Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.",
            "status": "Accepted",
            "first_seen": "2025-11-25T15:28:14.000000Z",
            "last_seen": "2026-01-15T07:59:42.000000Z",
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z",
            "name": "10 exploitable through fugit manipulation",
            "description": "Et vitae beatae iusto ad quod et et. Totam id recusandae et iusto.",
            "cvss_base_score": 2.9,
            "cvss_base_vector": "AV:P/AC:L/Au:S/C:P/I:P/A:P",
            "qod_type": "registry",
            "qod_value": 32,
            "threat": "Medium",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "a17a46d5-9bec-408a-8927-ef0ee111e503",
                "o_id": "c35cd687-b3a6-3500-8a6a-ac9df7aa0a84",
                "name": "10 exploitable through fugit manipulation",
                "family": "10",
                "reference_urls": "http://www.terry.net/iste-qui-rem-qui-reiciendis-eos, http://www.douglas.com/placeat-autem-numquam-voluptatem-cumque-ratione-in",
                "reference_cves": "CVE-2023-3119, CVE-2019-1854",
                "solution_type": "WorkAround",
                "solution_description": "Et quidem aut tenetur consequatur voluptas nobis recusandae. Eveniet eius voluptatibus enim alias temporibus. Sit aspernatur omnis nostrum voluptatem. Libero libero voluptas voluptatum ea sit.",
                "summary": "Est aut necessitatibus qui error qui doloremque. Voluptas labore iste voluptates aut sint. Expedita dolore id neque nulla saepe. Voluptatibus vel omnis non voluptatem laborum eos tempore laudantium.",
                "insight": "Natus architecto voluptate porro commodi ut. Quo et inventore mollitia reiciendis et et aut. Aut itaque voluptates omnis. Explicabo aliquid perspiciatis amet eum vitae molestiae voluptatem ut.",
                "affected": "Impedit ducimus iste in maxime enim tempore id. Sed est cumque aut. Exercitationem quisquam laudantium consequatur modi itaque. Cumque repellat molestiae molestias et molestiae.",
                "impact": "Alias sint illo reiciendis similique. Excepturi eum sed voluptatem. Quasi quo dolorem ut numquam placeat repellendus possimus. Voluptatem ipsa dolorem beatae non illum ut esse.",
                "vuldetect": "Vel quisquam voluptas ipsum ipsum minus excepturi quaerat. Molestiae velit in quasi excepturi. Ut excepturi nisi voluptas. Tempora deleniti possimus et quis aperiam repellendus.",
                "priority": "Log",
                "qod_type": "registry",
                "qod_value": 32
            }
        },
        {
            "id": "a17a46d5-a5bd-4342-85b8-3997b65cf15d",
            "asset_id": "a17a46d5-a1fc-46b3-bd92-dbd06a7c6551",
            "company_id": "4523355",
            "vulnerability_definition_id": "a17a46d5-a550-4798-91c3-532f80279543",
            "vulnerability_definition": {
                "id": "a17a46d5-a550-4798-91c3-532f80279543",
                "name": "Remote File Inclusion via earum input",
                "description": "Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.",
                "solution": "Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.",
                "category": "Remote File Inclusion",
                "threat_level": "Critical",
                "definition_type": "openvas",
                "definition": {
                    "id": "a17a46d5-a448-429e-b524-20e4ed841ccd",
                    "o_id": "22f44bc3-3a4c-3519-ad23-149aedaeff52",
                    "name": "Remote File Inclusion via earum input",
                    "family": "Remote File Inclusion",
                    "reference_urls": "https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/",
                    "reference_cves": "CVE-2018-9829, CVE-2016-6699",
                    "solution_type": "Configuration Change",
                    "solution_description": "Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.",
                    "summary": "Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.",
                    "insight": "Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.",
                    "affected": "Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.",
                    "impact": "Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.",
                    "vuldetect": "Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.",
                    "priority": "Critical",
                    "qod_type": "exploit",
                    "qod_value": 89
                },
                "cvss_base_score": 9.6,
                "cvss_base_vector": "AV:N/AC:H/Au:N/C:N/I:P/A:P",
                "epss": null,
                "created_at": "2026-04-06T08:51:04.000000Z",
                "updated_at": "2026-04-06T08:51:04.000000Z"
            },
            "host": "63.77.140.175",
            "hostname": "schulist.info",
            "port": "25/tcp",
            "details": "Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.",
            "status": "Resolved",
            "first_seen": "2026-01-13T15:52:23.000000Z",
            "last_seen": "2026-02-26T15:04:44.000000Z",
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z",
            "name": "Remote File Inclusion via earum input",
            "description": "Sed quibusdam et enim voluptas sit itaque. Aut velit at iste enim. Expedita in consequatur doloremque ut aperiam.",
            "cvss_base_score": 9.6,
            "cvss_base_vector": "AV:N/AC:H/Au:N/C:N/I:P/A:P",
            "qod_type": "exploit",
            "qod_value": 89,
            "threat": "Critical",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "a17a46d5-a448-429e-b524-20e4ed841ccd",
                "o_id": "22f44bc3-3a4c-3519-ad23-149aedaeff52",
                "name": "Remote File Inclusion via earum input",
                "family": "Remote File Inclusion",
                "reference_urls": "https://skiles.com/voluptas-aut-voluptas-ea-non-quaerat-eligendi-qui-voluptas.html, http://www.kling.com/",
                "reference_cves": "CVE-2018-9829, CVE-2016-6699",
                "solution_type": "Configuration Change",
                "solution_description": "Id odio voluptatum suscipit. Voluptas recusandae cum quia repudiandae quia quo. Repellat vel voluptate recusandae quia amet nostrum molestiae.",
                "summary": "Beatae quibusdam modi quis quae optio architecto. Reprehenderit ducimus et aut. Qui libero iusto quas autem. Ad id voluptatem similique quod voluptate enim.",
                "insight": "Natus suscipit non cum tempore aut ut voluptatem. Ipsum culpa iusto ut vel hic laudantium rerum. Est aliquam expedita voluptas fugit ipsa fugiat. Vitae amet sit eum consequuntur.",
                "affected": "Et debitis veniam et distinctio odio occaecati vel. Excepturi suscipit aliquid modi.",
                "impact": "Eum excepturi blanditiis non magnam. Commodi enim omnis iusto est amet. Incidunt nihil dolor est accusantium aut est. Molestiae et illum et nulla numquam. Recusandae facere deleniti ducimus fuga ut. Officia neque tenetur harum quasi.",
                "vuldetect": "Vero ea quia explicabo qui. Ullam temporibus et dolor voluptas dolor eligendi. Dignissimos voluptatem doloribus voluptate nesciunt totam ut et. Et unde a quam libero aspernatur nostrum.",
                "priority": "Critical",
                "qod_type": "exploit",
                "qod_value": 89
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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:
repudiandae
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities/repudiandae" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-b2c8-49ea-a73e-28db8507f8f0",
        "asset_id": "a17a46d5-aef7-4326-b24b-672ad4e69fd7",
        "company_id": "9768063",
        "vulnerability_definition_id": "a17a46d5-b25b-4a4e-997a-9ddcc441c771",
        "vulnerability_definition": {
            "id": "a17a46d5-b25b-4a4e-997a-9ddcc441c771",
            "name": "Missing Function Level Access Control affecting qui functionality",
            "description": "Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.",
            "solution": "Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.",
            "category": "Missing Function Level Access Control",
            "threat_level": "Low",
            "definition_type": "openvas",
            "definition": {
                "id": "a17a46d5-b15d-48d2-a750-c897c69487d6",
                "o_id": "86685fc5-a1c8-327d-b1f9-af0dc4645cd3",
                "name": "Missing Function Level Access Control affecting qui functionality",
                "family": "Missing Function Level Access Control",
                "reference_urls": "http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/",
                "reference_cves": "CVE-2018-4250, CVE-2016-7547",
                "solution_type": "Mitigation",
                "solution_description": "Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.",
                "summary": "Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.",
                "insight": "Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.",
                "affected": "Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.",
                "impact": "Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.",
                "vuldetect": "Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.",
                "priority": "High",
                "qod_type": "package",
                "qod_value": 72
            },
            "cvss_base_score": 4.9,
            "cvss_base_vector": "AV:N/AC:H/Au:M/C:P/I:C/A:N",
            "epss": null,
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z"
        },
        "host": "47.188.19.65",
        "hostname": "kilback.com",
        "port": "3306/tcp",
        "details": "Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.",
        "status": "Expired",
        "first_seen": "2025-11-28T03:06:12.000000Z",
        "last_seen": "2026-01-02T21:36:10.000000Z",
        "created_at": "2026-04-06T08:51:04.000000Z",
        "updated_at": "2026-04-06T08:51:04.000000Z",
        "name": "Missing Function Level Access Control affecting qui functionality",
        "description": "Occaecati vel quia accusantium a occaecati est. Quia explicabo enim impedit nulla nam impedit sint animi. Fugit ipsum asperiores aut in consequuntur sunt.",
        "cvss_base_score": 4.9,
        "cvss_base_vector": "AV:N/AC:H/Au:M/C:P/I:C/A:N",
        "qod_type": "package",
        "qod_value": 72,
        "threat": "Low",
        "scanner_id": null,
        "scanner_hostname": null,
        "plugin": {
            "id": "a17a46d5-b15d-48d2-a750-c897c69487d6",
            "o_id": "86685fc5-a1c8-327d-b1f9-af0dc4645cd3",
            "name": "Missing Function Level Access Control affecting qui functionality",
            "family": "Missing Function Level Access Control",
            "reference_urls": "http://www.cole.com/consequatur-et-aut-vel-dolores-est-reiciendis, http://runte.net/",
            "reference_cves": "CVE-2018-4250, CVE-2016-7547",
            "solution_type": "Mitigation",
            "solution_description": "Esse nobis suscipit eum suscipit aut commodi quae. Fugiat adipisci qui in. Voluptas repellendus nihil et. Ut sint voluptas ipsam.",
            "summary": "Sed fuga aperiam velit aut est. Voluptatibus accusantium velit eum unde iure. Quos iste eveniet perferendis numquam nihil modi consectetur. Quis occaecati unde aut hic eaque quae incidunt. Delectus cum et nobis non sed itaque fugit non.",
            "insight": "Error mollitia qui consequuntur. Eligendi ea nobis ratione nulla beatae. Quis laboriosam qui ut quo perferendis.",
            "affected": "Architecto pariatur autem quo aut quas excepturi fugit qui. Est est sed eos dolores vel aliquam. Qui ut iste cupiditate quo omnis adipisci et.",
            "impact": "Quo iste nostrum omnis aut. Perferendis minima qui molestias quia. Aperiam sed qui natus. Vitae eligendi quos ducimus laudantium iure sint. Non et animi et aliquid ea est.",
            "vuldetect": "Sunt alias deleniti deleniti temporibus reprehenderit. Asperiores quos natus dolores. Cupiditate velit fuga soluta pariatur eos optio voluptatum.",
            "priority": "High",
            "qod_type": "package",
            "qod_value": 72
        }
    }
}

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:
webhook_id
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events?sort=status&filter=webhook_id" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "a17a46d5-60ef-48a9-b37c-cfc65e545c01",
            "webhook_id": "a17a46d5-6027-4bbd-9491-98875f9563d6",
            "event": "similique",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z"
        },
        {
            "id": "a17a46d5-6489-431a-aaa4-c89f43307770",
            "webhook_id": "a17a46d5-63bd-4410-8c2c-534971f52ade",
            "event": "maxime",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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-gfbxnSulhuYDmEKHlE1tihB5fgP4BXS90JF9TGyD' 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-gfbxnSulhuYDmEKHlE1tihB5fgP4BXS90JF9TGyD' 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:
a17a46d5-60ef-48a9-b37c-cfc65e545c01
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events/a17a46d5-60ef-48a9-b37c-cfc65e545c01" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-6ef6-472d-b433-0ea4f4c65e2c",
        "webhook_id": "a17a46d5-6e21-425a-ae7c-a8627eb3e3a3",
        "event": "quis",
        "payload": {
            "key": "value"
        },
        "status": "pending",
        "retries": 0,
        "next_retry_at": null,
        "last_sent_at": null,
        "created_at": "2026-04-06T08:51:04.000000Z",
        "updated_at": "2026-04-06T08:51:04.000000Z"
    }
}
{
    "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": "a17a46d5-485f-4366-a439-fb4289d2769e",
            "company_id": "642af263-7b20-4c8d-b446-ef99e1831866",
            "url": "https://gulgowski.com",
            "description": null,
            "events": [],
            "secret": "be36b7db4bdf30c7796bbbe4b13cffdfddd040ecc514c9bc81d942f0f49473e4",
            "last_sent_at": null,
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z"
        },
        {
            "id": "a17a46d5-4ce7-4655-8abe-fe5122d9ceb5",
            "company_id": "7ec1f497-8b14-4538-8def-0319903a21d7",
            "url": "https://muller.net",
            "description": null,
            "events": [],
            "secret": "386e0f61b66277b4018c43ac58c3d8881ea2c5d3285127b43165fd69db0930df",
            "last_sent_at": null,
            "created_at": "2026-04-06T08:51:04.000000Z",
            "updated_at": "2026-04-06T08:51:04.000000Z"
        }
    ]
}

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.daugherty.com\\/delectus-totam-vel-maiores-animi-facilis-suscipit\",
    \"description\": \"Magnam et ipsum aut accusamus quae.\"
}"
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:
a17a46d5-485f-4366-a439-fb4289d2769e
Example request:
curl --request GET \
    --get "https://api.securityhive.io/v1/webhooks/a17a46d5-485f-4366-a439-fb4289d2769e" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-53f6-440a-b98c-3913c6d44aec",
        "company_id": "c408e998-f8db-4b02-b3be-07ec6ad8eeda",
        "url": "https://hamill.org",
        "description": null,
        "events": [],
        "secret": "77b40ccee4f4380a8844ae6e5b98a88fe4345344b9c21c81f300c15f6b084c5d",
        "last_sent_at": null,
        "created_at": "2026-04-06T08:51:04.000000Z",
        "updated_at": "2026-04-06T08:51:04.000000Z"
    }
}
{
    "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:
a17a46d5-485f-4366-a439-fb4289d2769e
Example request:
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/a17a46d5-485f-4366-a439-fb4289d2769e/rotate-secret" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "a17a46d5-5805-4bcf-ad1e-af6630dcbfcd",
        "company_id": "9168e73c-3149-400c-bca1-f7899ef5c004",
        "url": "https://mueller.biz",
        "description": null,
        "events": [],
        "secret": "c365e05f78235a55f1b0ae85ae8797b520db51d46992a2848632a603367bb6a9",
        "last_sent_at": null,
        "created_at": "2026-04-06T08:51:04.000000Z",
        "updated_at": "2026-04-06T08:51:04.000000Z"
    }
}
{
    "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:
a17a46d5-485f-4366-a439-fb4289d2769e
Example request:
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/a17a46d5-485f-4366-a439-fb4289d2769e/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:
a17a46d5-485f-4366-a439-fb4289d2769e

Body Parameters

Example request:
curl --request PATCH \
    "https://api.securityhive.io/v1/webhooks/a17a46d5-485f-4366-a439-fb4289d2769e" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.goodwin.com\\/provident-minus-ut-aut-ratione-quam-quia-tempore.html\",
    \"description\": \"Neque aliquam quaerat cum maxime.\"
}"
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:
a17a46d5-485f-4366-a439-fb4289d2769e
Example request:
curl --request DELETE \
    "https://api.securityhive.io/v1/webhooks/a17a46d5-485f-4366-a439-fb4289d2769e" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "webhook not found"
}