Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Site

Sites

Creates a new site with the specified configuration.

post/api/3/sites

Request body

descriptionstring

The site's description.

engineIdinteger

The identifier of a scan engine. Default scan engine is selected when not specified.

importance'very_low' | 'low' | 'normal' | 'high' | 'very_high'

The site importance. Defaults to "normal" if not specified.

namestring required

The site name. Name must be unique.

scanTemplateIdstring

The identifier of a scan template. Default scan template is selected when not specified.

Example request

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "scan": {
    "assets": {
      "excludedAssetGroups": {
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ]
      },
      "excludedTargets": {
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ]
      },
      "includedAssetGroups": {
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ]
      },
      "includedTargets": {
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ]
      }
    }
  }
}

Response

Created