Create a new discovery campaign

Create a new discovery campaign in Horizon

Body required
application/json

Discovery campaign to register

name
string required

The name of the discovery campaign
authorizationLevels
object (DiscoveryCampaignAuthorizationLevels) required

The authorization levels of the discovery campaign
eventOnSuccess
boolean required

Whether to log a Horizon event in case of success
eventOnWarning
boolean required

Whether to log a Horizon event in case of warning
eventOnFailure
boolean required

Whether to log a Horizon event in case of failure
enabled
boolean required

Whether the discovery campaign is enabled, i.e. whether it can be fed
description
string | null

The description of the discovery campaign
hosts
array of string | null

The hosts to be scanned by the discovery campaign
ports
array of string | null

The ports to be scanned by the discovery campaign
gradingPolicies
array of string | null

The grading policies to apply to grade the discovered certificates on this campaign
Responses
  • 201 Discovery campaign successfully registered
    _id
    string (Internal ID) required

    Object internal ID
    name
    string required

    The name of the discovery campaign
    authorizationLevels
    object (DiscoveryCampaignAuthorizationLevels) required

    The authorization levels of the discovery campaign
    eventOnSuccess
    boolean required

    Whether to log a Horizon event in case of success
    eventOnWarning
    boolean required

    Whether to log a Horizon event in case of warning
    eventOnFailure
    boolean required

    Whether to log a Horizon event in case of failure
    enabled
    boolean required

    Whether the discovery campaign is enabled, i.e. whether it can be fed
    description
    string | null

    The description of the discovery campaign
    hosts
    array of string | null

    The hosts to be scanned by the discovery campaign
    ports
    array of string | null

    The ports to be scanned by the discovery campaign
    gradingPolicies
    array of string | null

    The grading policies to apply to grade the discovered certificates on this campaign
  • 400 Unable to register the discovery campaign
  • 401 Authentication error
  • 403 Forbidden action
  • 500 Unexpected internal server error