List WARP change events.

GET/accounts/{account_id}/dex/warp-change-events

List WARP configuration and enablement toggle change events by device.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloudflare DEX WriteCloudflare DEX ReadZero Trust ReportZero Trust Read

Path ParametersExpand Collapse

account_id: optional string

maxLength32

Query ParametersExpand Collapse

from: string

Start time for the query in ISO (RFC3339 - ISO 8601) format

page: number

Page number of paginated results

minimum1

per_page: number

Number of items per page

maximum50

minimum1

to: string

End time for the query in ISO (RFC3339 - ISO 8601) format

account_name: optional string

Filter events by account name.

config_name: optional string

Filter events by WARP configuration name changed from or to. Applicable to type=‘config’ events only.

sort_order: optional "ASC" or "DESC"

Sort response by event timestamp.

One of the following:

"ASC"

"DESC"

toggle: optional "on" or "off"

Filter events by type toggle value. Applicable to type=‘toggle’ events only.

One of the following:

"on"

"off"

type: optional "config" or "toggle"

Filter events by type ‘config’ or ‘toggle’

One of the following:

"config"

"toggle"

ReturnsExpand Collapse

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result: optional array of object { account_name, account_tag, device_id, 7 more } or object { device_id, device_registration, from, 6 more }

One of the following:

DigitalExperienceMonitoringWARPToggleChangeEvent object { account_name, account_tag, device_id, 7 more }

account_name: optional string

The account name.

account_tag: optional string

The public account identifier.

device_id: optional string

API Resource UUID tag.

maxLength36

device_registration: optional string

API Resource UUID tag.

maxLength36

hostname: optional string

The hostname of the machine the event is from

registration_id: optional string

API Resource UUID tag.

maxLength36

serial_number: optional string

The serial number of the machine the event is from

timestamp: optional string

Timestamp in ISO format

toggle: optional "on" or "off"

The state of the WARP toggle.

One of the following:

"on"

"off"

user_email: optional string

Email tied to the device

DigitalExperienceMonitoringWARPConfigChangeEvent object { device_id, device_registration, from, 6 more }

device_id: optional string

API Resource UUID tag.

maxLength36

device_registration: optional string

API Resource UUID tag.

maxLength36

from: optional object { account_name, account_tag, config_name }

account_name: optional string

The account name.

account_tag: optional string

API Resource UUID tag.

maxLength36

config_name: optional string

The name of the WARP configuration.

hostname: optional string

The hostname of the machine the event is from

registration_id: optional string

API Resource UUID tag.

maxLength36

serial_number: optional string

The serial number of the machine the event is from

timestamp: optional string

Timestamp in ISO format

to: optional object { account_name, account_tag, config_name }

account_name: optional string

The account name.

account_tag: optional string

API Resource UUID tag.

maxLength36

config_name: optional string

The name of the WARP configuration.

user_email: optional string

Email tied to the device

result_info: optional object { count, page, per_page, 2 more }

count: optional number

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

total_pages: optional number

The number of total pages in the entire result set.

List WARP change events.

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/dex/warp-change-events \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "account_name": "account_name",
      "account_tag": "account_tag",
      "device_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "device_registration": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "hostname": "hostname",
      "registration_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "serial_number": "serial_number",
      "timestamp": "2023-10-11T00:00:00Z",
      "toggle": "on",
      "user_email": "user_email"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "account_name": "account_name",
      "account_tag": "account_tag",
      "device_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "device_registration": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "hostname": "hostname",
      "registration_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "serial_number": "serial_number",
      "timestamp": "2023-10-11T00:00:00Z",
      "toggle": "on",
      "user_email": "user_email"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}