List WARP change events.

client.ZeroTrust.DEX.WARPChangeEvents.Get(ctx, params) (*[]DexwarpChangeEventGetResponse, error)

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

ParametersExpand Collapse

params DEXWARPChangeEventGetParams

AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32

From param.Field[string]

Query param: Start time for the query in ISO (RFC3339 - ISO 8601) format.

Page param.Field[float64]

Query param: Page number of paginated results.

minimum1

PerPage param.Field[float64]

Query param: Number of results per page.

maximum50

minimum1

To param.Field[string]

Query param: End time for the query in ISO (RFC3339 - ISO 8601) format.

AccountName param.Field[string]Optional

Query param: Filter events by account name.

ConfigName param.Field[string]Optional

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

SortOrder param.Field[DexwarpChangeEventGetParamsSortOrder]Optional

Query param: Sort response by event timestamp.

const DexwarpChangeEventGetParamsSortOrderAsc DexwarpChangeEventGetParamsSortOrder = "ASC"

const DexwarpChangeEventGetParamsSortOrderDesc DexwarpChangeEventGetParamsSortOrder = "DESC"

Toggle param.Field[DexwarpChangeEventGetParamsToggle]Optional

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

const DexwarpChangeEventGetParamsToggleOn DexwarpChangeEventGetParamsToggle = "on"

const DexwarpChangeEventGetParamsToggleOff DexwarpChangeEventGetParamsToggle = "off"

Type param.Field[DexwarpChangeEventGetParamsType]Optional

Query param: Filter events by type ‘config’ or ‘toggle’.

const DexwarpChangeEventGetParamsTypeConfig DexwarpChangeEventGetParamsType = "config"

const DexwarpChangeEventGetParamsTypeToggle DexwarpChangeEventGetParamsType = "toggle"

ReturnsExpand Collapse

type DexwarpChangeEventGetResponseEnvelopeResult []DexwarpChangeEventGetResponse

One of the following:

type DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEvent struct{…}

AccountName stringOptional

The account name.

AccountTag stringOptional

The public account identifier.

DeviceID stringOptional

The device ID.

maxLength36

DeprecatedDeviceRegistration stringOptional

Use registration_id instead.

Deprecated: use registration_id. The device registration ID.

maxLength36

Hostname stringOptional

The hostname of the machine the event is from.

RegistrationID stringOptional

The device registration ID.

maxLength36

SerialNumber stringOptional

The serial number of the machine the event is from.

Timestamp TimeOptional

The event time.

formatdate-time

Toggle DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEventToggleOptional

The state of the WARP toggle.

One of the following:

const DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEventToggleOn DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEventToggle = "on"

const DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEventToggleOff DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPToggleChangeEventToggle = "off"

UserEmail stringOptional

Email tied to the device.

type DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPConfigChangeEvent struct{…}

DeviceID stringOptional

The device ID.

maxLength36

DeprecatedDeviceRegistration stringOptional

Use registration_id instead.

Deprecated: use registration_id. The device registration ID.

maxLength36

From DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPConfigChangeEventFromOptional

The details for the WARP configuration that was switched from.

AccountName stringOptional

The account name.

AccountTag stringOptional

The public account identifier.

maxLength36

ConfigName stringOptional

The name of the WARP configuration.

Hostname stringOptional

The hostname of the machine the event is from.

RegistrationID stringOptional

The device registration ID.

maxLength36

SerialNumber stringOptional

The serial number of the machine the event is from.

Timestamp TimeOptional

The event time.

formatdate-time

To DexwarpChangeEventGetResponseDigitalExperienceMonitoringWARPConfigChangeEventToOptional

The details for the WARP configuration that was switched to.

AccountName stringOptional

The account name.

AccountTag stringOptional

The public account identifier.

maxLength36

ConfigName stringOptional

The name of the WARP configuration.

UserEmail stringOptional

Email tied to the device.

List WARP change events.

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  warpChangeEvents, err := client.ZeroTrust.DEX.WARPChangeEvents.Get(context.TODO(), zero_trust.DEXWARPChangeEventGetParams{
    AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
    From: cloudflare.F("2023-09-20T17:00:00Z"),
    Page: cloudflare.F(1.000000),
    PerPage: cloudflare.F(10.000000),
    To: cloudflare.F("2023-09-20T17:00:00Z"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", warpChangeEvents)
}

{
  "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
  }
}