Report

Returns all defined report configurations.

get/api/3/reports

Request

Query parameters

pageinteger

The index of the page (zero-based) to retrieve.

sizeinteger

The number of records per page to retrieve.

sortstring[]

The criteria to sort the records by, in the format: property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Response

OK

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "page": {
    "number": 6,
    "size": 10,
    "totalPages": 13,
    "totalResources": 123
  },
  "resources": [
    {
      "bureau": "Bureau",
      "component": "Component",
      "email": {
        "access": "zip",
        "additional": "file",
        "assetAccess": true,
        "owner": "file",
        "smtp": {
          "global": true,
          "relay": "mail.acme.com",
          "sender": "john_smith@acme.com"
        }
      },
      "enclave": "Enclave",
      "filters": {
        "categories": {
          "links": [
            {
              "href": "https://hostname:3780/api/3/...",
              "rel": "self"
            }
          ]
        }
      },
      "format": "pdf",
      "frequency": {
        "repeat": {
          "every": "date-of-month",
          "interval": 1
        },
        "start": "2018-03-01T04:31:56Z",
        "type": "schedule"
      },
      "id": 17,
      "language": "en-US",
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ],
      "name": "Monthly Corporate Site Summary",
      "organization": "Acme, Inc.",
      "owner": 1,
      "query": "SELECT * FROM dim_asset ORDER BY ip_address ASC",
      "range": {
        "every": "day",
        "interval": 7
      },
      "remediation": {
        "solutions": 25
      },
      "riskTrend": {
        "allAssets": {
          "total": true,
          "trend": "average-risk"
        },
        "assetGroupMembership": "historical",
        "assetGroups": "total",
        "assets": true,
        "sites": "total",
        "tagMembership": "historical",
        "tags": "total"
      },
      "storage": {
        "location": "monthly_reports/site/corporate",
        "path": "$(install_dir)/nsc/reports/$(user)/monthly_reports/site/corporate"
      },
      "template": "executive-overview",
      "timezone": "America/Los_Angeles",
      "users": [
        7
      ],
      "version": "2.3.0"
    }
  ]
}

Changes

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status