Skip to main content
PATCH
/
organizations
/
{organizationId}
/
projects
/
{projectId}
/
tracker-scan-schedule
Update tracker scan schedule
curl --request PATCH \
  --url https://api.concord.tech/privacy-v1/organizations/{organizationId}/projects/{projectId}/tracker-scan-schedule \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "scheduledScanEnabled": true,
  "scanPeriod": "quarterly",
  "scheduledHour": 11,
  "scheduledDayOfWeek": 3,
  "scheduledDayOfMonth": 16
}
'
{
  "scheduledScanEnabled": true,
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scanPeriod": "quarterly",
  "scheduledHour": 11,
  "scheduledDayOfWeek": 3,
  "scheduledDayOfMonth": 16,
  "scanHistory": [
    {
      "date": 123,
      "status": "running",
      "scanType": "scheduled",
      "taskArn": "<string>",
      "domainsCount": 123,
      "results": {
        "total": 123,
        "new": 123,
        "project": 123,
        "global": 123,
        "categories": {
          "analytics": 123,
          "do_not_sell": 123,
          "functional": 123,
          "global_privacy_control": 123,
          "ignored": 123,
          "limit_pii_use": 123,
          "marketing": 123,
          "strictly_necessary": 123,
          "unclassified": 123
        }
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
string<uuid>
required
projectId
string<uuid>
required

Body

application/json
scheduledScanEnabled
boolean
scanPeriod
enum<string>
Available options:
quarterly,
daily,
weekly,
monthly
scheduledHour
integer
Required range: 0 <= x <= 23
scheduledDayOfWeek
integer
Required range: 0 <= x <= 6
scheduledDayOfMonth
integer
Required range: 1 <= x <= 31

Response

Default Response

scheduledScanEnabled
boolean
required
organizationId
string<uuid>
required
projectId
string<uuid>
required
scanPeriod
enum<string>
Available options:
quarterly,
monthly,
weekly,
daily
scheduledHour
integer
Required range: 0 <= x <= 23
scheduledDayOfWeek
integer
Required range: 0 <= x <= 6
scheduledDayOfMonth
integer
Required range: 1 <= x <= 31
scanHistory
object[]