Scanner Jobs

Configure ongoing website monitoring jobs and inspect their latest run history.

List scanner jobs

get

Return the scanner jobs owned by the authenticated tenant, including their most recent run when available.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

Filter by a specific scanner job identifier.

brandIdstring · uuidOptional

Filter jobs assigned to a specific brand.

searchstringOptional

Case-insensitive search against scanner job names.

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Possible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Possible values:

Responses

200

Scanner jobs returned

application/json

Paginated collection of scanner jobs.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/scanner-jobs

GET /api/v1/scanner-jobs HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "scannerJobs": [
    {
      "id": "55555555-5555-5555-5555-555555555555",
      "name": "Acme Site Monitor",
      "urls": [
        "https://example.com"
      ],
      "scheduler": "0 0 * * *",
      "brand": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Acme"
      },
      "documentEvaluationType": {
        "id": "22222222-2222-2222-2222-222222222222",
        "name": "Marketing Review"
      },
      "lastRun": {
        "id": "66666666-6666-6666-6666-666666666666",
        "status": "FINISHED",
        "scheduledTime": "2026-05-15T00:00:00.000Z",
        "createdAt": "2026-05-15T00:00:00.000Z"
      }
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

Create a content scanner job

post

Create a new website monitoring job that crawls the provided URLs and evaluates discovered content using the selected document evaluation type. The crawl engine is selected automatically based on the evaluation type's useCase.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Body

Request body used to create a new scanner job.

namestringRequired

documentEvaluationTypeIdstring · uuidRequired

urlsstring · uri[]Required

schedulerstringOptional

maxPagesintegerOptional

maxDepthintegerOptional

maxTrackedPagesinteger · min: 1Optional

newPagesForSuccessiveScansintegerOptional

brandIdstring · uuid · nullableOptional

showAllFeedbackInDecisionStorebooleanOptional

translationEnabledbooleanOptional

useSitemapsbooleanOptional

archiveModestring · enum · nullableOptionalPossible values:

Responses

201

Scanner job created

application/json

Wrapper returned after a scanner job is created successfully.

400

Invalid request body

application/json

401

Missing or invalid API key

application/json

404

Related evaluation type or brand not found

application/json

429

Rate limit exceeded

application/json

post/api/v1/scanner-jobs

POST /api/v1/scanner-jobs HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 382

{
  "name": "Acme Site Monitor",
  "documentEvaluationTypeId": "22222222-2222-2222-2222-222222222222",
  "urls": [
    "https://example.com"
  ],
  "scheduler": "0 0 * * *",
  "brandId": "11111111-1111-1111-1111-111111111111",
  "maxPages": 10,
  "maxDepth": 2,
  "maxTrackedPages": 100,
  "newPagesForSuccessiveScans": 0,
  "showAllFeedbackInDecisionStore": false,
  "translationEnabled": false,
  "useSitemaps": true,
  "archiveMode": null
}

{
  "scannerJob": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "urls": [
      "https://example.com"
    ],
    "scheduler": "text",
    "brand": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "documentEvaluationType": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "lastRun": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "CREATED",
      "scheduledTime": "2026-07-20T21:53:20.387Z",
      "createdAt": "2026-07-20T21:53:20.387Z"
    }
  }
}

Get a scanner job

get

Retrieve the full configuration and latest run summary for a single scanner job.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

scannerJobIdstring · uuidRequired

Responses

200

Scanner job returned

application/json

Wrapper containing a single scanner job record.

400

Missing or invalid scanner job id

application/json

401

Missing or invalid API key

application/json

404

Scanner job not found

application/json

429

Rate limit exceeded

application/json

get/api/v1/scanner-jobs/{scannerJobId}

GET /api/v1/scanner-jobs/{scannerJobId} HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "scannerJob": {
    "id": "55555555-5555-5555-5555-555555555555",
    "name": "Acme Site Monitor",
    "urls": [
      "https://example.com"
    ],
    "scheduler": "0 0 * * *",
    "brand": {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Acme"
    },
    "documentEvaluationType": {
      "id": "22222222-2222-2222-2222-222222222222",
      "name": "Marketing Review"
    },
    "maxPages": 10,
    "maxDepth": 2,
    "maxTrackedPages": 100,
    "newPagesForSuccessiveScans": 0,
    "showAllFeedbackInDecisionStore": false,
    "translationEnabled": false,
    "useSitemaps": true,
    "archiveMode": null,
    "lastRun": {
      "id": "66666666-6666-6666-6666-666666666666",
      "status": "FINISHED",
      "scheduledTime": "2026-05-15T00:00:00.000Z",
      "createdAt": "2026-05-15T00:00:00.000Z"
    }
  }
}

Delete a scanner job

delete

Permanently delete a scanner job so it no longer runs or appears in list results.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

scannerJobIdstring · uuidRequired

Responses

204

Scanner job deleted

No content

400

Missing or invalid scanner job id

application/json

401

Missing or invalid API key

application/json

404

Scanner job not found

application/json

429

Rate limit exceeded

application/json

delete/api/v1/scanner-jobs/{scannerJobId}

DELETE /api/v1/scanner-jobs/{scannerJobId} HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a scanner job

patch

Partially update an existing scanner job. Only the fields supplied in the request body are modified.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

scannerJobIdstring · uuidRequired

Body

Partial update payload for a scanner job. Include only the fields you want to change.

namestringOptional

urlsstring · uri[] · min: 1Optional

schedulerstring · nullableOptional

documentEvaluationTypeIdstring · uuidOptional

brandIdstring · uuid · nullableOptional

maxPagesintegerOptional

maxDepthintegerOptional

maxTrackedPagesinteger · min: 1Optional

newPagesForSuccessiveScansintegerOptional

showAllFeedbackInDecisionStorebooleanOptional

translationEnabledbooleanOptional

useSitemapsbooleanOptional

archiveModestring · enum · nullableOptionalPossible values:

Responses

200

Scanner job updated

application/json

Wrapper containing a single scanner job record.

400

Invalid scanner job id or request body

application/json

401

Missing or invalid API key

application/json

404

Scanner job or related brand/evaluation type not found

application/json

429

Rate limit exceeded

application/json

patch/api/v1/scanner-jobs/{scannerJobId}

PATCH /api/v1/scanner-jobs/{scannerJobId} HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "scheduler": null
}

{
  "scannerJob": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "urls": [
      "https://example.com"
    ],
    "scheduler": "text",
    "brand": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "documentEvaluationType": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "lastRun": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "CREATED",
      "scheduledTime": "2026-07-20T21:53:20.387Z",
      "createdAt": "2026-07-20T21:53:20.387Z"
    },
    "maxPages": 1,
    "maxDepth": 1,
    "maxTrackedPages": 1,
    "newPagesForSuccessiveScans": 1,
    "showAllFeedbackInDecisionStore": true,
    "translationEnabled": true,
    "useSitemaps": true,
    "archiveMode": "ON_FOR_ALL"
  }
}

List scanner job runs

get

Return historical executions for a scanner job, ordered by most recent first.

Authorizations

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

scannerJobIdstring · uuidRequired

Query parameters

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

Responses

200

Scanner job runs returned

application/json

Paginated collection of historical runs for a scanner job.

400

Missing or invalid scanner job id or query parameters

application/json

401

Missing or invalid API key

application/json

404

Scanner job not found

application/json

429

Rate limit exceeded

application/json

get/api/v1/scanner-jobs/{scannerJobId}/runs

GET /api/v1/scanner-jobs/{scannerJobId}/runs HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "scannerRuns": [
    {
      "id": "66666666-6666-6666-6666-666666666666",
      "status": "FINISHED",
      "scheduledTime": "2026-05-15T00:00:00.000Z",
      "createdAt": "2026-05-15T00:00:00.000Z",
      "updatedAt": "2026-05-15T00:05:00.000Z"
    },
    {
      "id": "77777777-7777-7777-7777-777777777777",
      "status": "FAILED",
      "scheduledTime": "2026-05-14T00:00:00.000Z",
      "createdAt": "2026-05-14T00:00:00.000Z",
      "updatedAt": "2026-05-14T00:03:00.000Z"
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 2,
    "total": 2
  }
}

PreviousDocument Reviews NextReports

Last updated 1 month ago

Was this helpful?