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:
vendor
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=vendor&include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9f5db46e-bc20-4505-b71d-9a1143e262ee",
            "cpe": "cpe:2.3:a:mozilla:bugzilla:*:*:*:*:*:*:*:*",
            "vendor": "Mozilla",
            "product": "Bugzilla",
            "version": "19.37.4681",
            "update": "hotfix1",
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        },
        {
            "id": "9f5db46e-bda7-4c53-a008-93bc1d30c723",
            "cpe": "cpe:2.3:a:adobe:photoshop:*:*:*:*:*:*:*:*",
            "vendor": "Adobe",
            "product": "Photoshop",
            "version": "18.82.1052",
            "update": "build2973",
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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:
product

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=product" \
    --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
                                                            : frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.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:
sint

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/sint?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46e-c2a1-40d9-a3ac-42a025fa9f78",
        "cpe": "cpe:2.3:a:ibm:db2:*:*:*:*:*:*:*:*",
        "vendor": "IBM",
        "product": "DB2",
        "version": "19.50.7002",
        "update": "sp2",
        "created_at": "2025-07-11T15:34:39.000000Z",
        "updated_at": "2025-07-11T15:34:39.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:
certificates
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/assets?filter%5Bname%5D=Laptop-1&filter%5Bhost%5D=192.168.1.1&filter%5Bmac_address%5D=3A%3A5E%3AD6%3A95%3ABF&filter%5Bhostname%5D=laptop-1.local&filter%5Btags%5D%5B%5D=New%2COld&filter%5Blicensed%5D=true%2Cfalse&sort=host&include=certificates" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9f5db46e-3ef4-4744-ab55-376232c1a20b",
            "company_id": "8222748",
            "name": "Antonio Torphy",
            "identifier": "39.69.114.59",
            "host": "39.69.114.59",
            "mac_address": null,
            "hostname": "friesen.org",
            "operating_system": "sit",
            "operating_system_name": "porro",
            "first_seen": "1972-10-18T16:31:55.000000Z",
            "last_seen": "2007-01-15T12:31:12.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "scans": [],
            "licensed": true,
            "change_license_at": "2025-07-31T17:29:57.000000Z"
        },
        {
            "id": "9f5db46e-420e-4e43-aec8-68c182688535",
            "company_id": "2854937",
            "name": "Jairo McKenzie",
            "identifier": "07:4F:7F:35:60:61",
            "host": "86.8.99.175",
            "mac_address": "07:4F:7F:35:60:61",
            "hostname": "hudson.info",
            "operating_system": "provident",
            "operating_system_name": "modi",
            "first_seen": "2002-07-30T04:56:15.000000Z",
            "last_seen": "2008-11-15T11:30:40.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "scans": [],
            "licensed": true,
            "change_license_at": "2025-07-26T08:20:42.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",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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\": \"removeTags\",
            \"id\": \"veniam\",
            \"data\": {
                \"tags\": []
            }
        }
    ]
}"
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\": \"vjgglvfwjgymhwbdhrxpirg\",
    \"host\": \"consequatur\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "9f5db46e-4a9d-4df3-99be-063b376a994d",
        "company_id": "2954511",
        "name": "Alda Schaden",
        "identifier": "09:49:B1:62:ED:D2",
        "host": "227.118.60.100",
        "mac_address": "09:49:B1:62:ED:D2",
        "hostname": "gusikowski.biz",
        "operating_system": "hic",
        "operating_system_name": "et",
        "first_seen": "1998-12-03T05:04:30.000000Z",
        "last_seen": "1973-09-20T13:56:30.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "scans": [],
        "licensed": true,
        "change_license_at": "2025-07-26T01:15:55.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:
totam

Query Parameters

include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • software
  • tags
  • scans
Example:
certificates
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/assets/totam?include=certificates" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46e-4f96-48d0-92d4-cec39971cf7b",
        "company_id": "4254766",
        "name": "Dr. Chadd Boyer",
        "identifier": "99:08:89:0C:01:CC",
        "host": "37.11.161.27",
        "mac_address": "99:08:89:0C:01:CC",
        "hostname": "nolan.biz",
        "operating_system": "dolor",
        "operating_system_name": "aut",
        "first_seen": "2013-05-08T16:36:02.000000Z",
        "last_seen": "1973-07-03T17:28:53.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "scans": [],
        "licensed": false,
        "change_license_at": "2025-08-09T17:01:23.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:
deserunt

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/assets/deserunt" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ln\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "9f5db46e-551a-43c5-8b0b-f7a7121a341f",
        "company_id": "5769246",
        "name": "Rickey Herman",
        "identifier": "4C:3D:C6:86:8A:58",
        "host": "206.54.252.53",
        "mac_address": "4C:3D:C6:86:8A:58",
        "hostname": "maggio.net",
        "operating_system": "et",
        "operating_system_name": "culpa",
        "first_seen": "2003-03-15T07:36:15.000000Z",
        "last_seen": "2001-06-28T01:35:18.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "scans": [],
        "licensed": true,
        "change_license_at": "2025-08-06T16:08:36.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:
assumenda
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/assets/assumenda" \
    --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:
certificates
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=certificates" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9f5db46e-5d81-467f-a055-76d19c93714c",
            "company_id": "8215197",
            "common_name": "donnelly.com",
            "organization": null,
            "organizational_unit": null,
            "locality": null,
            "state": "Colorado",
            "country": "MA",
            "serial": "3AXW7DV3EVU1BNOMVVO4PMM9SQRPWETJ",
            "not_valid_before": "20240702T220422Z",
            "not_valid_after": "20260929T222801Z",
            "value": "-----BEGIN CERTIFICATE-----\nqc5NpqExTczmSc5dwrBoBYycEORAOAxJm8FrFoYdKg/brcnGUeBvWWIFeboZZnrT\n2MMWees2Q4gcmJmkw7ODK0Zow+BZatwHPrsIovD8fzM1rveT7Afi9Jl9wqtE5z0a\nT2H4nDayVGWYMj0ow1nTtpw39fWQYvYpsbjc3EGYGkHCeCyb93c+mmK5ees/43cP\n7YftQLZMSe7kGof4/xbVgU3sUv9NG4nHUFslbV9NjTVRgdPAe2fyIq0F/oji+g0r\nYMYPDJhBR0ZsY5pF4djjv22yDfZmP2v5y3jJ2FzgKFUewyfjBGUyhpqHIGCNYaOS\n+yWwFI1jDoCPfhdAD6W14uVr8AkDGw3ANlbM5TFmfaqZbnv9ryssjk92qN07E+ta\n8RrfQEZSHMuVc8HnmFbuaXqqA/zPs1jdUwMZK1XBCbbyG2grLB9b2TEnfXLVvPd6\nS9LQZKXd2vb62T/VQA1qNtvOcMh9MLGvukc8YsH5XnVSVDI/lKg4JqnFk7PEcCzW\nctJ+8JeeYgbVwaoDBtLQAM6VpJdepwj8J/3+49NKrBdaJ2DDv/PCE7ZpfYk8MjQT\nZ5MFMHYEYPzf5CeOnAg2gYPA91g5kwyVRHD5SCITgNeict5ZlM1GRaqmBmG1ouSB\nrXjvnUHLAvS976Vv8GfHMtW4caG1KCQ4ieffQAfHkS1AluzvOX0o/hC59wa+XNYQ\ngArZBFxHu2sKsbzO6329eYit9nY6x3XQITb03yPy3rtHGs7heg97bZ4uC1vRRrXa\nkomcDOnCO2kxqf7u12ck91fKR5Z3YwSSxaRh2CxWcVlpwuCf/IFNIOmw+EdML5XN\n3VL2o3vlQIKiZYozrWw8ra53LyAgbDt8i2la1h8ijuW77G4XsUI+5/+54ZlLfU5j\nFdwcClq1Pr6x+ViC5OifYq7TjOG2AwggO2Qc6extQt6tBW4p37qMcr+pTUIVoQcp\nbu4GdiXXZt6KaSEjWAuCRalw+eTXIJqBnrLKdHQekl+KHaAdYdMm6oL5BQ8v1kuj\ncw+uIkJtISjCkyr9xKizWoNT7RP+pCxs6Y6LDyhbqyQEiwgWjDKG3lD2qVM+C/VK\n5FF0OXUYiKXwkPx3W8yBg/uc+qzUD+CMgRucy4NF8LDbxKB9G42hgX/rzGaT2y0x\naiQ0vH+JoP4YW6uTS8csIFWQHrJwXcL94uuG1JVNK+7isDW0cfVhAx6ukeEDXuRV\nNMnVag/T/2sTUe8oXtOk/Fp0ZqpYhanp8KqkepgMEKAGc9CYIRl5vI9l7iitde7u\n4Gdo3Q96avXYpX10hfPDDhhcTH9DCQBS9xmKzgHQOTXGb/znFaUORsLngK6WK1d2\n6AnIyJyAhKV04EKrF2pGwg==\n\n-----END CERTIFICATE-----",
            "first_seen": "2025-02-12T09:11:45.000000Z",
            "last_seen": "2025-06-06T16:33:42.000000Z",
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        },
        {
            "id": "9f5db46e-929a-4400-a79f-9a1c26867867",
            "company_id": "78872",
            "common_name": "torphy.com",
            "organization": null,
            "organizational_unit": null,
            "locality": "Katarinahaven",
            "state": "Idaho",
            "country": "AW",
            "serial": "XR6B3NI0ZNQHRCO8R23KHRBEOQ4VIRCY",
            "not_valid_before": "20240610T110959Z",
            "not_valid_after": "20270226T063857Z",
            "value": "-----BEGIN CERTIFICATE-----\nEy59yZZUEXxUNiWrvZ5kZ+wZQG1sGa6KtGwwIpxixJgXb8VFYLPOgWfRr5zHeFHw\nAjpTD5dKJ5jjROoattb+zIYlJjbu1anxa5Vlg1EIdzpLU6Wlhl7DpDOEv/hBEt9f\nCR1mNnntkLsSbzxkaoKITqGiSZvyItS+ZU84xZW2EVW0Jllac9IZhxpIz7bC+jf2\nBTnDa4HznjLdcSICcMQxL7DW8SM8S143YM9QZ7NwqyaEOan3Ro8U2Qr60Dc5/tMw\ntF3Hu+KDmLjYl3NE0tMDgP+mfNGqEihzqg56hYLF0BK7vvaoFkGN5DkH52BtXcZa\nTXDrm7D7roTBVQGx7YFK2qKlanMVI+FmRHLacG08pkixICSiY9I79T4oGMPebwpG\nccH9ZZ9IjkHAtt5zV7lWAgIwPYoN4X5Xrbgpww6Kkt/2vDjmXsUfsbe7SGI8bH3H\nIES/zP/Bdvhd2OSNQEZ5HdIVq7/cBkSHW7gHF7J56K2rlOPQZok94Ne1K47U0xXy\nbewqmEhQ41Vlj/xqVtlxUPDYU3CCichMIlEevoDjzKq7hopQTjZbrBCTfsrnfVy0\nb2govGRGWpWQBPLF6ejM8aLPkODbbRTKGEcZQHFugwK5uFs9KeNUDSdIK+hM33yW\nxeaF4Vg3tvFpeE7KBoV2pHOKiaeI22EBo9zaBU8fj6IV/iZJQCdKBqxTnmZiupxV\n7cUMIIB5mbubPMXeGXWqkuIDuI9uqlrSApY4ryLZaMiBh07TZrxw+xdvlPU3qvJB\nqmTQlJL3V8opKS2x7Tb1U/cxkM884cZ9Fjbr4Wv/F2SpxOAlANkHQlvZMdOQDkm1\n1NmCvzUTvLR3Rb2ec21/qgW6YDYP90uFc8ty2Whzd4ZvCsl0eOz+xXJJIKsegUnS\ngjw9hjx3NFYP5JsnEp6H4Yo7Ng9EGSDd+i6y7nDcd2XsrTrLLexNPbKr58EJWQhH\nKFt9QD7rMJML+q6fY3S8VLXFbET2UtgcKj/TIZAJcOZMQ89LzYyE1L0vrfuZcWir\n04flCyfV8P3sl4LM3maQGP40ANOzbklHtEkDbxKA+0iKFCL6fuUZv2DKV9CNfVIV\nh5VYP2FAGLot47B/IuD4ni4xOhjtOTJdIkDIjrFd8iSqggv2ffiqL1dVssbGzLKl\ngVd2U5uIV9GlV0Xl2ZqqhSHLoMsLMR3u/u5EtJjOuzhklAz6D3tAZLLgEoAI3mv8\nGVHieODNyO4Hc9c+eyIs3Nx800zFqg4buDmGfYPFbjPJgzEFMTt8cLgznYwxEe5k\n9Xwxlmaqw4ZF1zhbdAhBZ4V6FXSV6FDiltu5K/hbDx8OExtui2iezDTlWZVm8xBB\nNjw53p/urczOYoB6aqPh/A==\n\n-----END CERTIFICATE-----",
            "first_seen": "2024-07-17T05:45:57.000000Z",
            "last_seen": "2024-12-07T04:04:47.000000Z",
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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:
organization
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=organization" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    content-security-policy
                                                            : frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.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:
quo

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/quo?include=applications" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46e-9a19-45de-bb3f-7ea8df1d9263",
        "company_id": "6882023",
        "common_name": "rice.com",
        "organization": "Aufderhar-Ruecker",
        "organizational_unit": "LLC",
        "locality": "Weissnatmouth",
        "state": "Louisiana",
        "country": "GA",
        "serial": "LJFDVPBL7VWDYNHUEGMNHGR8SDNAVZA6",
        "not_valid_before": "20230807T011337Z",
        "not_valid_after": "20270325T054547Z",
        "value": "-----BEGIN CERTIFICATE-----\nNvzb+ixXjnmm84R0NtoV4rWJTErRBGXW1/nqw4/DR5Faj0BtfjrbGEq6uas31tFg\nXtXcUud5e64HuB1eU/h/Of0k7MYDZOnQY7iDtRfh9cFQy64z+UQAqbqZQDe7GcPx\ntNUjOci0FvPbeYFKghPKwb6A0lb7iY7tC6om9Uq+IWjQ+AgwD498lqeTe1e4O07M\ni0i0iGCQuCVanvKhOxXQ0KdMVXennhZDp8jgDFBS1tJdpvWF/5vfdcUFKX+0hLnP\nORGmBmUt+xB06GjtyhMQ6YRAPPmKRNTrWkNmYfST5Yp0AUYpznPC7bByjpq6ot8i\nJLr0LJgZaYJQ0W+XL9nP0Ql0/lbhFzVt/67t4hvfKHBwTJLtOySWhL7JvP2YGWwC\n/ifxyKJKcDU+/BPawPh0AEwI8C5pxzwqx0YKy/TxbNSSjAZxOZ4QNZUseN4kN/LI\nxyt/9AugAyum0GxDVHkWLtuIKaLkXDkJTCevEylnc6cvBfOAbP6gOMEPGWeO6IvB\n8Uf9u1kKJnUItywIyJyvHeXMGYOFiZwfLX94jdkG34Um2w8vpumF1mvbWgmMSYW6\nUO3fwNlFbas4W7x7afe/OJB+Fi/klseNGX/fZ3wwSkJDVdU8CYN7xnUzkw/CE5t3\nCB8Xpk0hHZgYxTk6HXDkJqyiXAH1YOyyvl8DnLw9B//oDm18yXwucmlYsSuiX/Rb\nmhHBI3+uvCVNIKzTEdDoZuHjHzmeMNQ85KosWmgLzq1RPlUTtjKLG6dRwtXuYZot\nuTTtzEnvErTkJCYBClwlJUnPW0beOUZosm5tdG/iBAzUSv63pjdO3yhcTv1s9bZc\nEEiGkYO3zQgSDkXBjzl5ElL4ZXliiHdDJN0suky9R9F5M1F6+hHO7ctiULbxzxcS\nb8kheBmC6n2pBGkOoFGTDvSVpyo6n6yF/HGY2K3WxodwuWDSkzOLG3fMa8IzwJhF\ngfQE8zpvhnE0DwzSuimQKMUZCtvh28MYRW2yOO7tL3sAmqoKw21Pg1xocFqaYGWP\nZpQvcBL9t0QIg4JUbenN2K9GO3fxSySYjgj02nYeUVb2WcykYfNckCnghrNiCLnF\nApjz51CqhJ0k5e/5krRKE+Lzs8mxgvfhBDnLRrjLD+jPxUKaHhUs7+0tbqOyafbM\nxlGZDaEL2EOGPSzSnu/vtBkCJYOTiVZYF+kwEyTpRahP4o5sSlfOKLrXLfJxIiaR\naCbhTTPbkDA5yW9cZfBjZtNTfZzXBmAmOrwylUn2NkFAsfHpdDv522zGJDeUF1lQ\ntquzdGnfttmPRH2RTwH8EjVCOVe7+neNMWj6VaiFztdZ6b48y3E9WOW8Qcv8pHHJ\nQBWqUTcQi2ZlmSz9PxEeBQ==\n\n-----END CERTIFICATE-----",
        "first_seen": "2023-09-19T21:45:45.000000Z",
        "last_seen": "2024-08-12T01:51:53.000000Z",
        "created_at": "2025-07-11T15:34:39.000000Z",
        "updated_at": "2025-07-11T15:34:39.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:
quia
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/certificates/quia" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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:
dolores
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations/dolores/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
                                                            : frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.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."
}

Integrations

APIs for managing integrations

List Integrations

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

Retrieve all enabled integrations for the current company.

Headers

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

Enable Integration

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

Enable a new integration for the current company.

Headers

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

URL Parameters

integration
string
required

The name of the integration to enable.

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

Show Integration

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

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

Headers

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

URL Parameters

integration
string
required

The name of the integration to retrieve.

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

Update Integration

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

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

Headers

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

URL Parameters

integration
string
required

The name of the integration to update.

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

Disable Integration

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

Disable a specific integration for the current company.

Headers

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

URL Parameters

integration
string
required

The name of the integration to disable.

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

Me

APIs for managing the authenticated user

Retrieve the authenticated user

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

Retrieves the authenticated user and its metadata.

Headers

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

Query Parameters

include
string

Include additional relationships (comma separated).

Must be one of:
  • company
  • company.type
  • company.partner
  • managingCompany
  • managingCompany.type
  • managingCompany.partner
Example:
managingCompany.type
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/me?include=managingCompany.type" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "2a705b2e-9abb-473c-bd06-f023de02fe1f",
        "company_id": "3638092",
        "managing_company_id": "3638092",
        "first_name": "Romaine",
        "last_name": "Purdy",
        "two_factor_enabled": false,
        "two_factor_configured": false,
        "email": "ryder.deckow@hotmail.com",
        "email_verified_at": "2025-07-11T15:34:37Z",
        "phonenumber": "480.268.3767",
        "phonenumber_verified_at": "2025-07-11T15:34:37Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "3638092",
                "uuid": "d2f39ffe-df31-4958-814f-c3dd9aa9a646",
                "name": "Hills-McKenzie",
                "count_detections": null
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "abilities": [],
        "need_to_configure_2fa": false,
        "terms_agreed_at": "2025-07-11T15:34:37Z",
        "sso_provider": null,
        "created_at": "2025-07-11T15:34:37Z",
        "updated_at": "2025-07-11T15:34:37Z"
    },
    "links": {
        "self": "http://api.securityhive.io/v1/me"
    }
}

Update the authenticated user

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

Updates the authenticated user

Headers

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

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/me" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"phonenumber\": \"+31612345678\",
    \"managing_company_id\": \"1\",
    \"report_interval\": \"weekly\",
    \"terms_agreed_at\": \"2025-07-11T15:34:37\",
    \"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:
non
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:
business_impact
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=non&filter%5Bbusiness_impact%5D=high&filter%5Bsystem_tag%5D=1&sort=business_impact&include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9f5db46e-a210-4a1e-a0d4-e5e8f201c4c4",
            "company_id": "2108526",
            "name": "1214e092-78d6-3867-865f-7d42f7ff4d2f",
            "description": "Eum enim quis eos sit cum ipsa sapiente. Consectetur voluptatibus necessitatibus ab rerum voluptatem. Repellendus sint illo quasi non perspiciatis.",
            "business_impact": "critical",
            "system_tag": false,
            "asset_count": 0,
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        },
        {
            "id": "9f5db46e-a510-4fcb-8b7d-0a315d6729c9",
            "company_id": "4783903",
            "name": "f2daa712-3173-3ffe-8da4-66c80e2e16ce",
            "description": "Et praesentium molestiae voluptatem repellat est ullam. Aut quis voluptate voluptatem necessitatibus nulla. Est corporis magni nihil ut assumenda saepe. In quia sit totam unde quibusdam.",
            "business_impact": "low",
            "system_tag": true,
            "asset_count": 0,
            "created_at": "2025-07-11T15:34:39.000000Z",
            "updated_at": "2025-07-11T15:34:39.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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\": \"agj\",
    \"description\": \"Architecto nulla consequuntur consectetur reprehenderit sunt.\",
    \"business_impact\": \"high\"
}"
Example response:
{
    "data": {
        "id": "9f5db46e-aae6-4c5e-ab14-9dad3a341fb5",
        "company_id": "1587531",
        "name": "e92fabc4-cdaa-3021-a327-245bd394fb0a",
        "description": "Voluptatibus aliquam odio tempora eveniet voluptatem aliquam facilis. Rerum optio explicabo vel. Magnam ratione saepe voluptate voluptatem aperiam veniam explicabo.",
        "business_impact": "low",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2025-07-11T15:34:39.000000Z",
        "updated_at": "2025-07-11T15:34:39.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:
sapiente

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/sapiente?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46e-af9f-42a2-bd74-bfd46b4b25c6",
        "company_id": "4752896",
        "name": "d2effd91-d95f-3608-b580-8372e654a903",
        "description": "Quia totam velit neque vel aut cum nostrum dicta. Odio quam debitis illum ad. Sunt minima laudantium nostrum et id hic aut.",
        "business_impact": "critical",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2025-07-11T15:34:39.000000Z",
        "updated_at": "2025-07-11T15:34:39.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:
tenetur

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/tags/tenetur" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qpilptmchuhoidenlahdnfh\",
    \"description\": \"Totam ad laborum eligendi qui.\",
    \"business_impact\": \"low\"
}"
Example response:
{
    "data": {
        "id": "9f5db46e-b4fe-4581-9a45-4c0c4e6f5dd2",
        "company_id": "3920191",
        "name": "c1985553-0365-3d60-a424-195c66168520",
        "description": "Fuga doloribus qui maiores et. Ratione omnis est in velit illo et vitae. Rem soluta accusantium quod nemo modi sit impedit. Omnis dignissimos porro quasi placeat et incidunt fuga.",
        "business_impact": "high",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2025-07-11T15:34:39.000000Z",
        "updated_at": "2025-07-11T15:34:39.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:
est
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/tags/est" \
    --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": "f02bcc55-7a33-4ba2-a995-748174d88f58",
            "company_id": "8424816",
            "managing_company_id": "8424816",
            "first_name": "Liliana",
            "last_name": "Pagac",
            "two_factor_enabled": false,
            "email": "zbednar@gmail.com",
            "email_verified_at": "2025-07-11T15:34:38.000000Z",
            "phonenumber": "(330) 497-9003",
            "phonenumber_verified_at": "2025-07-11T15:34:38.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "8424816",
                    "uuid": "2a23c2d3-165b-4e39-b994-a1f6b76afd78",
                    "name": "Kutch, Koch and Nicolas",
                    "count_detections": null
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-07-11T15:34:38.000000Z",
            "sso_provider": null,
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.000000Z"
        },
        {
            "id": "27cd76d8-d238-4877-b235-199eb8e89580",
            "company_id": "3705013",
            "managing_company_id": "3705013",
            "first_name": "Oma",
            "last_name": "Kilback",
            "two_factor_enabled": false,
            "email": "wjenkins@carter.info",
            "email_verified_at": "2025-07-11T15:34:38.000000Z",
            "phonenumber": "+12209401206",
            "phonenumber_verified_at": "2025-07-11T15:34:38.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "3705013",
                    "uuid": "d45285c9-9d07-4963-9dfc-d3eaddbe7bc6",
                    "name": "Considine, Thiel and Tillman",
                    "count_detections": null
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-07-11T15:34:38.000000Z",
            "sso_provider": null,
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.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",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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\": \"dce\",
    \"last_name\": \"ahekawqzwkhdwkfoxfsias\",
    \"email\": \"tabitha.kiehn@example.org\",
    \"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:
e41cb164-e7b2-3570-bf8d-99da10a5a23f

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/e41cb164-e7b2-3570-bf8d-99da10a5a23f?include=company" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "62c71989-ca2f-40f7-b422-f356d0b35d4e",
        "company_id": "9947654",
        "managing_company_id": "9947654",
        "first_name": "Cassie",
        "last_name": "Witting",
        "two_factor_enabled": false,
        "email": "bednar.billy@hotmail.com",
        "email_verified_at": "2025-07-11T15:34:38.000000Z",
        "phonenumber": "+1 (254) 297-5342",
        "phonenumber_verified_at": "2025-07-11T15:34:38.000000Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "9947654",
                "uuid": "29f3630d-1462-444e-9b60-70c769b20e50",
                "name": "Mayer-Rice",
                "count_detections": null
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "terms_agreed_at": "2025-07-11T15:34:38.000000Z",
        "sso_provider": null,
        "created_at": "2025-07-11T15:34:38.000000Z",
        "updated_at": "2025-07-11T15:34:38.000000Z"
    }
}
{
    "message": "user not found"
}

Update an user

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

Updates an user for the current company.

Headers

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

URL Parameters

user_uuid
string
required

string The id of the user

Example:
68a87cc4-f1e3-3b26-9719-92bd534b3ca1

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/users/68a87cc4-f1e3-3b26-9719-92bd534b3ca1" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email\": \"john@doe.com\",
    \"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"
}

Delete an user

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

Deletes 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:
852bfa7b-9a2e-3ecb-8d6f-b874b398c5a4
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/users/852bfa7b-9a2e-3ecb-8d6f-b874b398c5a4" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "user not found"
}

Vulnerabilities

Manage vulnerabilities that have been discovered on your network.

List vulnerabilities.

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

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

Headers

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

Query Parameters

filter[name]
Filter vulnerabilities by their name
Example:
SQL
filter[host]
Filter vulnerabilities found on host
Example:
192.168.1.1
filter[hostname]
Filter vulnerabilities found on hostname
Example:
laptop-1.local
filter[status]
Filter vulnerabilities by their status
Must be one of:
  • Resolved
  • Unresolved
  • Accepted
  • Detected
  • Expired
Example:
Resolved
filter[threat]
Filter vulnerabilities by their threat level
Must be one of:
  • Log
  • Low
  • Medium
  • High
  • Critical
Example:
High
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=Resolved&filter%5Bthreat%5D=High&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\": \"jrahdqfovsyhrofqdzrjie\",
        \"threat_level\": \"Medium\",
        \"host\": \"baifzmmqtejismyabdiqlussc\",
        \"hostname\": \"xofozhkdvddovokvtqond\",
        \"status\": \"Accepted\",
        \"scan_id\": \"06c6a834-2920-3ada-be6c-3498242a9f6b\"
    },
    \"per_page\": 3
}"
Example response:
{
    "data": [
        {
            "id": "9f5db46e-1b81-41d2-8e94-d7e1c0a442f7",
            "asset_id": "9f5db46e-116f-4fb4-9ef3-499d7f171058",
            "company_id": "6959156",
            "vulnerability_definition_id": "9f5db46e-1ab3-47f4-b084-686157fc0280",
            "vulnerability_definition": {
                "id": "9f5db46e-1ab3-47f4-b084-686157fc0280",
                "name": "Unnecessary Services Enabled exploitable through enim manipulation",
                "description": "Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.",
                "solution": "Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.",
                "category": "Unnecessary Services Enabled",
                "threat_level": "Critical",
                "definition_type": "openvas",
                "definition": {
                    "id": "9f5db46e-188d-4afb-9475-abad4f8f46d8",
                    "o_id": "d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1",
                    "name": "Unnecessary Services Enabled exploitable through enim manipulation",
                    "family": "Unnecessary Services Enabled",
                    "reference_urls": "http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo",
                    "reference_cves": "CVE-2015-5505, CVE-2017-8491",
                    "solution_type": "WorkAround",
                    "solution_description": "Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.",
                    "summary": "Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.",
                    "insight": "Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.",
                    "affected": "Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.",
                    "impact": "Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.",
                    "vuldetect": "Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.",
                    "priority": "Critical",
                    "qod_type": "registry",
                    "qod_value": 2
                },
                "cvss_base_score": 4.5,
                "cvss_base_vector": "AV:A/AC:H/Au:M/C:P/I:P/A:N",
                "epss": null,
                "created_at": "2025-07-11T15:34:38.000000Z",
                "updated_at": "2025-07-11T15:34:38.000000Z"
            },
            "host": "241.50.112.132",
            "hostname": "schinner.com",
            "port": "general/tcp",
            "details": "Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.",
            "status": "Unresolved",
            "first_seen": "2024-08-19T06:47:03.000000Z",
            "last_seen": "2024-09-30T15:23:13.000000Z",
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.000000Z",
            "name": "Unnecessary Services Enabled exploitable through enim manipulation",
            "description": "Error dolores quos eius dignissimos. Ut eius rerum aliquid omnis esse. Molestias assumenda quia magnam eos deleniti veniam.",
            "cvss_base_score": 4.5,
            "cvss_base_vector": "AV:A/AC:H/Au:M/C:P/I:P/A:N",
            "qod_type": "registry",
            "qod_value": 2,
            "threat": "Critical",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "9f5db46e-188d-4afb-9475-abad4f8f46d8",
                "o_id": "d0407f0f-9a9d-3c46-a67b-9438f4e5b3a1",
                "name": "Unnecessary Services Enabled exploitable through enim manipulation",
                "family": "Unnecessary Services Enabled",
                "reference_urls": "http://www.kertzmann.biz/est-quos-corporis-voluptas, https://www.luettgen.com/ipsam-aut-deserunt-est-illo",
                "reference_cves": "CVE-2015-5505, CVE-2017-8491",
                "solution_type": "WorkAround",
                "solution_description": "Est sint nesciunt laborum earum hic tempore quae. Voluptas nulla sunt eum labore sapiente. Recusandae a iste vero eius sed occaecati. Libero fuga tempore ab sed.",
                "summary": "Exercitationem et numquam eius rerum accusantium. Quidem est est enim nesciunt non necessitatibus eveniet. Aut ut quo in doloribus velit.",
                "insight": "Illo molestias natus itaque nesciunt. Omnis aliquid aperiam sint est ea odio dignissimos. Aut corporis libero eligendi doloribus.",
                "affected": "Voluptas rerum sit dolores. Aut cupiditate soluta quia iure occaecati odit vel. Et dignissimos vero eum quos repudiandae nostrum sed.",
                "impact": "Est voluptates reiciendis et ut impedit repellat nam. Nemo ducimus cumque est laborum ipsum occaecati.",
                "vuldetect": "Repellat sapiente quasi est sapiente consectetur recusandae. Maiores illo libero ea assumenda et minus iusto. Dolorem ea est quisquam ex consequatur et ut. Enim dolores est repellendus aut aut est quisquam.",
                "priority": "Critical",
                "qod_type": "registry",
                "qod_value": 2
            }
        },
        {
            "id": "9f5db46e-2555-4847-bece-1bc4a6796124",
            "asset_id": "9f5db46e-2023-4761-a988-59789bef366b",
            "company_id": "6204753",
            "vulnerability_definition_id": "9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8",
            "vulnerability_definition": {
                "id": "9f5db46e-240d-4dc3-9fc8-c96ad9c9dab8",
                "name": "Integer Heap Overflow in et",
                "description": "Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.",
                "solution": "Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.",
                "category": "Heap Overflow",
                "threat_level": "Low",
                "definition_type": "openvas",
                "definition": {
                    "id": "9f5db46e-22c7-4bac-ace5-9bf0a8f97c24",
                    "o_id": "dbe52303-5221-32eb-b3cb-c8f4a06f4c5e",
                    "name": "Integer Heap Overflow in et",
                    "family": "Heap Overflow",
                    "reference_urls": "http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html",
                    "reference_cves": "CVE-2021-2567, CVE-2022-5076",
                    "solution_type": "Configuration Change",
                    "solution_description": "Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.",
                    "summary": "Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.",
                    "insight": "Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.",
                    "affected": "Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.",
                    "impact": "Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.",
                    "vuldetect": "Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.",
                    "priority": "Low",
                    "qod_type": "package",
                    "qod_value": 63
                },
                "cvss_base_score": 0.3,
                "cvss_base_vector": "AV:P/AC:L/Au:N/C:N/I:C/A:C",
                "epss": null,
                "created_at": "2025-07-11T15:34:38.000000Z",
                "updated_at": "2025-07-11T15:34:38.000000Z"
            },
            "host": "17.98.28.129",
            "hostname": "hermann.net",
            "port": "5432/tcp",
            "details": "Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.",
            "status": "Accepted",
            "first_seen": "2025-06-17T11:58:51.000000Z",
            "last_seen": "2025-07-04T02:00:47.000000Z",
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.000000Z",
            "name": "Integer Heap Overflow in et",
            "description": "Est ut nihil et quidem doloribus. Sunt dolorem voluptate eos iste. Autem et dolores et repellat et id. Sed aut aliquid modi adipisci.",
            "cvss_base_score": 0.3,
            "cvss_base_vector": "AV:P/AC:L/Au:N/C:N/I:C/A:C",
            "qod_type": "package",
            "qod_value": 63,
            "threat": "Low",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "9f5db46e-22c7-4bac-ace5-9bf0a8f97c24",
                "o_id": "dbe52303-5221-32eb-b3cb-c8f4a06f4c5e",
                "name": "Integer Heap Overflow in et",
                "family": "Heap Overflow",
                "reference_urls": "http://mueller.com/, http://www.altenwerth.net/expedita-nulla-maiores-ipsa-doloremque-fugit-fugiat-dolor-iste.html",
                "reference_cves": "CVE-2021-2567, CVE-2022-5076",
                "solution_type": "Configuration Change",
                "solution_description": "Molestiae quas eum et veritatis velit quisquam nihil. Deserunt aut repellendus aut officiis nesciunt qui ea. Vel eveniet modi tempore quisquam qui. Minima laudantium voluptatem impedit qui ipsa cum.",
                "summary": "Delectus sint est hic est dolorem autem assumenda illo. Quia odit omnis magni dolorum. Aut fugiat enim aliquid.",
                "insight": "Voluptas nihil consequatur quo in iure. Fugit saepe molestias molestias. Dolores nobis iusto voluptate reprehenderit. Iusto expedita fuga ducimus quia sit sequi recusandae. Impedit occaecati impedit iste aut earum et.",
                "affected": "Ut possimus eveniet maiores quam doloribus. Tempora tempora repellendus sit magni aut. Facere fuga rerum id fuga. Consequatur velit enim quia qui nobis.",
                "impact": "Molestiae et alias aut. Commodi veritatis est tempore nisi. Iure qui unde ut ipsum doloremque dolores.",
                "vuldetect": "Beatae at nulla omnis vero fugiat. Ipsa maxime laboriosam quia quia nostrum. Consectetur amet labore quisquam laboriosam dolorem voluptatem. Minima quia voluptas qui ut sit officiis.",
                "priority": "Low",
                "qod_type": "package",
                "qod_value": 63
            }
        }
    ],
    "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",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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:
sed
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities/sed" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46e-32f1-4a95-874b-b11f4f261f9c",
        "asset_id": "9f5db46e-2e87-4bc7-83cf-29fd91919a9c",
        "company_id": "5531164",
        "vulnerability_definition_id": "9f5db46e-3265-45fa-a1ad-b707efbd9a1c",
        "vulnerability_definition": {
            "id": "9f5db46e-3265-45fa-a1ad-b707efbd9a1c",
            "name": "Error-based NoSQL Injection affecting exercitationem functionality",
            "description": "Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.",
            "solution": "Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.",
            "category": "NoSQL Injection",
            "threat_level": "Low",
            "definition_type": "openvas",
            "definition": {
                "id": "9f5db46e-3112-4e3b-808d-f2eb9adb59a9",
                "o_id": "bfd73381-9a69-392d-b708-8387c9d027dc",
                "name": "Error-based NoSQL Injection affecting exercitationem functionality",
                "family": "NoSQL Injection",
                "reference_urls": "http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html",
                "reference_cves": "CVE-2021-4778, CVE-2015-9271",
                "solution_type": "Mitigation",
                "solution_description": "Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.",
                "summary": "Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.",
                "insight": "Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.",
                "affected": "Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.",
                "impact": "Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.",
                "vuldetect": "Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.",
                "priority": "Critical",
                "qod_type": "exploit",
                "qod_value": 87
            },
            "cvss_base_score": 7.6,
            "cvss_base_vector": "AV:N/AC:H/Au:S/C:C/I:N/A:P",
            "epss": null,
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.000000Z"
        },
        "host": "157.210.161.125",
        "hostname": "tillman.info",
        "port": "443/tcp",
        "details": "Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.",
        "status": "Expired",
        "first_seen": "2024-11-26T15:32:17.000000Z",
        "last_seen": "2025-03-04T15:43:13.000000Z",
        "created_at": "2025-07-11T15:34:38.000000Z",
        "updated_at": "2025-07-11T15:34:38.000000Z",
        "name": "Error-based NoSQL Injection affecting exercitationem functionality",
        "description": "Reprehenderit explicabo ad eos libero consequuntur in assumenda molestiae. Nostrum hic enim est consequuntur autem. Sint officiis impedit ut quia suscipit sit eveniet.",
        "cvss_base_score": 7.6,
        "cvss_base_vector": "AV:N/AC:H/Au:S/C:C/I:N/A:P",
        "qod_type": "exploit",
        "qod_value": 87,
        "threat": "Low",
        "scanner_id": null,
        "scanner_hostname": null,
        "plugin": {
            "id": "9f5db46e-3112-4e3b-808d-f2eb9adb59a9",
            "o_id": "bfd73381-9a69-392d-b708-8387c9d027dc",
            "name": "Error-based NoSQL Injection affecting exercitationem functionality",
            "family": "NoSQL Injection",
            "reference_urls": "http://www.boyer.com/, https://emmerich.com/a-dolorum-pariatur-et-quia-illum-qui.html",
            "reference_cves": "CVE-2021-4778, CVE-2015-9271",
            "solution_type": "Mitigation",
            "solution_description": "Ipsam illum atque autem eos aut tenetur impedit. Ut cumque odit delectus maiores non vero modi qui. Quo totam quas a voluptatem at veniam.",
            "summary": "Voluptatem sit ab a necessitatibus saepe praesentium corrupti. Cum illo sapiente cupiditate labore quia error et. Ullam eligendi facilis sint impedit ut est.",
            "insight": "Consequatur facilis eum repellendus aut. Rerum natus itaque dolor voluptate sapiente quia nesciunt ex. Reiciendis eos ea quas nostrum tempora. Error dolor id enim sunt sint ut hic.",
            "affected": "Ut vitae et repellat quis qui quaerat. Libero quibusdam tempora sunt sit voluptatum sunt. Et et alias ipsum dicta aut dolorum quis.",
            "impact": "Et eos enim nihil inventore incidunt est totam. Magni quas odio ut voluptatem quisquam.",
            "vuldetect": "Recusandae et optio distinctio. Excepturi ipsum dolorem omnis nemo id. Qui nihil possimus maxime quia deserunt qui sed ipsam. Delectus consectetur ut libero.",
            "priority": "Critical",
            "qod_type": "exploit",
            "qod_value": 87
        }
    }
}

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:
event
filter
string

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

Must be one of:
  • webhook_id
  • event
  • status
Example:
status
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events?sort=event&filter=status" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9f5db46c-c12f-40b3-8ae9-eccf4824c5e1",
            "webhook_id": "9f5db46c-c073-4182-b1af-6d288d5660ef",
            "event": "rerum",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.000000Z"
        },
        {
            "id": "9f5db46c-c4ea-4799-b2ee-517be0f587d0",
            "webhook_id": "9f5db46c-c40a-482d-94e6-65c602b96227",
            "event": "cupiditate",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-07-11T15:34:38.000000Z",
            "updated_at": "2025-07-11T15:34:38.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",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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
                                                            : frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.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:
9f5db46c-c12f-40b3-8ae9-eccf4824c5e1
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events/9f5db46c-c12f-40b3-8ae9-eccf4824c5e1" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46c-d0c6-4672-9d17-401e5be67372",
        "webhook_id": "9f5db46c-cfec-4d78-9b6c-bf1d7822419b",
        "event": "nobis",
        "payload": {
            "key": "value"
        },
        "status": "pending",
        "retries": 0,
        "next_retry_at": null,
        "last_sent_at": null,
        "created_at": "2025-07-11T15:34:38.000000Z",
        "updated_at": "2025-07-11T15:34:38.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": "9f5db46c-a451-4316-87de-b35931447360",
            "company_id": "d577cef5-ab91-41c5-b656-1f50bea577b0",
            "url": "https://orn.org",
            "description": null,
            "events": [],
            "secret": "685f419ec6729b1632e4179e38ce3e9c13921f8c88eeff1a6a700e5c4dd7a0dc",
            "last_sent_at": null,
            "created_at": "2025-07-11T15:34:37.000000Z",
            "updated_at": "2025-07-11T15:34:37.000000Z"
        },
        {
            "id": "9f5db46c-a883-4689-9ac8-0035125a9275",
            "company_id": "0a33bbf0-4791-48fe-b373-1573adef4f03",
            "url": "https://bednar.biz",
            "description": null,
            "events": [],
            "secret": "ea2e0775a17daf2fd89af0d94fba9079aacd8c7b2d6ab3fc4c10a98987355b49",
            "last_sent_at": null,
            "created_at": "2025-07-11T15:34:37.000000Z",
            "updated_at": "2025-07-11T15:34:37.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:\\/\\/medhurst.org\\/explicabo-ea-et-velit-deserunt-officia\",
    \"description\": \"Inventore quia modi temporibus eius voluptatum soluta accusantium.\"
}"
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:
9f5db46c-a451-4316-87de-b35931447360
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhooks/9f5db46c-a451-4316-87de-b35931447360" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46c-b0c7-4805-9e6c-0009022f494d",
        "company_id": "2a22ce05-074e-4b8b-b29d-d2d3f453502c",
        "url": "https://vonrueden.info",
        "description": null,
        "events": [],
        "secret": "128627eec4898cdc16cf56512e649eea63550d57535e7f6b0562db452fb92289",
        "last_sent_at": null,
        "created_at": "2025-07-11T15:34:37.000000Z",
        "updated_at": "2025-07-11T15:34:37.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:
9f5db46c-a451-4316-87de-b35931447360
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/9f5db46c-a451-4316-87de-b35931447360/rotate-secret" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9f5db46c-b5d4-42b4-8f15-f0808735899e",
        "company_id": "d9a220bf-3fc7-481f-bf7e-9057143b6bdc",
        "url": "https://lueilwitz.info",
        "description": null,
        "events": [],
        "secret": "06c7eda4cb849efeb06f80d5ef4f035730da95bd02d5f709a5caca1697062697",
        "last_sent_at": null,
        "created_at": "2025-07-11T15:34:37.000000Z",
        "updated_at": "2025-07-11T15:34:37.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:
9f5db46c-a451-4316-87de-b35931447360
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/9f5db46c-a451-4316-87de-b35931447360/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:
9f5db46c-a451-4316-87de-b35931447360

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/webhooks/9f5db46c-a451-4316-87de-b35931447360" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.pagac.org\\/\",
    \"description\": \"Non nisi cumque assumenda non ullam qui.\"
}"
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:
9f5db46c-a451-4316-87de-b35931447360
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/webhooks/9f5db46c-a451-4316-87de-b35931447360" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "webhook not found"
}