bulk

Register a list of hostnames to be scanned for risks

Register a list of hostnames to be scanned for risks. 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 will always replace the labels of currently registered hostnames and if the request has empty labels they will all be removed.

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)

post/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/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

hostnamesstring[]

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

labelsstring[]

The labels to add to the registered hostnames. If they don't exist they will be created.

Example request

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

Response

Returns the number of newly registered hostnames as well as the number of remaining slots.

registeredinteger

The number of newly registered hostnames.

remaininginteger

The number of remaining slots.

Example response

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

Changes

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