# Create a new site census

POST /v3/site-censuses

Endpoint: POST /v3/site-censuses
Security: API_Key

## Request fields (application/json):

  - `id` (integer)
    The unique identifier for the Site Census.

  - `accountId` (integer)
    The account ID associated with the Site Census.

  - `name` (string, required)
    The name of the Site Census.

  - `autoPauseAfter` (integer, required)
    The max time the scan will run, in minutes.

  - `ownerId` (integer)
    The userId of the user who created the Site Census.

  - `currentScanStartedAt` (string,null)
    The date and time when the current scan session started.

  - `lastScanStoppedAt` (string,null)
    The date and time when the last scan session stopped.

  - `notificationEmails` (array, required)
    Target email addresses for notification when this census auto-pauses or runs out of URLs.

  - `startingUrls` (array, required)
    The list of starting URLs for the Site Census.

  - `filterPatterns` (array, required)

  - `filterPatterns.pathPattern` (string, required)
    The GLOB pattern to match the path of the URL.

  - `filterPatterns.fqdn` (string, required)
    The fully qualified domain name (FQDN) to match against the URL.

  - `filterPatterns.type` (string, required)
    Indicates whether matches should be prioritized or ignored.
    Enum: "PRIORITY", "IGNORE"

## Response 200 fields (application/json):

  - `id` (integer, required)
    The unique identifier for the Site Census.

  - `accountId` (integer)
    The account ID associated with the Site Census.

  - `name` (string, required)
    The name of the Site Census.

  - `autoPauseAfter` (integer, required)
    The max time the scan will run, in minutes.

  - `ownerId` (integer)
    The userId of the user who created the Site Census.

  - `currentScanStartedAt` (string,null)
    The date and time when the current scan session started.

  - `lastScanStoppedAt` (string,null)
    The date and time when the last scan session stopped.

  - `notificationEmails` (array, required)
    Target email addresses for notification when this census auto-pauses or runs out of URLs.

  - `startingUrls` (array, required)
    The list of starting URLs for the Site Census.

  - `filterPatterns` (array, required)

  - `filterPatterns.pathPattern` (string, required)
    The GLOB pattern to match the path of the URL.

  - `filterPatterns.fqdn` (string, required)
    The fully qualified domain name (FQDN) to match against the URL.

  - `filterPatterns.type` (string, required)
    Indicates whether matches should be prioritized or ignored.
    Enum: "PRIORITY", "IGNORE"

## Response 400 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 403 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)