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": "9fe86d13-0a36-4922-bc0c-625d1f17cc8e",
            "cpe": "cpe:2.3:a:oracle:database:*:*:*:*:*:*:*:*",
            "vendor": "Oracle",
            "product": "Database",
            "version": "2.46.1854",
            "update": "build8214",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        {
            "id": "9fe86d13-0b8c-4554-8f02-9fab2565072e",
            "cpe": "cpe:2.3:a:mozilla:thunderbird:*:*:*:*:*:*:*:*",
            "vendor": "Mozilla",
            "product": "Thunderbird",
            "version": "19.0.7519",
            "update": "update1",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.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:
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-report-only
                                                            : default-src 'self'; script-src 'self' 'nonce-7UZ44NCnNiBq4o0PBlcqfYhQ5kMOk14Mpb5Gfrlr' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-elem 'self' 'nonce-7UZ44NCnNiBq4o0PBlcqfYhQ5kMOk14Mpb5Gfrlr' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; img-src 'self' data: blob: https://*.intercomcdn.com https://www.gravatar.com; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data:; 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; 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:
itaque

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/itaque?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d13-1032-4c38-9d5d-8f9a76d80745",
        "cpe": "cpe:2.3:a:apple:iwork:*:*:*:*:*:*:*:*",
        "vendor": "Apple",
        "product": "iWork",
        "version": "1.97.2033",
        "update": "sp1",
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
licensed
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?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=licensed&include=scans" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9fe86d12-c0ff-48e0-87fa-4901a1a35e32",
            "company_id": "4402193",
            "name": "Raymundo Mraz",
            "identifier": "A5:65:22:7C:9C:F0",
            "host": "237.248.87.124",
            "mac_address": "A5:65:22:7C:9C:F0",
            "hostname": "parker.com",
            "operating_system": "quis",
            "operating_system_name": "rerum",
            "first_seen": "1994-08-13T23:56:46.000000Z",
            "last_seen": "2025-08-30T21:02:13.000000Z",
            "open_tcp_ports": "80,443",
            "open_udp_ports": "53,123",
            "traceroute": [],
            "ssh_key": null,
            "average_scan_duration": 0,
            "licensed": true,
            "change_license_at": null
        },
        {
            "id": "9fe86d12-c480-474b-8e4d-7971d18fafe2",
            "company_id": "181115",
            "name": "Leone Vandervort MD",
            "identifier": "193.115.233.243",
            "host": "193.115.233.243",
            "mac_address": null,
            "hostname": "rowe.org",
            "operating_system": "quia",
            "operating_system_name": "qui",
            "first_seen": "1972-08-29T19:48:59.000000Z",
            "last_seen": "2025-07-14T17:35: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": "2025-09-22T17:29: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\": \"addTags\",
            \"id\": \"qui\",
            \"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\": \"yaziplfst\",
    \"host\": \"eveniet\",
    \"licensed\": false
}"
Example response:
{
    "data": {
        "id": "9fe86d12-cd39-4464-9f49-fb8d059a5aba",
        "company_id": "2857872",
        "name": "Richard Terry",
        "identifier": "EA:B6:D8:C6:7C:DB",
        "host": "239.70.17.177",
        "mac_address": "EA:B6:D8:C6:7C:DB",
        "hostname": "tromp.biz",
        "operating_system": "eum",
        "operating_system_name": "aut",
        "first_seen": "1978-04-14T12:42:03.000000Z",
        "last_seen": "2016-08-18T05:13:07.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2025-09-25T17:19:34.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:
et

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/et?include=certificates" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-d214-4823-a562-98b6cddcce97",
        "company_id": "8798716",
        "name": "Dr. Hershel Bahringer PhD",
        "identifier": "DB:44:F0:17:89:D7",
        "host": "228.2.213.12",
        "mac_address": "DB:44:F0:17:89:D7",
        "hostname": "schmeler.com",
        "operating_system": "minima",
        "operating_system_name": "reprehenderit",
        "first_seen": "1987-03-08T11:51:42.000000Z",
        "last_seen": "1980-02-22T08:36:57.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2025-10-13T05:44:04.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:
et

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/assets/et" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"fsxyxrf\",
    \"licensed\": true
}"
Example response:
{
    "data": {
        "id": "9fe86d12-d796-4d12-95fd-e25fb645840c",
        "company_id": "6073557",
        "name": "Mr. Daren Schulist",
        "identifier": "CA:5F:92:7A:CC:BE",
        "host": "93.192.191.219",
        "mac_address": "CA:5F:92:7A:CC:BE",
        "hostname": "witting.info",
        "operating_system": "non",
        "operating_system_name": "voluptatem",
        "first_seen": "1975-06-24T17:42:48.000000Z",
        "last_seen": "2000-02-20T16:08:22.000000Z",
        "open_tcp_ports": "80,443",
        "open_udp_ports": "53,123",
        "traceroute": [],
        "ssh_key": null,
        "average_scan_duration": 0,
        "licensed": true,
        "change_license_at": "2025-09-29T15:09:41.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:
delectus
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/assets/delectus" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]

Certificates

Manage certificates that have been discovered on your network.

List certificates.

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

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

Headers

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

Query Parameters

filter[common_name]
Filter certificates by their common name.
Example:
test.nl
filter[organization]
Filter certificates by their organization name.
Example:
Test B.V.
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before
Must be one of:
  • not_valid_after
Example:
not_valid_after
include
Include additional relationships (comma separated).
Must be one of:
  • certificates
  • applications
  • tags
  • scans
Example:
applications
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates?filter%5Bcommon_name%5D=test.nl&filter%5Borganization%5D=Test+B.V.&sort=not_valid_after&include=applications" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9fe86d12-e0c3-4d51-bd74-ff6b2c3de31a",
            "company_id": "4822597",
            "common_name": "heathcote.net",
            "organization": "Lehner, Beer and Deckow",
            "organizational_unit": null,
            "locality": null,
            "state": "Washington",
            "country": "HT",
            "serial": "RICZILLOJPTW8QIRFEGSZ8CYCYTACPPK",
            "not_valid_before": "20241008T043112Z",
            "not_valid_after": "20261104T195716Z",
            "value": "-----BEGIN CERTIFICATE-----\na7bmn7kWPQjUTNTnyLShVrYY1ts4aq4gBoB8/93PcR3w8JLiiMSAzzMLjX8h0QFl\nGtwXGczSbjrQkDAxIfuPQ8XlSj6x9XJAXhzlDHOzHVDqgqgThhjisuviSv61AZTY\nf873YoYzCS4O5ObFBVGcwjO6OpdoAGzIY6A/iTPoHZlck4b8OzpOVzVC++YQqIrd\nZAtIJsqnTSA1hnFSNQrxhL5LNE0+FFMEvRnCpWYozTLfEFiBT9yyPbfDkpja0QaP\nzmfx2bg/sxavRG5J17MMzY30S0lrfMjTMA8agBhljUlOpaYrGgO9YyJewePKgp3T\nUPCbtFQrw22JhJoN4ryUALaS3QW4OMjZybuAoMiLePtBd5kJ+WtQkHAQnQGjIol+\nC1xrnZQTOBlSkuat5lTMwC2h3A//Eite+URdTqezkquse38796MVA9C9P5xYtSsM\ne3yTI34GAt/mZHspBs6kXL6S38A0adBFpsZG4ZrgyJ/09xcGZRiY+Ob/1brafoGN\n1/e9JEAYfHAac2NMlbf/c524x5nosMFY72WmkmO4WDRu44plk00euH1I2zdA//bE\nzl/gXITCehaVMhXdNZnOs3WG/Dul54wl8LV59r8eJaIo0i1YAUo9w0JNC+7ZSh/9\ncwmZGNXlQkfyE8mu6A+ykYkL+27Sf1VBZPPhFxZO1ps9sHO9MskWMVucpzVpEaVk\nZqJP393JzgPhRGx/mC2MhB6YB47F8gE0r3SWTJ2QgoJjdeUr3RdklBwBD6CfMsSz\nImbTndHlwYI1/TlECJnR8hS6xwok0KL62rfnKxpnsx51vkmSVn8G0aEtR/nWzLXe\nt4BJT6ou+EHI+J23DfnSG1turESeG8KF4dgv/xnyiZzhD0r5YnJWtyA/h3mConPf\n9Ao/yYUpMjxl6yafvaqzTq7d+v51uSC2WUSE/p9aG0R1hERwAul6XYfjHnumYx5H\nMvbTBINc/pk74kVEegs657tciOWenPHiGE03YODk42vLP8rFVd6LBtOZMASMGycy\nLW1hzJxRClP2AnfYow6xFiE+mMrlanHAGifdbAk3eVKiSgW4jA06TEihbZhQjMHj\nyHZJi7ujwMYs5c+BUUnG1WELdrLk83i/AhTTBOP0/FQfIoDQXeUPUXV4zuAtJ3od\nsWM/Xto2OafyoBwWT5adifFfpmCmibdR8YwFxxQI6MOaY1WHSFkJsLkcalTj2hxI\nzH51TkOKNdeYaNtpqtl/ha9qza4cUbV1k4XsAKc0tx1XCuhuHUoxDL8WzL4jzkjV\niK48Ae3Dy+7XhbPwn5PbgcPCiACHtumHZAmOK4Vca5dGgQG4njtwbbQF6JuCHyzk\no4IMj/Uj4/8Ih5LZZOcBEA==\n\n-----END CERTIFICATE-----",
            "first_seen": "2024-10-12T03:49:13.000000Z",
            "last_seen": "2025-02-07T21:50:50.000000Z",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        {
            "id": "9fe86d12-e3c2-4083-a49d-401f431b5f1e",
            "company_id": "9727666",
            "common_name": "rice.com",
            "organization": "Pouros-Bergstrom",
            "organizational_unit": "and Sons",
            "locality": null,
            "state": "West Virginia",
            "country": "MX",
            "serial": "Q1KINT99ZG7DXU7Q3XNUNVTAIJZYLSU4",
            "not_valid_before": "20240522T015313Z",
            "not_valid_after": "20261102T135410Z",
            "value": "-----BEGIN CERTIFICATE-----\nz39+9Dp61FWAzYv8m2OifMw2PjkKIWlBAL2LpII+owRJnEIwlHMrlVedJRuoND4r\nB7KKmPHF95MBoLLQrl7gvIO/pcr7GXFxdbq4P94DMLus1J0T11KceRdraPRaZDNr\nSzotUTmkuXHP2oC+f5bc+Yl6T78HNwILOoXE3zv9ijXVzKDBfIJhg9ulO/f2+V4e\neuPQaFerxrQz6lVZaFn/ZJ8Ohd9EPkOFiS5JpBggX6YkeqWmWoBM8ul6P9cxaXuk\ncXOZlBHUZkFy67x7Va+WVR7BupLlh6Vi+Cm+Ypcr1ZcI8XxnMrBhK0xAqz6Bs485\nnPXiXw6/5RjY8kbXql0eSfdNf83qh+PLLVkAfpENJg3FS8dztdogtQxm/z1UWHge\nXpIAKGwsF40M4uMxo06FCWxb/FQDou/0BGiYRvXBrxI4SISSx52z5vHCbRYW+FnH\nXiQ+6+uIS0EBydZkJF2SNRp1LiuzydST9tQbo3b63aC1QpxCm1KVvpeY+AVSoC4+\ncb3r2hwGgrdc1pjBCKTEDgEECIfWNX/SclxAk69WX9CbmEdHp1wCr2t/9g3IqCwG\nQuryIecfKf5WxyUmAiuUe+Cr5GBL7mFaHskbRMJcF7SWhbYnoOSn8r10uYk01EfG\nXnD9WgJ5AczeHPY3BZrq0GyD/0rYka4zyyH79ebA9ZqTxYOaCyXK96oFaSa3pknG\nDAgFNbplmFkMNJdXRZ/Mw+F8CNmdhIIVeOgDDd7B+tA/AtzmCoV2nWHZzCUdYOLM\nWP+C0WYmMSBxFb4pX3VhN5CwvX2lGebetAllF+r84lWddQmcce/iHfLfp77iB+Ju\nZFrTCHs17nq359E2iFusk2w/qLiDR3GMu7wwurINSkd2K+BUf/zJUYT7x2KNu2yM\njM9iTpUF06ZwnRTmmL4W3488uXcgjF2wJutX35w/M+4xrBWFpJY0IDNdnR+B/AYv\nWjcI3ZiZ7PepVaE9tcVIbGz34wl6VEj3JlG+BgzNl1ADs2VNwPUCeCPIA0yDJrNX\nOzwLgb3QvSkD8OlXjsH5lLiFpCmXRaEn9l8WlGgcVbdjhM7lIe30n88rVBv5/Z09\nKcFLpiBMIF5aJcNCDec9TUsD/7d3VkhNzxKpd3trqJ6QFfhaRKfcx/CRby0o/QfS\nMxpaOsMreErX4iaOhLQi/orPfVl8YQH6SZFKvpNfjVSVYrF6a0qKPtKEIVzRXYtP\nsa2dGznYQsBOTlJMze2MwQh7cn/DDZo7rE5CW1Vno+n0/gjkRRgzQRj4DImRQD5q\nAsYGn46N3Sl6uDGBrX5WlZ2D1omWlxVI6FnksMc+8RG/yXYd7OosveCut5G2f6qK\n3zZT5QC1o2jQJOwwChHLpA==\n\n-----END CERTIFICATE-----",
            "first_seen": "2024-05-23T10:11:16.000000Z",
            "last_seen": "2024-05-24T23:20:44.000000Z",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Export certificates.

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

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

Headers

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

Query Parameters

type
The type of export to generate
required
Must be one of:
  • csv
  • xlsx
Example:
csv
filter[common_name]
Filter certificates by their common name.
Example:
test.nl
filter[organization]
Filter certificates by their organization name.
Example:
Test B.V.
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-not_valid_before
Must be one of:
  • not_valid_after
Example:
not_valid_after
filter
The column(s) to filter by. Eg filter=common_name:test.nl
Must be one of:
  • common_name
  • organization
Example:
organization
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/certificates/export?type=csv&filter%5Bcommon_name%5D=test.nl&filter%5Borganization%5D=Test+B.V.&sort=not_valid_after&filter=organization" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    content-security-policy-report-only
                                                            : default-src 'self'; script-src 'self' 'nonce-Fa7cKr83UthWgcLurZcTZWl2d0VEjuNZP0kdLSFy' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-elem 'self' 'nonce-Fa7cKr83UthWgcLurZcTZWl2d0VEjuNZP0kdLSFy' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; img-src 'self' data: blob: https://*.intercomcdn.com https://www.gravatar.com; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data:; 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; 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:
voluptatem

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/voluptatem?include=applications" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-eacf-4f76-9cc7-8cc3595ca9b5",
        "company_id": "9058217",
        "common_name": "halvorson.com",
        "organization": null,
        "organizational_unit": "LLC",
        "locality": "Letitiafurt",
        "state": "Delaware",
        "country": "IO",
        "serial": "8AJG4X4OK4NCKHVTIF4RCEHOI7WQD2D8",
        "not_valid_before": "20241126T012258Z",
        "not_valid_after": "20250708T072556Z",
        "value": "-----BEGIN CERTIFICATE-----\nCHHGaou6Tn+nZaA6PlrXyGZIte6K1qBT5fv1wZuS453qR1Gn5w8sc+FhKhe0RW2G\nQXsNYc/0Cxv3Jgl9GctqLcjSyhfAlhmlnQ1LVKbQWq+Ih9UtuaNaQoyVAVV32oy5\nRS4Rx5DVOq0OpPRcQoiqaqD028HC/SOYlIaU0Spt+1ywjlwsWT8XbfJQXNGy8wOU\nX2yAJ+Kv3wTtZd1IFkTo9ximrarLDiEcQkhyN2zPIHVbIX9TExIEkL0B9VXH0fr2\nPzjqjjC6aU498tasKPUbZpdOXqtQvpnh3v/qG+J0krI8qO+XfPssJi58Q4ZUl3c8\nfEcy4p0eT++2b/dHNsQ3u374DYxeQuyr9+eRn7lrBpZVSwqCQsPsoAC4lydApz+L\nnF9OPqe7taEuGU1uXrqxbb7m41BDlNKI5xkCFtYVw3KBOxBO0mpaEn5/ZJx0gS0h\nAZuQ4g4vcGSeOhYaqRcf0o4CwQR7RKbx0f81Vg2ZTYT1jQlfSdszwqSLvOS0GqGq\nDbdKo+s7+n8y2ElRvzXyPkaREJelsYBX+CF5nwD2fPp8Nxz3ZVhIuAhoTp68DIcT\nMv1fXx2ddzQjKnFjp9kp/VTd42wVpns11PwuGzrznPiMcidedH2TMTtQaxjimmmP\n4/iA2wt8qz/U9nKSk5hbV6JB5JeKrOq3qgnRiA4TwpuD+382LbVGZnbYsq/AoVOP\nxzPSp0lamSuNSV9HZoT+Zrsypwhf5k5SzSuJ68ds0MeEYcvWQp4Biix8gJt6smnC\n7RWHkgRQUDPPuw4kUhMav4fq8zBdi0ooaaBK5t7oR2xlrTHlcpYqLW7eE02sWbqe\nmPmrGKZL7w1f+RDQDmzgvUTP9rcSUl6Ty3UNCh+cbQMFsKNnMS8T6l8prwgG2gny\nsoDz9zzuXhtQU0YEdMGxWs0/k1KAEkPEBn2Q+42+5qPMEBgEqrhI3lom9Ar3D2W/\nXCWPQIHrzs9aEupevHoHgePQ1w8Y8DhtPT7fr2JrfL5PwU5AP3AoYcUGN5nqmzt4\nW96aby7AKJFe+YziYkhb+DudVa3fWAND+pBfGoBPU5lDjOeiVZGowsNmgeEjnqNB\nNvnDWMlbgZJhOMkxBtf21PKf0CMETdFwyTdDLMd2YZih+kpWwKKRYUbSp+QWYRSS\nvaObxuCQWCPfIUTd6aJ5oOz/kDV556mQ6PHE+SFcGfbVMO79QJEyU+NfTxY5HhcF\nw/9GdSDC69DE82/bZ9ptXbP+ytpE7V3QRV1QFTF/OvtovkFIkRcDePg5WScdUWKr\nlqfv7BZ2ob6vWG/ILM75YC9kQbu+VKU/9NWU+aCcmy671lYALTe9wAQc/9kNZS2S\n+cipDYQvIs6YKcfEgorVug==\n\n-----END CERTIFICATE-----",
        "first_seen": "2025-02-04T19:12:17.000000Z",
        "last_seen": "2025-09-03T15:26:19.000000Z",
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
laudantium
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/certificates/laudantium" \
    --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:
ratione
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/integrations/ratione/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-Ibz4xsFHDc8B6kJisGRlJi4Cm3H2dXt2cqz11h8J' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-elem 'self' 'nonce-Ibz4xsFHDc8B6kJisGRlJi4Cm3H2dXt2cqz11h8J' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; img-src 'self' data: blob: https://*.intercomcdn.com https://www.gravatar.com; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data:; 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; 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
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/me?include=managingCompany" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "5648424b-95a1-420b-80ce-d9cdc267cd18",
        "company_id": "779675",
        "managing_company_id": "779675",
        "first_name": "Anne",
        "last_name": "Gutmann",
        "two_factor_enabled": false,
        "two_factor_configured": false,
        "email": "uoreilly@schinner.net",
        "email_verified_at": "2025-09-18T14:35:11Z",
        "phonenumber": "1-352-409-1899",
        "phonenumber_verified_at": "2025-09-18T14:35:11Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "779675",
                "uuid": "171a628d-5219-4cae-aaaf-8a179b15665e",
                "name": "Bechtelar-Towne"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "abilities": [],
        "need_to_configure_2fa": false,
        "terms_agreed_at": "2025-09-18T14:35:11Z",
        "sso_provider": null,
        "created_at": "2025-09-18T14:35:11Z",
        "updated_at": "2025-09-18T14:35:11Z"
    },
    "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-09-18T14:35:11\",
    \"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:
veritatis
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=veritatis&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": "9fe86d12-f30c-4b88-bd81-64e048aaff14",
            "company_id": "1587273",
            "name": "1620817a-d916-36de-81da-3bb333c6a1da",
            "description": "Quis vel vitae eum asperiores. Iure doloribus nihil ut eaque quia esse labore. Et excepturi est eos beatae.",
            "business_impact": "low",
            "system_tag": true,
            "asset_count": 0,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        {
            "id": "9fe86d12-f5b7-494b-b6b7-23aed2b4c935",
            "company_id": "9640736",
            "name": "a40a7a8d-4881-3ba9-a413-022707052002",
            "description": "Aut non qui eveniet illo pariatur quidem sint. Illum expedita hic dolores excepturi commodi aut odit. Qui assumenda est iste.",
            "business_impact": "critical",
            "system_tag": false,
            "asset_count": 0,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.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\": \"athsnwpyzbnpyl\",
    \"description\": \"Iusto enim quasi cumque voluptas dolorem saepe optio.\",
    \"business_impact\": \"medium\"
}"
Example response:
{
    "data": {
        "id": "9fe86d12-fb0f-4dd7-a27a-ad10d4fca159",
        "company_id": "5402570",
        "name": "a3aedb1f-e73c-3b64-8e72-e62a521f5823",
        "description": "Repellat ducimus magnam et aut dignissimos quisquam nostrum. Suscipit consequuntur explicabo aut nihil. Nulla sequi enim dignissimos dicta aut natus. Cumque eligendi aut repudiandae velit.",
        "business_impact": "medium",
        "system_tag": true,
        "asset_count": 0,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
iusto

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/iusto?include=assets" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-ff14-4214-a4e5-9a0ec6d27b53",
        "company_id": "5864336",
        "name": "d4c4001f-1852-3c6c-b459-68899d4fd38c",
        "description": "Temporibus nulla molestias minima in. Voluptatum voluptatem accusantium fuga tempore facere nemo. Qui non cumque totam. Accusantium quos eos commodi deserunt assumenda a inventore.",
        "business_impact": "critical",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
qui

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/tags/qui" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dmntvjkqvphtx\",
    \"description\": \"Asperiores natus et consequatur.\",
    \"business_impact\": \"critical\"
}"
Example response:
{
    "data": {
        "id": "9fe86d13-03be-4e3b-a28c-f765671827d3",
        "company_id": "9747659",
        "name": "ae3d9859-590c-3758-a1e8-78beaabc1fc9",
        "description": "Ea vero omnis minus aliquam eum libero. Velit ea dolores occaecati ut impedit sequi. In cupiditate consequatur aut nisi autem.",
        "business_impact": "critical",
        "system_tag": false,
        "asset_count": 0,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
et
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/tags/et" \
    --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.type
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.type&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": "ea0186c0-a88b-4e98-9984-a82a1a08e142",
            "company_id": "4992579",
            "managing_company_id": "4992579",
            "first_name": "Tanner",
            "last_name": "McDermott",
            "two_factor_enabled": false,
            "email": "bbartoletti@goyette.net",
            "email_verified_at": "2025-09-18T14:35:11.000000Z",
            "phonenumber": "254.871.2182",
            "phonenumber_verified_at": "2025-09-18T14:35:11.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "4992579",
                    "uuid": "6259aaab-2d9a-4365-abf4-a394ec8d8d11",
                    "name": "Zboncak-Kirlin"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-09-18T14:35:11.000000Z",
            "sso_provider": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:12.000000Z"
        },
        {
            "id": "47fa7464-da25-4bad-a304-6a4b0ad2d799",
            "company_id": "7258487",
            "managing_company_id": "7258487",
            "first_name": "Scottie",
            "last_name": "O'Keefe",
            "two_factor_enabled": false,
            "email": "gleichner.verna@eichmann.com",
            "email_verified_at": "2025-09-18T14:35:12.000000Z",
            "phonenumber": "262.679.2468",
            "phonenumber_verified_at": "2025-09-18T14:35:12.000000Z",
            "report_interval": "weekly",
            "manageable_companies": [
                {
                    "id": "7258487",
                    "uuid": "2cb168cd-5876-432e-9b03-1edccb3eaf88",
                    "name": "Willms Inc"
                }
            ],
            "role": {
                "name": "norole",
                "title": "No role assigned"
            },
            "terms_agreed_at": "2025-09-18T14:35:12.000000Z",
            "sso_provider": null,
            "created_at": "2025-09-18T14:35:12.000000Z",
            "updated_at": "2025-09-18T14:35:12.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Create User

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

Create a new user for the current company.

Headers

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

Body Parameters

Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/users" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"wtcdaihzaqw\",
    \"last_name\": \"gtnmhqxoe\",
    \"email\": \"howell.trinity@example.com\",
    \"phonenumber\": \"+31612345678\",
    \"report_interval\": \"quarterly\",
    \"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:
bc34b6b6-09d7-36da-a88e-eff645750565

Query Parameters

include
string

Include additional relationships (comma separated).

Must be one of:
  • company
  • company.type
  • company.partner
  • managingCompany
  • managingCompany.type
  • managingCompany.partner
Example:
managingCompany
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/users/bc34b6b6-09d7-36da-a88e-eff645750565?include=managingCompany" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "dc0bf0c1-353c-4f4b-aad0-b62f1f31d27b",
        "company_id": "5498148",
        "managing_company_id": "5498148",
        "first_name": "Mohammad",
        "last_name": "Shanahan",
        "two_factor_enabled": false,
        "email": "xjohnston@ankunding.com",
        "email_verified_at": "2025-09-18T14:35:12.000000Z",
        "phonenumber": "361-400-3068",
        "phonenumber_verified_at": "2025-09-18T14:35:12.000000Z",
        "report_interval": "weekly",
        "manageable_companies": [
            {
                "id": "5498148",
                "uuid": "b2025cba-1109-48fc-b9e7-07bf283967c9",
                "name": "Gislason-Franecki"
            }
        ],
        "role": {
            "name": "norole",
            "title": "No role assigned"
        },
        "terms_agreed_at": "2025-09-18T14:35:12.000000Z",
        "sso_provider": null,
        "created_at": "2025-09-18T14:35:12.000000Z",
        "updated_at": "2025-09-18T14:35:12.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:
ca25d688-cdb6-3af0-98e5-977182655fee

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/users/ca25d688-cdb6-3af0-98e5-977182655fee" \
    --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:
269588de-072f-310d-a229-0c9b6424ab07
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/users/269588de-072f-310d-a229-0c9b6424ab07" \
    --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:
Unresolved
filter[threat]
Filter vulnerabilities by their threat level
Must be one of:
  • Log
  • Low
  • Medium
  • High
  • Critical
Example:
Medium
filter[scan_id]
Filter vulnerabilities found by given scan_id
Example:
123
filter[family]
Filter vulnerabilities by their family
Example:
SQL Injection
sort
The column(s) to sort by. Prefix with - for descending order. Eg sort=-name
Must be one of:
  • name
  • port
  • cvss_base_score
  • epss_score
  • qod_type
  • last_seen
Example:
cvss_base_score

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities?filter%5Bname%5D=SQL&filter%5Bhost%5D=192.168.1.1&filter%5Bhostname%5D=laptop-1.local&filter%5Bstatus%5D=Unresolved&filter%5Bthreat%5D=Medium&filter%5Bscan_id%5D=123&filter%5Bfamily%5D=SQL+Injection&sort=cvss_base_score" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"name\": \"bmshnnfyvwbpukcrmx\",
        \"threat_level\": \"Medium\",
        \"host\": \"nyuvwhwmndai\",
        \"hostname\": \"apcrgmzlncfthdpsfsj\",
        \"status\": \"Unresolved\",
        \"scan_id\": \"a5130d2f-857b-3ee2-aa3d-a6ccd1db3990\"
    },
    \"per_page\": 1
}"
Example response:
{
    "data": [
        {
            "id": "9fe86d12-9f27-46b1-993f-c6d2cb3d2ce7",
            "asset_id": "9fe86d12-9802-41b3-910f-b1af39ee6c9c",
            "company_id": "540672",
            "vulnerability_definition_id": "9fe86d12-9e5b-4a19-8631-edfcdcbb15ed",
            "vulnerability_definition": {
                "id": "9fe86d12-9e5b-4a19-8631-edfcdcbb15ed",
                "name": "6 exploitable through vel manipulation",
                "description": "Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.",
                "solution": "Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.",
                "category": "6",
                "threat_level": "Critical",
                "definition_type": "openvas",
                "definition": {
                    "id": "9fe86d12-9c15-476c-becf-132c50e5ce67",
                    "o_id": "f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c",
                    "name": "6 exploitable through vel manipulation",
                    "family": "6",
                    "reference_urls": "http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam",
                    "reference_cves": "CVE-2018-1063, CVE-2021-6721",
                    "solution_type": "Mitigation",
                    "solution_description": "Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.",
                    "summary": "Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.",
                    "insight": "Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.",
                    "affected": "Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.",
                    "impact": "Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.",
                    "vuldetect": "Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.",
                    "priority": "Log",
                    "qod_type": "remote_active",
                    "qod_value": 75
                },
                "cvss_base_score": 3.1,
                "cvss_base_vector": "AV:L/AC:H/Au:N/C:C/I:P/A:P",
                "epss": null,
                "created_at": "2025-09-18T14:35:11.000000Z",
                "updated_at": "2025-09-18T14:35:11.000000Z"
            },
            "host": "230.237.173.10",
            "hostname": "turner.com",
            "port": "2396/tcp",
            "details": "Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.",
            "status": "Accepted",
            "first_seen": "2025-08-02T15:21:55.000000Z",
            "last_seen": "2025-09-13T09:12:25.000000Z",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z",
            "name": "6 exploitable through vel manipulation",
            "description": "Dolorem porro iure et earum. Cumque voluptas aliquid reprehenderit perspiciatis voluptatibus sapiente. Ipsum aut atque perspiciatis in explicabo minima.",
            "cvss_base_score": 3.1,
            "cvss_base_vector": "AV:L/AC:H/Au:N/C:C/I:P/A:P",
            "qod_type": "remote_active",
            "qod_value": 75,
            "threat": "Critical",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "9fe86d12-9c15-476c-becf-132c50e5ce67",
                "o_id": "f2d1a6ca-12a6-3ed2-94dd-cd259713fa0c",
                "name": "6 exploitable through vel manipulation",
                "family": "6",
                "reference_urls": "http://www.flatley.com/aperiam-aspernatur-sunt-officiis-sed-accusamus-praesentium-quam.html, https://www.beier.com/et-sint-et-sint-tempora-et-totam-numquam",
                "reference_cves": "CVE-2018-1063, CVE-2021-6721",
                "solution_type": "Mitigation",
                "solution_description": "Vel labore corporis tempore soluta aut consequatur occaecati. Sint dolorem eos nesciunt quod laboriosam odit placeat. Voluptas doloribus nesciunt possimus.",
                "summary": "Alias laudantium nulla voluptate illum. Qui dolore optio officiis commodi. Similique nam enim similique qui id non.",
                "insight": "Maxime omnis qui quo rem vel est nisi. Eum aut et dolorem rerum laudantium doloremque. In natus magnam voluptatem ex saepe id nihil sunt.",
                "affected": "Non earum sint qui adipisci et quis dolorum. Sit eius molestiae sed consectetur reprehenderit quia. Ipsa voluptate reiciendis aut. Eum libero quasi natus.",
                "impact": "Quis qui quidem perspiciatis nihil expedita quis quia. Velit sequi et est sint beatae laborum. Nulla corrupti aut cumque eveniet et molestiae rem rerum. Corporis velit qui magnam minima.",
                "vuldetect": "Non eos ipsam vel delectus. Ut tempore non occaecati expedita cumque a itaque. Omnis sunt aut impedit nisi velit. Et molestias dolorum quod. Et vel quidem culpa voluptas saepe. Aliquam animi pariatur porro dolor. Eos modi vero ipsa in.",
                "priority": "Log",
                "qod_type": "remote_active",
                "qod_value": 75
            }
        },
        {
            "id": "9fe86d12-a793-49fc-ac10-ec1475e42927",
            "asset_id": "9fe86d12-a321-47d4-a34c-88f245e93125",
            "company_id": "9101626",
            "vulnerability_definition_id": "9fe86d12-a711-4393-a18a-10a373b96b5a",
            "vulnerability_definition": {
                "id": "9fe86d12-a711-4393-a18a-10a373b96b5a",
                "name": "10 due to improper optio handling",
                "description": "Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.",
                "solution": "Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.",
                "category": "10",
                "threat_level": "Low",
                "definition_type": "openvas",
                "definition": {
                    "id": "9fe86d12-a5e1-472f-adea-86a60f2c9d4c",
                    "o_id": "a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e",
                    "name": "10 due to improper optio handling",
                    "family": "10",
                    "reference_urls": "http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis",
                    "reference_cves": "CVE-2022-7508, CVE-2018-1313",
                    "solution_type": "WorkAround",
                    "solution_description": "Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.",
                    "summary": "Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.",
                    "insight": "Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.",
                    "affected": "Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.",
                    "impact": "Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.",
                    "vuldetect": "Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.",
                    "priority": "High",
                    "qod_type": "package",
                    "qod_value": 60
                },
                "cvss_base_score": 2.5,
                "cvss_base_vector": "AV:N/AC:H/Au:S/C:P/I:C/A:P",
                "epss": null,
                "created_at": "2025-09-18T14:35:11.000000Z",
                "updated_at": "2025-09-18T14:35:11.000000Z"
            },
            "host": "233.149.132.167",
            "hostname": "dare.com",
            "port": "1433/tcp",
            "details": "Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.",
            "status": "Detected",
            "first_seen": "2025-07-10T00:59:16.000000Z",
            "last_seen": "2025-08-20T12:11:17.000000Z",
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z",
            "name": "10 due to improper optio handling",
            "description": "Est consequuntur rerum corrupti modi omnis quas. Dolores sed sunt neque et. Doloremque officiis aut modi consectetur odio. Debitis nihil quo sed blanditiis facilis.",
            "cvss_base_score": 2.5,
            "cvss_base_vector": "AV:N/AC:H/Au:S/C:P/I:C/A:P",
            "qod_type": "package",
            "qod_value": 60,
            "threat": "Low",
            "scanner_id": null,
            "scanner_hostname": null,
            "plugin": {
                "id": "9fe86d12-a5e1-472f-adea-86a60f2c9d4c",
                "o_id": "a9d72f72-c4ad-3ae3-b379-8b345a4e8d1e",
                "name": "10 due to improper optio handling",
                "family": "10",
                "reference_urls": "http://www.farrell.info/, http://www.bednar.com/eveniet-voluptatum-nihil-quia-velit-nemo-maiores-aut-veritatis",
                "reference_cves": "CVE-2022-7508, CVE-2018-1313",
                "solution_type": "WorkAround",
                "solution_description": "Aperiam nobis qui aut aspernatur repudiandae quasi. Quo maiores labore perspiciatis ut explicabo. Eligendi est nemo velit et eveniet.",
                "summary": "Repudiandae ex velit quidem sit atque libero. Pariatur beatae voluptates id tenetur reprehenderit. Voluptatem quia voluptas sed distinctio possimus unde illum et.",
                "insight": "Sit officiis nobis voluptatem officiis. Aut magni corporis eaque. Alias ipsam enim dolores maxime placeat animi quos.",
                "affected": "Sunt illum adipisci perferendis fugit tempora reprehenderit accusantium. Et laboriosam nobis unde nam velit ad quam temporibus. Explicabo magni commodi harum. Enim quisquam beatae nihil et voluptates.",
                "impact": "Est odio blanditiis voluptates incidunt ut sit ipsum. Aut tempora rerum sit quisquam quidem. Nisi aperiam beatae ullam tempore ab sit. Molestiae totam quia ea eaque sit.",
                "vuldetect": "Labore quia alias porro maxime eos. Commodi autem eos expedita fugiat nemo quod. Deleniti quia et est fugit. Molestias molestiae aut laboriosam dolorum dolor iure laborum. Modi harum vero consectetur excepturi harum modi aut.",
                "priority": "High",
                "qod_type": "package",
                "qod_value": 60
            }
        }
    ],
    "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:
sunt
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/vulnerabilities/sunt" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-b589-46df-8604-335d4783e6f4",
        "asset_id": "9fe86d12-b137-4a5a-85cb-a3099f4cb962",
        "company_id": "7512227",
        "vulnerability_definition_id": "9fe86d12-b510-4934-85ba-efaeede2840d",
        "vulnerability_definition": {
            "id": "9fe86d12-b510-4934-85ba-efaeede2840d",
            "name": "Clear-text Transmission affecting veniam functionality",
            "description": "Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.",
            "solution": "Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.",
            "category": "Clear-text Transmission",
            "threat_level": "High",
            "definition_type": "openvas",
            "definition": {
                "id": "9fe86d12-b3e1-4433-b120-6d5c34a0a724",
                "o_id": "ea947967-302b-346e-8f47-2eeffb9a3d5e",
                "name": "Clear-text Transmission affecting veniam functionality",
                "family": "Clear-text Transmission",
                "reference_urls": "http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/",
                "reference_cves": "CVE-2016-4777, CVE-2022-6060",
                "solution_type": "WorkAround",
                "solution_description": "Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.",
                "summary": "Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.",
                "insight": "Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.",
                "affected": "Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.",
                "impact": "Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.",
                "vuldetect": "Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.",
                "priority": "Low",
                "qod_type": "exploit",
                "qod_value": 27
            },
            "cvss_base_score": 3.5,
            "cvss_base_vector": "AV:N/AC:L/Au:N/C:N/I:C/A:P",
            "epss": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        "host": "102.254.13.186",
        "hostname": "veum.com",
        "port": "80/tcp",
        "details": "Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.",
        "status": "Resolved",
        "first_seen": "2025-01-05T22:19:37.000000Z",
        "last_seen": "2025-08-20T00:02:33.000000Z",
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.000000Z",
        "name": "Clear-text Transmission affecting veniam functionality",
        "description": "Sapiente ducimus aliquid exercitationem. Et aut doloribus debitis quia. Dolor quaerat libero aliquam. Soluta odit praesentium sed vitae eos. Atque qui reprehenderit eaque saepe et voluptates.",
        "cvss_base_score": 3.5,
        "cvss_base_vector": "AV:N/AC:L/Au:N/C:N/I:C/A:P",
        "qod_type": "exploit",
        "qod_value": 27,
        "threat": "High",
        "scanner_id": null,
        "scanner_hostname": null,
        "plugin": {
            "id": "9fe86d12-b3e1-4433-b120-6d5c34a0a724",
            "o_id": "ea947967-302b-346e-8f47-2eeffb9a3d5e",
            "name": "Clear-text Transmission affecting veniam functionality",
            "family": "Clear-text Transmission",
            "reference_urls": "http://weber.com/quo-architecto-ea-quis-culpa, http://thompson.info/",
            "reference_cves": "CVE-2016-4777, CVE-2022-6060",
            "solution_type": "WorkAround",
            "solution_description": "Excepturi minima voluptate quia neque. Sit quia voluptas laudantium reiciendis. Dolorum delectus commodi dolorum vel vero. Sapiente magni animi necessitatibus nisi aut.",
            "summary": "Repellat voluptatem molestiae tenetur dolore in repellat quia animi. Expedita ea aut officiis explicabo corrupti aut. Accusantium et sit dolorum dicta.",
            "insight": "Est quae dolores odio. Veritatis consequatur voluptatem minima non qui. Sit voluptas mollitia possimus consequatur placeat iure magni voluptas.",
            "affected": "Vero exercitationem sunt consequuntur eveniet incidunt nostrum. Velit et consequatur commodi in necessitatibus aut architecto. Repellendus aut sint harum rem. Rerum natus mollitia sint est accusamus alias. Adipisci autem velit delectus.",
            "impact": "Et velit deleniti dolorem rerum illum ipsum rerum. Dolore ex error occaecati ut eum iusto ullam. Voluptatibus quo id adipisci quas.",
            "vuldetect": "Ipsam est magnam qui in sit atque. Rem cumque molestiae laudantium reiciendis mollitia quaerat. Quas praesentium quas inventore in repellendus nisi quas aut. Et dolor et id ut ea. Itaque expedita voluptas ea illo sunt quas dignissimos.",
            "priority": "Low",
            "qod_type": "exploit",
            "qod_value": 27
        }
    }
}

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:
event
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events?sort=event&filter=event" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": "9fe86d12-7649-42ee-a782-3e20e467aed9",
            "webhook_id": "9fe86d12-756d-4e4f-8a9f-440d5da786ed",
            "event": "occaecati",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        {
            "id": "9fe86d12-79f3-47ba-83e0-0db66f7baf58",
            "webhook_id": "9fe86d12-7934-4bdc-a32b-162b721084f5",
            "event": "aut",
            "payload": {
                "key": "value"
            },
            "status": "pending",
            "retries": 0,
            "next_retry_at": null,
            "last_sent_at": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.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-edoL8PFSfDOTO3PmUDmaZQmB0vHU212JRA4ZpLHz' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-elem 'self' 'nonce-edoL8PFSfDOTO3PmUDmaZQmB0vHU212JRA4ZpLHz' https://js.chargebee.com https://*.intercom.io https://*.intercomcdn.com https://static.cloudflareinsights.com; script-src-attr 'none'; style-src 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; style-src-elem 'self' 'unsafe-inline' https://fonts.bunny.net https://*.intercomcdn.com; img-src 'self' data: blob: https://*.intercomcdn.com https://www.gravatar.com; font-src 'self' https://fonts.bunny.net https://*.intercomcdn.com; connect-src 'self' https://um.securityhive.io https://*.intercom.io wss://*.intercom.io wss://localhost; frame-src 'self' https://um.securityhive.io https://js.chargebee.com https://securityhive.chargebee.com https://intercom-sheets.com; frame-ancestors 'none'; form-action 'self'; base-uri 'self'; object-src 'none'; worker-src 'self'; manifest-src 'self'; media-src 'self' data:; 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; 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:
9fe86d12-7649-42ee-a782-3e20e467aed9
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhook-events/9fe86d12-7649-42ee-a782-3e20e467aed9" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-8566-4f81-aba4-8730fe586497",
        "webhook_id": "9fe86d12-84ad-46ba-99fb-26b3958d19ce",
        "event": "omnis",
        "payload": {
            "key": "value"
        },
        "status": "pending",
        "retries": 0,
        "next_retry_at": null,
        "last_sent_at": null,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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": "9fe86d12-5782-4ea7-ac8b-7324884f002b",
            "company_id": "bee1358d-7f15-480b-90ac-a2e22fdbf5d8",
            "url": "https://ondricka.biz",
            "description": null,
            "events": [],
            "secret": "4ef3673691fdc33cb4f0b9615a0e92cb63486751eab78eed3b6a6e1b9840e40b",
            "last_sent_at": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.000000Z"
        },
        {
            "id": "9fe86d12-5cfb-414b-8f3f-d6f1432736bc",
            "company_id": "716405dc-e1ff-43a9-a7b2-4d1bc95a5125",
            "url": "https://klocko.com",
            "description": null,
            "events": [],
            "secret": "2a757e533a6c3c68b3997912dd1a7bca3caa15a80c9574e2dcf319d14112a3bd",
            "last_sent_at": null,
            "created_at": "2025-09-18T14:35:11.000000Z",
            "updated_at": "2025-09-18T14:35:11.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:\\/\\/kris.biz\\/harum-voluptas-natus-qui-voluptatum-laboriosam\",
    \"description\": \"Earum enim omnis beatae consectetur facere omnis fuga.\"
}"
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:
9fe86d12-5782-4ea7-ac8b-7324884f002b
Example request: 
curl --request GET \
    --get "https://api.securityhive.io/v1/webhooks/9fe86d12-5782-4ea7-ac8b-7324884f002b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-666d-49ea-bc0c-3ede77d4133e",
        "company_id": "e0a47e25-55d0-42fb-be83-bb792f853b4f",
        "url": "https://kunze.com",
        "description": null,
        "events": [],
        "secret": "db51db8dfc56ca7fec4f37147dbb768fddf5e47041e3e80ba3f3ac7ce71eb004",
        "last_sent_at": null,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
9fe86d12-5782-4ea7-ac8b-7324884f002b
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/9fe86d12-5782-4ea7-ac8b-7324884f002b/rotate-secret" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": "9fe86d12-6acb-4715-ae43-91e2067d8d2a",
        "company_id": "7639e2cb-1e6c-4204-bd22-1b01bc77a155",
        "url": "https://marks.com",
        "description": null,
        "events": [],
        "secret": "f520db49ef42f942fc8e7ec1d448f95abf7bd2e27471b607979df526067064da",
        "last_sent_at": null,
        "created_at": "2025-09-18T14:35:11.000000Z",
        "updated_at": "2025-09-18T14:35:11.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:
9fe86d12-5782-4ea7-ac8b-7324884f002b
Example request: 
curl --request POST \
    "https://api.securityhive.io/v1/webhooks/9fe86d12-5782-4ea7-ac8b-7324884f002b/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:
9fe86d12-5782-4ea7-ac8b-7324884f002b

Body Parameters

Example request: 
curl --request PATCH \
    "https://api.securityhive.io/v1/webhooks/9fe86d12-5782-4ea7-ac8b-7324884f002b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/collins.com\\/non-voluptatem-similique-eaque-eaque-eius-necessitatibus\",
    \"description\": \"Veniam placeat et aut.\"
}"
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:
9fe86d12-5782-4ea7-ac8b-7324884f002b
Example request: 
curl --request DELETE \
    "https://api.securityhive.io/v1/webhooks/9fe86d12-5782-4ea7-ac8b-7324884f002b" \
    --header "Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[Empty response]
{
    "message": "webhook not found"
}