v1

latestOpenAPI 3.1.02026-07-24334970.2 KB

Priorities

Update an existing priority

Performs a partial update on the specified priority using JSON Merge Patch semantics (RFC 7396). Only fields provided in the payload are modified; omitted fields remain unchanged.

Immutable fields like id, testingToken, createdAt, and updatedAt are ignored if included. startAt and endAt can be updated independently. For nested objects like preAdmission, the entire object is replaced, not merged.

patch/priorities/{id}

Path parameters

idstring uuid required

Unique identifier of the priority.

Response

Successfully updated priority.

idstring uuid required

System-generated unique identifier for the priority.

namestring required

Descriptive name of the priority, used for identification in the dashboard and API. Not shown to end users.

maximumConcurrentVisitorsinteger required

Maximum number of concurrent visitors allowed on your website before new visitors are placed in the waiting room.

inactivityTimeoutMinutesinteger required

How long a visitor can be inactive before their session expires. Every interaction matching the waiting room scope will automatically reset this countdown. Must be between 10 and 30 minutes.

admissionRatePerMinuteinteger required

Maximum number of visitors allowed to leave the waiting room and access the website each minute. This smooths traffic bursts and prevents thundering herd effects when the queue opens.

priorityinteger

Determines order of evaluation when multiple priorities could apply. Lower values take precedence.

matchingConditionstring required

Boolean expression defining which traffic is sent to this priority. Uses DataDome Lucene syntax with AND, OR, NOT operators and field:value matching.

Examples:

domain:www.example.com AND url:/product/*
domain:*
(countrycode:US OR countrycode:CA) AND url:/sale
domain:shop.example.com AND NOT method:GET

startAtstring date-time nullable

UTC timestamp when the priority becomes active (inclusive). ISO 8601 format.

endAtstring date-time nullable

UTC timestamp when the priority expires and stops accepting visitors (exclusive). ISO 8601 format.

enforceClientSideValidationboolean

When true, visitors passing through the queue must successfully execute client-side validation logic in their browser before being granted access to the protected website.

allowAIAgentboolean

When true, known AI or automated agents are allowed to bypass the waiting room.

directAccessTrafficTypestring[] required

Traffic categories allowed to skip the waiting room entirely. Subset of verifiedBots, customRules. An empty array means no category bypasses.

POST: optional; [], ["verifiedBots"], ["customRules"] or ["verifiedBots","customRules"] are accepted. Omitted defaults to []. Explicit null or unknown values return 400.

PATCH: omit the field to leave the current set untouched. Provide [] to clear it or a subset to replace it. null returns 400.

isEnabledboolean required

When true, the priority is active and is triggered if configuration conditions are met. When false, the priority is never triggered.

testingTokenstring uuid

Token that allows testing this priority for debugging or privileged access. Automatically generated at creation time and cannot be modified.

Security note: This is a sensitive secret. Only returned when includeTestingToken=true is explicitly provided on GET requests.

createdAtstring date-time required

Timestamp when the priority was created (ISO 8601 UTC).

updatedAtstring date-time required

Timestamp when the priority configuration was last updated (ISO 8601 UTC).

Example response

{
  "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "name": "Black Friday Sale Queue",
  "maximumConcurrentVisitors": 10000,
  "inactivityTimeoutMinutes": 15,
  "admissionRatePerMinute": 500,
  "priority": 10,
  "matchingCondition": "domain:shop.example.com AND url:/sale/*",
  "preAdmission": {
    "durationMinutes": 30
  },
  "startAt": "2025-11-24T01:00:00Z",
  "endAt": "2025-11-30T01:00:00Z",
  "enforceClientSideValidation": true,
  "allowAIAgent": false,
  "directAccessTrafficType": [
    "verifiedBots"
  ],
  "isEnabled": true,
  "template": {
    "id": "c1d2e3f4-5678-9abc-def0-123456789abc",
    "name": "Black Friday Theme"
  },
  "createdAt": "2025-10-01T12:00:00Z",
  "updatedAt": "2025-10-01T12:00:00Z"
}