Update an existing site census

v3 API/

Update an existing site census

Request

PUT /v3/site-censuses/{censusId}

Security

API_Key

Path

censusIdinteger, (int64)required

Unique identification number for a site census

Bodyapplication/jsonrequired

Update an existing site census by ID

idinteger, (int64)required

The unique identifier for the Site Census.

accountIdinteger, (int64)

The account ID associated with the Site Census.

namestringrequired

The name of the Site Census.

autoPauseAfterinteger, [ 1 .. 10080 ]required

The max time the scan will run, in minutes.

ownerIdinteger, (int64)

The userId of the user who created the Site Census.

currentScanStartedAtstring or null, (date-time)

The date and time when the current scan session started.

lastScanStoppedAtstring or null, (date-time)

The date and time when the last scan session stopped.

notificationEmailsArray of strings, (email), >= 0 itemsrequired

Target email addresses for notification when this census auto-pauses or runs out of URLs.

userAgentIdinteger

The user agent ID used for data collection.

Default:122

customHttpHeadersArray of objects, >= 0 items

List of custom HTTP header groups assigned to this site census.

Default:[]

startingUrlsArray of strings, (uri), >= 0 itemsrequired

The list of starting URLs for the Site Census.

filterPatternsArray of objects, >= 0 itemsrequired

PUT

/v3/site-censuses/{censusId}

curl -i -X PUT \
  'https://api.observepoint.com/v3/site-censuses/{censusId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "accountId": 0,
    "name": "string",
    "autoPauseAfter": 1,
    "ownerId": 0,
    "currentScanStartedAt": "2019-08-24T14:15:22Z",
    "lastScanStoppedAt": "2019-08-24T14:15:22Z",
    "notificationEmails": [
      "user@example.com"
    ],
    "userAgentId": 122,
    "customHttpHeaders": [],
    "startingUrls": [
      "http://example.com"
    ],
    "filterPatterns": [
      {
        "pathPattern": "string",
        "fqdn": "string",
        "type": "PRIORITY"
      }
    ]
  }'

Responses

Successful operation, resource updated

Bodyapplication/json