bulk

Deregister a list of hostnames

Deregister a list of hostnames. The provided hostnames must be fully qualified domain names or IPv4 addresses. Currently, a maximum of 1000 hostnames in a single request is supported.

This is an add-on endpoint not available to all accounts. Please contact support for information about bulk endpoints and how to upgrade your account.

Required API key permissions: Admin (select when creating API key in Account Settings)

delete/bulk/hostnames

Request

Base URL
https://cyber-risk.upguard.com/api/public
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/bulk/hostnames/delete.ts
A function with typed inputs. Its response is checked against the schema.

Request body

hostnamesstring[]

The hostnames to deregister. Currently, a maximum of 1000 hostnames in a single request is supported.

Example request

{
  "hostnames": [
    "8.8.8.8",
    "example.com"
  ]
}

Response

Returns the number of deregistered hostnames as well as the number of remaining slots.

deregisteredinteger

The number of deregistered hostnames.

remaininginteger

The number of remaining slots.

Example response

{
  "deregistered": 4,
  "remaining": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.