Cloudflare API | Zero Trust

Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.

client.zeroTrust.access.applications.policies.update(, , , ):

PolicyUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/policies/{policy_id}

Updates an Access policy specific to an application. To update a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint.

client.zeroTrust.access.applications.policies.delete(, , , ):

PolicyDeleteResponse

delete/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/policies/{policy_id}

Deletes an Access policy specific to an application. To delete a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint.

Domain types

AccessDevicePostureRule{…}

Enforces a device posture rule has run successfully

AccessRule =

GroupRule

AnyValidServiceTokenRule

AccessAuthContextRule

| 21 more...

Matches an Access group.

AnyValidServiceTokenRule{…}

Matches any valid Access Service Token

AuthenticationMethodRule{…}

Enforce different MFA options

AzureGroupRule{…}

Matches an Azure group. Requires an Azure identity provider.

CertificateRule{…}

Matches any valid client certificate.

CountryRule{…}

Matches a specific country

DomainRule{…}

Match an entire email domain.

EmailListRule{…}

Matches an email address from a list.

EmailRule{…}

Matches a specific email.

EveryoneRule{…}

Matches everyone.

ExternalEvaluationRule{…}

Create Allow or Block policies which evaluate the user based on custom criteria.

GitHubOrganizationRule{…}

Matches a Github organization. Requires a Github identity provider.

GroupRule{…}

Matches an Access group.

GSuiteGroupRule{…}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

IPListRule{…}

Matches an IP address from a list.

IPRule{…}

Matches an IP address block.

OktaGroupRule{…}

Matches an Okta group. Requires an Okta identity provider.

SAMLGroupRule{…}

Matches a SAML group. Requires a SAML identity provider.

ServiceTokenRule{…}

Matches a specific Access Service Token

Zero Trust Access Applications

Policy Tests

ZeroTrust.Access.Applications.PolicyTests

Methods

client.zeroTrust.access.applications.policyTests.get(, , ):

PolicyTestGetResponse

get/accounts/{account_id}/access/policy-tests/{policy_test_id}

Fetches the current status of a given Access policy test.

client.zeroTrust.access.applications.policyTests.create(, ):

PolicyTestCreateResponse

post/accounts/{account_id}/access/policy-tests

Starts an Access policy test.

Zero Trust Access Applications Policy Tests

Users

ZeroTrust.Access.Applications.PolicyTests.Users

Methods

client.zeroTrust.access.applications.policyTests.users.list(, , ):

V4PagePaginationArray

UserListResponse

get/accounts/{account_id}/access/policy-tests/{policy_test_id}/users

Fetches a single page of user results from an Access policy test.

Zero Trust Access Applications

Settings

ZeroTrust.Access.Applications.Settings

Methods

client.zeroTrust.access.applications.settings.update(, , ):

SettingUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/settings

Updates Access application settings.

client.zeroTrust.access.applications.settings.edit(, , ):

SettingEditResponse

patch/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/settings

Updates Access application settings.

Zero Trust Access Applications

User Policy Checks

ZeroTrust.Access.Applications.UserPolicyChecks

Methods

client.zeroTrust.access.applications.userPolicyChecks.list(, , ):

UserPolicyCheckListResponse

get/{accounts_or_zones}/{account_or_zone_id}/access/apps/{app_id}/user_policy_checks

Tests if a specific user has permission to access an application.

Domain types

UserPolicyCheckGeo{…}

Zero Trust Access

Bookmarks

ZeroTrust.Access.Bookmarks

Methods

client.zeroTrust.access.bookmarks.list(, ):

SinglePage

Bookmark

Deprecated

get/accounts/{account_id}/access/bookmarks

Lists Bookmark applications.

client.zeroTrust.access.bookmarks.get(, , ):

Bookmark

Deprecated

get/accounts/{account_id}/access/bookmarks/{bookmark_id}

Fetches a single Bookmark application.

client.zeroTrust.access.bookmarks.create(, , ):

Bookmark

Deprecated

post/accounts/{account_id}/access/bookmarks/{bookmark_id}

Create a new Bookmark application.

client.zeroTrust.access.bookmarks.update(, , ):

Bookmark

Deprecated

put/accounts/{account_id}/access/bookmarks/{bookmark_id}

Updates a configured Bookmark application.

client.zeroTrust.access.bookmarks.delete(, , ):

BookmarkDeleteResponse

Deprecated

delete/accounts/{account_id}/access/bookmarks/{bookmark_id}

Deletes a Bookmark application.

Domain types

Bookmark{…}

Zero Trust Access

Certificates

ZeroTrust.Access.Certificates

Methods

client.zeroTrust.access.certificates.list(, ):

V4PagePaginationArray

Certificate

get/{accounts_or_zones}/{account_or_zone_id}/access/certificates

Lists all mTLS root certificates.

client.zeroTrust.access.certificates.get(, , ):

Certificate

get/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}

Fetches a single mTLS certificate.

client.zeroTrust.access.certificates.create(, ):

Certificate

post/{accounts_or_zones}/{account_or_zone_id}/access/certificates

Adds a new mTLS root certificate to Access.

client.zeroTrust.access.certificates.update(, , ):

Certificate

put/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}

Updates a configured mTLS certificate.

client.zeroTrust.access.certificates.delete(, , ):

CertificateDeleteResponse

delete/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}

Deletes an mTLS certificate.

Domain types

AssociatedHostnames = string

A fully-qualified domain name (FQDN).

Certificate{…}

Zero Trust Access Certificates

Settings

ZeroTrust.Access.Certificates.Settings

Methods

client.zeroTrust.access.certificates.settings.get(, ):

SinglePage

CertificateSettings

get/{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings

List all mTLS hostname settings for this account or zone.

client.zeroTrust.access.certificates.settings.update(, ):

SinglePage

CertificateSettings

put/{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings

Updates an mTLS certificate's hostname settings.

Domain types

CertificateSettings{…}

Zero Trust Access

Custom Pages

ZeroTrust.Access.CustomPages

Methods

client.zeroTrust.access.customPages.list(, ):

V4PagePaginationArray

CustomPageWithoutHTML

get/accounts/{account_id}/access/custom_pages

List custom pages

client.zeroTrust.access.customPages.get(, , ):

CustomPage

get/accounts/{account_id}/access/custom_pages/{custom_page_id}

Fetches a custom page and also returns its HTML.

client.zeroTrust.access.customPages.create(, ):

CustomPageWithoutHTML

post/accounts/{account_id}/access/custom_pages

Create a custom page

client.zeroTrust.access.customPages.update(, , ):

CustomPageWithoutHTML

put/accounts/{account_id}/access/custom_pages/{custom_page_id}

Update a custom page

client.zeroTrust.access.customPages.delete(, , ):

CustomPageDeleteResponse

delete/accounts/{account_id}/access/custom_pages/{custom_page_id}

Delete a custom page

Domain types

CustomPage{…}

CustomPageWithoutHTML{…}

Zero Trust Access

Gateway CA

ZeroTrust.Access.GatewayCA

Methods

client.zeroTrust.access.gatewayCA.list(, ):

SinglePage

GatewayCAListResponse

get/accounts/{account_id}/access/gateway_ca

Lists SSH Certificate Authorities (CA).

client.zeroTrust.access.gatewayCA.create(, ):

GatewayCACreateResponse

post/accounts/{account_id}/access/gateway_ca

Adds a new SSH Certificate Authority (CA).

client.zeroTrust.access.gatewayCA.delete(, , ):

GatewayCADeleteResponse

delete/accounts/{account_id}/access/gateway_ca/{certificate_id}

Deletes an SSH Certificate Authority.

Zero Trust Access

Groups

ZeroTrust.Access.Groups

Methods

client.zeroTrust.access.groups.list(, ):

V4PagePaginationArray

GroupListResponse

get/{accounts_or_zones}/{account_or_zone_id}/access/groups

Lists all Access groups.

client.zeroTrust.access.groups.get(, , ):

GroupGetResponse

get/{accounts_or_zones}/{account_or_zone_id}/access/groups/{group_id}

Fetches a single Access group.

client.zeroTrust.access.groups.create(, ):

GroupCreateResponse

post/{accounts_or_zones}/{account_or_zone_id}/access/groups

Creates a new Access group.

client.zeroTrust.access.groups.update(, , ):

GroupUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/access/groups/{group_id}

Updates a configured Access group.

client.zeroTrust.access.groups.delete(, , ):

GroupDeleteResponse

delete/{accounts_or_zones}/{account_or_zone_id}/access/groups/{group_id}

Deletes an Access group.

Domain types

ZeroTrustGroup{…}

Zero Trust Access

Infrastructure

ZeroTrust.Access.Infrastructure

Zero Trust Access Infrastructure

Targets

ZeroTrust.Access.Infrastructure.Targets

Methods

client.zeroTrust.access.infrastructure.targets.list(, ):

V4PagePaginationArray

TargetListResponse

get/accounts/{account_id}/infrastructure/targets

Lists and sorts an account’s targets. Filters are optional and are ANDed together.

client.zeroTrust.access.infrastructure.targets.get(, , ):

TargetGetResponse

get/accounts/{account_id}/infrastructure/targets/{target_id}

Get target

client.zeroTrust.access.infrastructure.targets.create(, ):

TargetCreateResponse

post/accounts/{account_id}/infrastructure/targets

Create new target

client.zeroTrust.access.infrastructure.targets.update(, , ):

TargetUpdateResponse

put/accounts/{account_id}/infrastructure/targets/{target_id}

Update target

client.zeroTrust.access.infrastructure.targets.delete(, , ): void

delete/accounts/{account_id}/infrastructure/targets/{target_id}

Delete target

client.zeroTrust.access.infrastructure.targets.bulkUpdate(, ):

SinglePage

TargetBulkUpdateResponse

put/accounts/{account_id}/infrastructure/targets/batch

Adds one or more targets.

client.zeroTrust.access.infrastructure.targets.bulkDelete(, ): void

Deprecated

delete/accounts/{account_id}/infrastructure/targets/batch

Removes one or more targets.

client.zeroTrust.access.infrastructure.targets.bulkDeleteV2(, ): void

post/accounts/{account_id}/infrastructure/targets/batch_delete

Removes one or more targets.

Zero Trust Access

Keys

ZeroTrust.Access.Keys

Methods

client.zeroTrust.access.keys.get(, ):

KeyGetResponse

get/accounts/{account_id}/access/keys

Gets the Access key rotation settings for an account.

client.zeroTrust.access.keys.update(, ):

KeyUpdateResponse

put/accounts/{account_id}/access/keys

Updates the Access key rotation settings for an account.

client.zeroTrust.access.keys.rotate(, ):

KeyRotateResponse

post/accounts/{account_id}/access/keys/rotate

Perfoms a key rotation for an account.

Zero Trust Access

Logs

ZeroTrust.Access.Logs

Zero Trust Access Logs

Access Requests

ZeroTrust.Access.Logs.AccessRequests

Methods

client.zeroTrust.access.logs.accessRequests.list(, ):

AccessRequestListResponse

get/accounts/{account_id}/access/logs/access_requests

Gets a list of Access authentication audit logs for an account.

Zero Trust Access Logs

SCIM

ZeroTrust.Access.Logs.SCIM

Domain types

AccessRequest{…}

Zero Trust Access Logs SCIM

Updates

ZeroTrust.Access.Logs.SCIM.Updates

Methods

client.zeroTrust.access.logs.scim.updates.list(, ):

V4PagePaginationArray

UpdateListResponse

get/accounts/{account_id}/access/logs/scim/updates

Lists Access SCIM update logs that maintain a record of updates made to User and Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

Zero Trust Access

Policies

ZeroTrust.Access.Policies

Methods

client.zeroTrust.access.policies.list(, ):

V4PagePaginationArray

PolicyListResponse

get/accounts/{account_id}/access/policies

Lists Access reusable policies.

client.zeroTrust.access.policies.get(, , ):

PolicyGetResponse

get/accounts/{account_id}/access/policies/{policy_id}

Fetches a single Access reusable policy.

client.zeroTrust.access.policies.create(, ):

PolicyCreateResponse

post/accounts/{account_id}/access/policies

Creates a new Access reusable policy.

client.zeroTrust.access.policies.update(, , ):

PolicyUpdateResponse

put/accounts/{account_id}/access/policies/{policy_id}

Updates a Access reusable policy.

client.zeroTrust.access.policies.delete(, , ):

PolicyDeleteResponse

delete/accounts/{account_id}/access/policies/{policy_id}

Deletes an Access reusable policy.

Domain types

ApprovalGroup{…}

A group of email addresses that can approve a temporary authentication request.

Policy{…}

Zero Trust Access

Service Tokens

ZeroTrust.Access.ServiceTokens

Methods

client.zeroTrust.access.serviceTokens.list(, ):

V4PagePaginationArray

ServiceToken

get/{accounts_or_zones}/{account_or_zone_id}/access/service_tokens

Lists all service tokens.

client.zeroTrust.access.serviceTokens.get(, , ):

ServiceToken

get/{accounts_or_zones}/{account_or_zone_id}/access/service_tokens/{service_token_id}

Fetches a single service token.

client.zeroTrust.access.serviceTokens.create(, ):

ServiceTokenCreateResponse

post/{accounts_or_zones}/{account_or_zone_id}/access/service_tokens

Generates a new service token. Note: This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.

client.zeroTrust.access.serviceTokens.update(, , ):

ServiceToken

put/{accounts_or_zones}/{account_or_zone_id}/access/service_tokens/{service_token_id}

Updates a configured service token.

client.zeroTrust.access.serviceTokens.delete(, , ):

ServiceToken

delete/{accounts_or_zones}/{account_or_zone_id}/access/service_tokens/{service_token_id}

Deletes a service token.

client.zeroTrust.access.serviceTokens.refresh(, , ):

ServiceToken

post/accounts/{account_id}/access/service_tokens/{service_token_id}/refresh

Refreshes the expiration of a service token.

client.zeroTrust.access.serviceTokens.rotate(, , ):

ServiceTokenRotateResponse

post/accounts/{account_id}/access/service_tokens/{service_token_id}/rotate

Generates a new Client Secret for a service token and revokes the old one.

Domain types

ServiceToken{…}

Users

ZeroTrust.Access.Users

Methods

client.zeroTrust.access.users.list(, ):

V4PagePaginationArray

UserListResponse

get/accounts/{account_id}/access/users

Gets a list of users for an account.

Domain types

AccessUser{…}

Zero Trust Access Users

Active Sessions

ZeroTrust.Access.Users.ActiveSessions

Methods

client.zeroTrust.access.users.activeSessions.list(, , ):

SinglePage

ActiveSessionListResponse

get/accounts/{account_id}/access/users/{user_id}/active_sessions

Get active sessions for a single user.

client.zeroTrust.access.users.activeSessions.get(, , , ):

ActiveSessionGetResponse

get/accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}

Get an active session for a single user.

Zero Trust Access Users

Failed Logins

ZeroTrust.Access.Users.FailedLogins

Methods

client.zeroTrust.access.users.failedLogins.list(, , ):

SinglePage

FailedLoginListResponse

get/accounts/{account_id}/access/users/{user_id}/failed_logins

Get all failed login attempts for a single user.

Zero Trust Access Users

Last Seen Identity

ZeroTrust.Access.Users.LastSeenIdentity

Methods

client.zeroTrust.access.users.lastSeenIdentity.get(, , ):

Identity

get/accounts/{account_id}/access/users/{user_id}/last_seen_identity

Get last seen identity for a single user.

Domain types

Identity{…}

Zero Trust

Connectivity Settings

ZeroTrust.ConnectivitySettings

Methods

client.zeroTrust.connectivitySettings.get(, ):

ConnectivitySettingGetResponse

get/accounts/{account_id}/zerotrust/connectivity_settings

Gets the Zero Trust Connectivity Settings for the given account.

client.zeroTrust.connectivitySettings.edit(, ):

ConnectivitySettingEditResponse

patch/accounts/{account_id}/zerotrust/connectivity_settings

Updates the Zero Trust Connectivity Settings for the given account.

Zero Trust

Devices

ZeroTrust.Devices

Methods

client.zeroTrust.devices.list(, ):

SinglePage

Device

Deprecated

get/accounts/{account_id}/devices

List WARP devices. Not supported when multi-user mode is enabled for the account.

Deprecated: please use one of the following endpoints instead:

GET /accounts/{account_id}/devices/physical-devices
GET /accounts/{account_id}/devices/registrations

client.zeroTrust.devices.get(, , ):

DeviceGetResponse

| null

Deprecated

get/accounts/{account_id}/devices/{device_id}

Fetches a single WARP device. Not supported when multi-user mode is enabled for the account.

Deprecated: please use one of the following endpoints instead:

GET /accounts/{account_id}/devices/physical-devices/{device_id}
GET /accounts/{account_id}/devices/registrations/{registration_id}

Domain types

Device{…}

Zero Trust Devices

Devices

ZeroTrust.Devices.Devices

Methods

client.zeroTrust.devices.devices.list(, ):

CursorPagination

DeviceListResponse

get/accounts/{account_id}/devices/physical-devices

Lists WARP devices.

client.zeroTrust.devices.devices.get(, , ):

DeviceGetResponse

get/accounts/{account_id}/devices/physical-devices/{device_id}

Fetches a single WARP device.

client.zeroTrust.devices.devices.delete(, , ):

DeviceDeleteResponse

| null

delete/accounts/{account_id}/devices/physical-devices/{device_id}

Deletes a WARP device.

client.zeroTrust.devices.devices.revoke(, , ):

DeviceRevokeResponse

| null

post/accounts/{account_id}/devices/physical-devices/{device_id}/revoke

Revokes all WARP registrations associated with the specified device.

Zero Trust Devices

DEX Tests

ZeroTrust.Devices.DEXTests

Methods

client.zeroTrust.devices.dexTests.list(, ):

V4PagePaginationArray

DEXTestListResponse

get/accounts/{account_id}/dex/devices/dex_tests

Fetch all DEX tests

client.zeroTrust.devices.dexTests.get(, , ):

DEXTestGetResponse

get/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

Fetch a single DEX test.

client.zeroTrust.devices.dexTests.create(, ):

DEXTestCreateResponse

post/accounts/{account_id}/dex/devices/dex_tests

Create a DEX test.

client.zeroTrust.devices.dexTests.update(, , ):

DEXTestUpdateResponse

put/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

Update a DEX test.

client.zeroTrust.devices.dexTests.delete(, , ):

DEXTestDeleteResponse

delete/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

Delete a Device DEX test. Returns the remaining device dex tests for the account.

Domain types

SchemaData{…}

The configuration object which contains the details for the WARP client to conduct the test.

SchemaHTTP{…}

Zero Trust Devices

Fleet Status

ZeroTrust.Devices.FleetStatus

Methods

client.zeroTrust.devices.fleetStatus.get(, , ):

FleetStatusGetResponse

get/accounts/{account_id}/dex/devices/{device_id}/fleet-status/live

Get the live status of a latest device given device_id from the device_state table

Zero Trust Devices

Networks

ZeroTrust.Devices.Networks

Methods

client.zeroTrust.devices.networks.list(, ):

SinglePage

DeviceNetwork

get/accounts/{account_id}/devices/networks

Fetches a list of managed networks for an account.

client.zeroTrust.devices.networks.get(, , ):

DeviceNetwork

| null

get/accounts/{account_id}/devices/networks/{network_id}

Fetches details for a single managed network.

client.zeroTrust.devices.networks.create(, ):

DeviceNetwork

| null

post/accounts/{account_id}/devices/networks

Creates a new device managed network.

client.zeroTrust.devices.networks.update(, , ):

DeviceNetwork

| null

put/accounts/{account_id}/devices/networks/{network_id}

Updates a configured device managed network.

client.zeroTrust.devices.networks.delete(, , ):

SinglePage

DeviceNetwork

delete/accounts/{account_id}/devices/networks/{network_id}

Deletes a device managed network and fetches a list of the remaining device managed networks for an account.

Domain types

DeviceNetwork{…}

Zero Trust Devices

Override Codes

ZeroTrust.Devices.OverrideCodes

Methods

client.zeroTrust.devices.overrideCodes.list(, , ):

SinglePage

OverrideCodeListResponse

Deprecated

get/accounts/{account_id}/devices/{device_id}/override_codes

Fetches a one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration. Not supported when multi-user mode is enabled for the account. Deprecated: please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead.

client.zeroTrust.devices.overrideCodes.get(, , ):

OverrideCodeGetResponse

get/accounts/{account_id}/devices/registrations/{registration_id}/override_codes

Fetches one-time use admin override codes for a registration. This relies on the Admin Override setting being enabled in your device configuration.

Zero Trust Devices

Policies

ZeroTrust.Devices.Policies

Domain types

DevicePolicyCertificates{…}

FallbackDomain{…}

FallbackDomainPolicy = Array<

FallbackDomain

> | null

SettingsPolicy{…}

SplitTunnelExclude =

TeamsDevicesExcludeSplitTunnelWithAddress

TeamsDevicesExcludeSplitTunnelWithHost

SplitTunnelInclude =

TeamsDevicesIncludeSplitTunnelWithAddress

TeamsDevicesIncludeSplitTunnelWithHost

Zero Trust Devices Policies

Custom

ZeroTrust.Devices.Policies.Custom

Methods

client.zeroTrust.devices.policies.custom.list(, ):

SinglePage

SettingsPolicy

get/accounts/{account_id}/devices/policies

Fetches a list of the device settings profiles for an account.

client.zeroTrust.devices.policies.custom.get(, , ):

SettingsPolicy

| null

get/accounts/{account_id}/devices/policy/{policy_id}

Fetches a device settings profile by ID.

client.zeroTrust.devices.policies.custom.create(, ):

SettingsPolicy

| null

post/accounts/{account_id}/devices/policy

Creates a device settings profile to be applied to certain devices matching the criteria.

client.zeroTrust.devices.policies.custom.edit(, , ):

SettingsPolicy

| null

patch/accounts/{account_id}/devices/policy/{policy_id}

Updates a configured device settings profile.

client.zeroTrust.devices.policies.custom.delete(, , ):

SinglePage

SettingsPolicy

delete/accounts/{account_id}/devices/policy/{policy_id}

Deletes a device settings profile and fetches a list of the remaining profiles for an account.

Zero Trust Devices Policies Custom

Excludes

ZeroTrust.Devices.Policies.Custom.Excludes

Methods

client.zeroTrust.devices.policies.custom.excludes.get(, , ):

SinglePage

SplitTunnelExclude

get/accounts/{account_id}/devices/policy/{policy_id}/exclude

Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

client.zeroTrust.devices.policies.custom.excludes.update(, , ):

SinglePage

SplitTunnelExclude

put/accounts/{account_id}/devices/policy/{policy_id}/exclude

Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

Zero Trust Devices Policies Custom

Fallback Domains

ZeroTrust.Devices.Policies.Custom.FallbackDomains

Methods

client.zeroTrust.devices.policies.custom.fallbackDomains.get(, , ):

SinglePage

FallbackDomain

get/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains

Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.

client.zeroTrust.devices.policies.custom.fallbackDomains.update(, , ):

SinglePage

FallbackDomain

put/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.

Zero Trust Devices Policies Custom

Includes

ZeroTrust.Devices.Policies.Custom.Includes

Methods

client.zeroTrust.devices.policies.custom.includes.get(, , ):

SinglePage

SplitTunnelInclude

get/accounts/{account_id}/devices/policy/{policy_id}/include

Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.

client.zeroTrust.devices.policies.custom.includes.update(, , ):

SinglePage

SplitTunnelInclude

put/accounts/{account_id}/devices/policy/{policy_id}/include

Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.

Zero Trust Devices Policies

Default

ZeroTrust.Devices.Policies.Default

Methods

client.zeroTrust.devices.policies.default.get(, ):

DefaultGetResponse

| null

get/accounts/{account_id}/devices/policy

Fetches the default device settings profile for an account.

client.zeroTrust.devices.policies.default.edit(, ):

DefaultEditResponse

| null

patch/accounts/{account_id}/devices/policy

Updates the default device settings profile for an account.

Zero Trust Devices Policies Default

Certificates

ZeroTrust.Devices.Policies.Default.Certificates

Methods

client.zeroTrust.devices.policies.default.certificates.get(, ):

DevicePolicyCertificates

| null

get/zones/{zone_id}/devices/policy/certificates

Fetches device certificate provisioning.

client.zeroTrust.devices.policies.default.certificates.edit(, ):

DevicePolicyCertificates

| null

patch/zones/{zone_id}/devices/policy/certificates

Enable Zero Trust Clients to provision a certificate, containing a x509 subject, and referenced by Access device posture policies when the client visits MTLS protected domains. This facilitates device posture without a WARP session.

Zero Trust Devices Policies Default

Excludes

ZeroTrust.Devices.Policies.Default.Excludes

Methods

client.zeroTrust.devices.policies.default.excludes.get(, ):

SinglePage

SplitTunnelExclude

get/accounts/{account_id}/devices/policy/exclude

Fetches the list of routes excluded from the WARP client's tunnel.

client.zeroTrust.devices.policies.default.excludes.update(, ):

SinglePage

SplitTunnelExclude

put/accounts/{account_id}/devices/policy/exclude

Sets the list of routes excluded from the WARP client's tunnel.

Zero Trust Devices Policies Default

Fallback Domains

ZeroTrust.Devices.Policies.Default.FallbackDomains

Methods

client.zeroTrust.devices.policies.default.fallbackDomains.get(, ):

SinglePage

FallbackDomain

get/accounts/{account_id}/devices/policy/fallback_domains

Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

client.zeroTrust.devices.policies.default.fallbackDomains.update(, ):

SinglePage

FallbackDomain

put/accounts/{account_id}/devices/policy/fallback_domains

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

Zero Trust Devices Policies Default

Includes

ZeroTrust.Devices.Policies.Default.Includes

Methods

client.zeroTrust.devices.policies.default.includes.get(, ):

SinglePage

SplitTunnelInclude

get/accounts/{account_id}/devices/policy/include

Fetches the list of routes included in the WARP client's tunnel.

client.zeroTrust.devices.policies.default.includes.update(, ):

SinglePage

SplitTunnelInclude

put/accounts/{account_id}/devices/policy/include

Sets the list of routes included in the WARP client's tunnel.

Zero Trust Devices

Posture

ZeroTrust.Devices.Posture

Methods

client.zeroTrust.devices.posture.list(, ):

SinglePage

DevicePostureRule

get/accounts/{account_id}/devices/posture

Fetches device posture rules for a Zero Trust account.

client.zeroTrust.devices.posture.get(, , ):

DevicePostureRule

| null

get/accounts/{account_id}/devices/posture/{rule_id}

Fetches a single device posture rule.

client.zeroTrust.devices.posture.create(, ):

DevicePostureRule

| null

post/accounts/{account_id}/devices/posture

Creates a new device posture rule.

client.zeroTrust.devices.posture.update(, , ):

DevicePostureRule

| null

put/accounts/{account_id}/devices/posture/{rule_id}

Updates a device posture rule.

client.zeroTrust.devices.posture.delete(, , ):

PostureDeleteResponse

| null

delete/accounts/{account_id}/devices/posture/{rule_id}

Deletes a device posture rule.

Domain types

CarbonblackInput = string

ClientCertificateInput{…}

CrowdstrikeInput{…}

DeviceInput =

FileInput

UniqueClientIDInput

DomainJoinedInput

| 17 more...

The value to be checked against.

DeviceMatch{…}

DevicePostureRule{…}

DiskEncryptionInput{…}

DomainJoinedInput{…}

FileInput{…}

FirewallInput{…}

IntuneInput{…}

KolideInput{…}

OSVersionInput{…}

SentineloneInput{…}

SentineloneS2sInput{…}

TaniumInput{…}

UniqueClientIDInput{…}

WorkspaceOneInput{…}

Zero Trust Devices Posture

Integrations

ZeroTrust.Devices.Posture.Integrations

Methods

client.zeroTrust.devices.posture.integrations.list(, ):

SinglePage

Integration

get/accounts/{account_id}/devices/posture/integration

Fetches the list of device posture integrations for an account.

client.zeroTrust.devices.posture.integrations.get(, , ):

Integration

| null

get/accounts/{account_id}/devices/posture/integration/{integration_id}

Fetches details for a single device posture integration.

client.zeroTrust.devices.posture.integrations.create(, ):

Integration

| null

post/accounts/{account_id}/devices/posture/integration

Create a new device posture integration.

client.zeroTrust.devices.posture.integrations.edit(, , ):

Integration

| null

patch/accounts/{account_id}/devices/posture/integration/{integration_id}

Updates a configured device posture integration.

client.zeroTrust.devices.posture.integrations.delete(, , ):

IntegrationDeleteResponse

| null

delete/accounts/{account_id}/devices/posture/integration/{integration_id}

Delete a configured device posture integration.

Domain types

Integration{…}

Zero Trust Devices

Registrations

ZeroTrust.Devices.Registrations

Methods

client.zeroTrust.devices.registrations.list(, ):

CursorPagination

RegistrationListResponse

get/accounts/{account_id}/devices/registrations

Lists WARP registrations.

client.zeroTrust.devices.registrations.get(, , ):

RegistrationGetResponse

get/accounts/{account_id}/devices/registrations/{registration_id}

Fetches a single WARP registration.

client.zeroTrust.devices.registrations.delete(, , ):

RegistrationDeleteResponse

| null

delete/accounts/{account_id}/devices/registrations/{registration_id}

Deletes a WARP registration.

client.zeroTrust.devices.registrations.bulkDelete(, ):

RegistrationBulkDeleteResponse

| null

delete/accounts/{account_id}/devices/registrations

Deletes a list of WARP registrations.

client.zeroTrust.devices.registrations.revoke(, ):

RegistrationRevokeResponse

| null

post/accounts/{account_id}/devices/registrations/revoke

Revokes a list of WARP registrations.

client.zeroTrust.devices.registrations.unrevoke(, ):

RegistrationUnrevokeResponse

| null

post/accounts/{account_id}/devices/registrations/unrevoke

Unrevokes a list of WARP registrations.

Zero Trust Devices

Resilience

ZeroTrust.Devices.Resilience

Zero Trust Devices Resilience

Global WARP Override

ZeroTrust.Devices.Resilience.GlobalWARPOverride

Methods

client.zeroTrust.devices.resilience.globalWARPOverride.get(, ):

GlobalWARPOverrideGetResponse

| null

get/accounts/{account_id}/devices/resilience/disconnect

Fetch the Global WARP override state.

client.zeroTrust.devices.resilience.globalWARPOverride.create(, ):

GlobalWARPOverrideCreateResponse

| null

post/accounts/{account_id}/devices/resilience/disconnect

Sets the Global WARP override state.

Zero Trust Devices

Revoke

ZeroTrust.Devices.Revoke

Methods

client.zeroTrust.devices.revoke.create(, ):

RevokeCreateResponse

| null

Deprecated

post/accounts/{account_id}/devices/revoke

Revokes a list of devices. Not supported when multi-user mode is enabled.

Deprecated: please use POST /accounts/{account_id}/devices/registrations/revoke instead.

Zero Trust Devices

Settings

ZeroTrust.Devices.Settings

Methods

client.zeroTrust.devices.settings.get(, ):

DeviceSettings

| null

get/accounts/{account_id}/devices/settings

Describes the current device settings for a Zero Trust account.

client.zeroTrust.devices.settings.update(, ):

DeviceSettings

| null

put/accounts/{account_id}/devices/settings

Updates the current device settings for a Zero Trust account.

client.zeroTrust.devices.settings.edit(, ):

DeviceSettings

| null

patch/accounts/{account_id}/devices/settings

Patches the current device settings for a Zero Trust account.

client.zeroTrust.devices.settings.delete(, ):

DeviceSettings

| null

delete/accounts/{account_id}/devices/settings

Resets the current device settings for a Zero Trust account.

Domain types

DeviceSettings{…}

Zero Trust Devices

Unrevoke

ZeroTrust.Devices.Unrevoke

Methods

client.zeroTrust.devices.unrevoke.create(, ):

UnrevokeCreateResponse

| null

Deprecated

post/accounts/{account_id}/devices/unrevoke

Unrevokes a list of devices. Not supported when multi-user mode is enabled.

Deprecated: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.

Zero Trust

DEX

ZeroTrust.DEX

Domain types

DigitalExperienceMonitor{…}

NetworkPath{…}

NetworkPathResponse{…}

Percentiles{…}

Zero Trust DEX

Colos

ZeroTrust.DEX.Colos

Methods

client.zeroTrust.dex.colos.list(, ):

SinglePage

ColoListResponse

get/accounts/{account_id}/dex/colos

List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.

Zero Trust DEX

Commands

ZeroTrust.DEX.Commands

Methods

client.zeroTrust.dex.commands.list(, ):

V4PagePagination

CommandListResponse

get/accounts/{account_id}/dex/commands

Retrieves a paginated list of commands issued to devices under the specified account, optionally filtered by time range, device, or other parameters

client.zeroTrust.dex.commands.create(, ):

CommandCreateResponse

post/accounts/{account_id}/dex/commands

Initiate commands for up to 10 devices per account

Zero Trust DEX Commands

Devices

ZeroTrust.DEX.Commands.Devices

Methods

client.zeroTrust.dex.commands.devices.list(, ):

V4PagePagination

DeviceListResponse

get/accounts/{account_id}/dex/commands/devices

List devices with WARP client support for remote captures which have been connected in the last 1 hour.

Zero Trust DEX Commands

Downloads

ZeroTrust.DEX.Commands.Downloads

Methods

client.zeroTrust.dex.commands.downloads.get(, , , ):

Response

get/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

Downloads artifacts for an executed command. Bulk downloads are not supported

Zero Trust DEX Commands

Quota

ZeroTrust.DEX.Commands.Quota

Methods

client.zeroTrust.dex.commands.quota.get(, ):

QuotaGetResponse

get/accounts/{account_id}/dex/commands/quota

Retrieves the current quota usage and limits for device commands within a specific account, including the time when the quota will reset

Zero Trust DEX

Fleet Status

ZeroTrust.DEX.FleetStatus

Methods

client.zeroTrust.dex.fleetStatus.live(, ):

FleetStatusLiveResponse

get/accounts/{account_id}/dex/fleet-status/live

List details for live (up to 60 minutes) devices using WARP

client.zeroTrust.dex.fleetStatus.overTime(, ):

FleetStatusOverTimeResponse

get/accounts/{account_id}/dex/fleet-status/over-time

List details for devices using WARP, up to 7 days

Domain types

LiveStat{…}

Zero Trust DEX Fleet Status

Devices

ZeroTrust.DEX.FleetStatus.Devices

Methods

client.zeroTrust.dex.fleetStatus.devices.list(, ):

V4PagePaginationArray

DeviceListResponse

get/accounts/{account_id}/dex/fleet-status/devices

List details for devices using WARP

Zero Trust DEX

HTTP Tests

ZeroTrust.DEX.HTTPTests

Methods

client.zeroTrust.dex.httpTests.get(, , ):

HTTPDetails

get/accounts/{account_id}/dex/http-tests/{test_id}

Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.

Domain types

HTTPDetails{…}

Zero Trust DEX HTTP Tests

Percentiles

ZeroTrust.DEX.HTTPTests.Percentiles

Methods

client.zeroTrust.dex.httpTests.percentiles.get(, , ):

HTTPDetailsPercentiles

get/accounts/{account_id}/dex/http-tests/{test_id}/percentiles

Get percentiles for an http test for a given time period between 1 hour and 7 days.

Domain types

HTTPDetailsPercentiles{…}

TestStatOverTime{…}

Zero Trust DEX

Tests

ZeroTrust.DEX.Tests

Methods

client.zeroTrust.dex.tests.list(, ):

V4PagePagination

Tests

get/accounts/{account_id}/dex/tests/overview

List DEX tests with overview metrics

Domain types

AggregateTimePeriod{…}

Tests{…}

Zero Trust DEX Tests

Unique Devices

ZeroTrust.DEX.Tests.UniqueDevices

Methods

client.zeroTrust.dex.tests.uniqueDevices.list(, ):

UniqueDevices

get/accounts/{account_id}/dex/tests/unique-devices

Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.

Domain types

UniqueDevices{…}

Zero Trust DEX

Traceroute Test Results

ZeroTrust.DEX.TracerouteTestResults

Zero Trust DEX Traceroute Test Results

Network Path

ZeroTrust.DEX.TracerouteTestResults.NetworkPath

Methods

client.zeroTrust.dex.tracerouteTestResults.networkPath.get(, , ):

NetworkPathGetResponse

get/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path

Get a breakdown of hops and performance metrics for a specific traceroute test run

Zero Trust DEX

Traceroute Tests

ZeroTrust.DEX.TracerouteTests

Methods

client.zeroTrust.dex.tracerouteTests.get(, , ):

Traceroute

get/accounts/{account_id}/dex/traceroute-tests/{test_id}

Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.

client.zeroTrust.dex.tracerouteTests.percentiles(, , ):

TracerouteTestPercentilesResponse

get/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles

Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.

client.zeroTrust.dex.tracerouteTests.networkPath(, , ):

NetworkPathResponse

get/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path

Get a breakdown of metrics by hop for individual traceroute test runs

Domain types

Traceroute{…}

Zero Trust DEX

WARP Change Events

ZeroTrust.DEX.WARPChangeEvents

Methods

client.zeroTrust.dex.warpChangeEvents.get(, ):

WARPChangeEventGetResponse

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

List WARP configuration and enablement toggle change events by device.

Zero Trust

DLP

ZeroTrust.DLP

Zero Trust DLP

Datasets

ZeroTrust.DLP.Datasets

Methods

client.zeroTrust.dlp.datasets.list(, ):

SinglePage

Dataset

get/accounts/{account_id}/dlp/datasets

Fetch all datasets

client.zeroTrust.dlp.datasets.get(, , ):

DatasetGetResponse

get/accounts/{account_id}/dlp/datasets/{dataset_id}

Fetch a specific dataset

client.zeroTrust.dlp.datasets.create(, ):

DatasetCreateResponse

post/accounts/{account_id}/dlp/datasets

Create a new dataset

client.zeroTrust.dlp.datasets.update(, , ):

DatasetUpdateResponse

put/accounts/{account_id}/dlp/datasets/{dataset_id}

Update details about a dataset

client.zeroTrust.dlp.datasets.delete(, , ): void

delete/accounts/{account_id}/dlp/datasets/{dataset_id}

This deletes all versions of the dataset.

Domain types

Dataset{…}

DatasetArray = Array<

Dataset

DatasetCreation{…}

Zero Trust DLP Datasets

Upload

ZeroTrust.DLP.Datasets.Upload

Methods

client.zeroTrust.dlp.datasets.upload.create(, , ):

UploadCreateResponse

post/accounts/{account_id}/dlp/datasets/{dataset_id}/upload

Prepare to upload a new version of a dataset

client.zeroTrust.dlp.datasets.upload.edit(, , , , ):

UploadEditResponse

post/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}

This is used for single-column EDMv1 and Custom Word Lists. The EDM format can only be created in the Cloudflare dashboard. For other clients, this operation can only be used for non-secret Custom Word Lists. The body must be a UTF-8 encoded, newline (NL or CRNL) separated list of words to be matched.

Domain types

NewVersion{…}

Zero Trust DLP Datasets

Versions

ZeroTrust.DLP.Datasets.Versions

Methods

client.zeroTrust.dlp.datasets.versions.create(, , , ):

SinglePage

VersionCreateResponse

post/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}

This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard. The columns in the response appear in the same order as in the request.

Zero Trust DLP Datasets Versions

Entries

ZeroTrust.DLP.Datasets.Versions.Entries

Methods

client.zeroTrust.dlp.datasets.versions.entries.create(, , , , , ):

EntryCreateResponse

post/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}

This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard.

Zero Trust DLP

Email

ZeroTrust.DLP.Email

Zero Trust DLP Email

Account Mapping

ZeroTrust.DLP.Email.AccountMapping

Methods

client.zeroTrust.dlp.email.accountMapping.get(, ):

AccountMappingGetResponse

get/accounts/{account_id}/dlp/email/account_mapping

Get mapping

client.zeroTrust.dlp.email.accountMapping.create(, ):

AccountMappingCreateResponse

post/accounts/{account_id}/dlp/email/account_mapping

Create mapping

Zero Trust DLP Email

Rules

ZeroTrust.DLP.Email.Rules

Methods

client.zeroTrust.dlp.email.rules.list(, ):

SinglePage

RuleListResponse

get/accounts/{account_id}/dlp/email/rules

Lists all email scanner rules for an account.

client.zeroTrust.dlp.email.rules.get(, , ):

RuleGetResponse

get/accounts/{account_id}/dlp/email/rules/{rule_id}

Get an email scanner rule

client.zeroTrust.dlp.email.rules.create(, ):

RuleCreateResponse

post/accounts/{account_id}/dlp/email/rules

Create email scanner rule

client.zeroTrust.dlp.email.rules.update(, , ):

RuleUpdateResponse

put/accounts/{account_id}/dlp/email/rules/{rule_id}

Update email scanner rule

client.zeroTrust.dlp.email.rules.delete(, , ):

RuleDeleteResponse

delete/accounts/{account_id}/dlp/email/rules/{rule_id}

Delete email scanner rule

client.zeroTrust.dlp.email.rules.bulkEdit(, ):

RuleBulkEditResponse

patch/accounts/{account_id}/dlp/email/rules

Update email scanner rule priorities

Zero Trust DLP

Entries

ZeroTrust.DLP.Entries

Methods

client.zeroTrust.dlp.entries.list(, ):

SinglePage

EntryListResponse

get/accounts/{account_id}/dlp/entries

Lists all DLP entries in an account.

client.zeroTrust.dlp.entries.get(, , ):

EntryGetResponse

get/accounts/{account_id}/dlp/entries/{entry_id}

Fetches a DLP entry by ID.

client.zeroTrust.dlp.entries.create(, ):

EntryCreateResponse

post/accounts/{account_id}/dlp/entries

Creates a DLP custom entry.

client.zeroTrust.dlp.entries.update(, , ):

EntryUpdateResponse

put/accounts/{account_id}/dlp/entries/{entry_id}

Updates a DLP entry.

client.zeroTrust.dlp.entries.delete(, , ):

EntryDeleteResponse

| null

delete/accounts/{account_id}/dlp/entries/{entry_id}

Deletes a DLP custom entry.

Zero Trust DLP Entries

Custom

ZeroTrust.DLP.Entries.Custom

Methods

client.zeroTrust.dlp.entries.custom.create(, ):

CustomCreateResponse

post/accounts/{account_id}/dlp/entries

Creates a DLP custom entry.

client.zeroTrust.dlp.entries.custom.update(, , ):

CustomUpdateResponse

put/accounts/{account_id}/dlp/entries/custom/{entry_id}

Updates a DLP custom entry.

client.zeroTrust.dlp.entries.custom.delete(, , ):

CustomDeleteResponse

| null

delete/accounts/{account_id}/dlp/entries/{entry_id}

Deletes a DLP custom entry.

client.zeroTrust.dlp.entries.custom.get(, , ):

CustomGetResponse

get/accounts/{account_id}/dlp/entries/{entry_id}

Fetches a DLP entry by ID.

client.zeroTrust.dlp.entries.custom.list(, ):

SinglePage

CustomListResponse

get/accounts/{account_id}/dlp/entries

Lists all DLP entries in an account.

Zero Trust DLP Entries

Integration

ZeroTrust.DLP.Entries.Integration

Methods

client.zeroTrust.dlp.entries.integration.create(, ):

IntegrationCreateResponse

post/accounts/{account_id}/dlp/entries/integration

Integration entries can't be created, this will update an existing integration entry. This is needed for our generated terraform API.

client.zeroTrust.dlp.entries.integration.update(, , ):

IntegrationUpdateResponse

put/accounts/{account_id}/dlp/entries/integration/{entry_id}

Updates a DLP entry.

client.zeroTrust.dlp.entries.integration.delete(, , ):

IntegrationDeleteResponse

| null

delete/accounts/{account_id}/dlp/entries/integration/{entry_id}

This is a no-op as integration entires can't be deleted but is needed for our generated terraform API.

client.zeroTrust.dlp.entries.integration.get(, , ):

IntegrationGetResponse

get/accounts/{account_id}/dlp/entries/{entry_id}

Fetches a DLP entry by ID.

client.zeroTrust.dlp.entries.integration.list(, ):

SinglePage

IntegrationListResponse

get/accounts/{account_id}/dlp/entries

Lists all DLP entries in an account.

Zero Trust DLP Entries

Predefined

ZeroTrust.DLP.Entries.Predefined

Methods

client.zeroTrust.dlp.entries.predefined.create(, ):

PredefinedCreateResponse

post/accounts/{account_id}/dlp/entries/predefined

Predefined entries can't be created, this will update an existing predefined entry. This is needed for our generated terraform API.

client.zeroTrust.dlp.entries.predefined.update(, , ):

PredefinedUpdateResponse

put/accounts/{account_id}/dlp/entries/predefined/{entry_id}

Updates a DLP entry.

client.zeroTrust.dlp.entries.predefined.delete(, , ):

PredefinedDeleteResponse

| null

delete/accounts/{account_id}/dlp/entries/predefined/{entry_id}

This is a no-op as predefined entires can't be deleted but is needed for our generated terraform API.

client.zeroTrust.dlp.entries.predefined.get(, , ):

PredefinedGetResponse

get/accounts/{account_id}/dlp/entries/{entry_id}

Fetches a DLP entry by ID.

client.zeroTrust.dlp.entries.predefined.list(, ):

SinglePage

PredefinedListResponse

get/accounts/{account_id}/dlp/entries

Lists all DLP entries in an account.

Zero Trust DLP

Limits

ZeroTrust.DLP.Limits

Methods

client.zeroTrust.dlp.limits.list(, ):

LimitListResponse

get/accounts/{account_id}/dlp/limits

Fetch limits associated with DLP for account

Zero Trust DLP

Patterns

ZeroTrust.DLP.Patterns

Methods

client.zeroTrust.dlp.patterns.validate(, ):

PatternValidateResponse

post/accounts/{account_id}/dlp/patterns/validate

Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. The regex will be rejected if it uses * or +. Bound the maximum number of characters that can be matched using a range, e.g. {1,100}.

Zero Trust DLP

Payload Logs

ZeroTrust.DLP.PayloadLogs

Methods

client.zeroTrust.dlp.payloadLogs.get(, ):

PayloadLogGetResponse

get/accounts/{account_id}/dlp/payload_log

Get payload log settings

client.zeroTrust.dlp.payloadLogs.update(, ):

PayloadLogUpdateResponse

put/accounts/{account_id}/dlp/payload_log

Set payload log settings

Zero Trust DLP

Profiles

ZeroTrust.DLP.Profiles

Methods

client.zeroTrust.dlp.profiles.list(, ):

SinglePage

Profile

get/accounts/{account_id}/dlp/profiles

Lists all DLP profiles in an account.

client.zeroTrust.dlp.profiles.get(, , ):

ProfileGetResponse

get/accounts/{account_id}/dlp/profiles/{profile_id}

Fetches a DLP profile by ID.

Domain types

ContextAwareness{…}

Scan the context of predefined entries to only return matches surrounded by keywords.

Profile =

CustomProfile

PredefinedProfile

IntegrationProfile

SkipConfiguration{…}

Content types to exclude from context analysis and return all matches.

Zero Trust DLP Profiles

Custom

ZeroTrust.DLP.Profiles.Custom

Methods

client.zeroTrust.dlp.profiles.custom.get(, , ):

CustomGetResponse

get/accounts/{account_id}/dlp/profiles/custom/{profile_id}

Fetches a custom DLP profile by id.

client.zeroTrust.dlp.profiles.custom.create(, ):

CustomCreateResponse

post/accounts/{account_id}/dlp/profiles/custom

Creates a DLP custom profile.

client.zeroTrust.dlp.profiles.custom.update(, , ):

CustomUpdateResponse

put/accounts/{account_id}/dlp/profiles/custom/{profile_id}

Updates a DLP custom profile.

client.zeroTrust.dlp.profiles.custom.delete(, , ):

CustomDeleteResponse

| null

delete/accounts/{account_id}/dlp/profiles/custom/{profile_id}

Deletes a DLP custom profile.

Domain types

CustomProfile{…}

Pattern{…}

Zero Trust DLP Profiles

Predefined

ZeroTrust.DLP.Profiles.Predefined

Methods

client.zeroTrust.dlp.profiles.predefined.get(, , ):

PredefinedGetResponse

get/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config

This is similar to get_predefined but only returns entries that are enabled. This is needed for our terraform API Fetches a predefined DLP profile by id.

client.zeroTrust.dlp.profiles.predefined.update(, , ):

PredefinedUpdateResponse

put/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config

This is similar to update_predefined but only returns entries that are enabled. This is needed for our terraform API Updates a DLP predefined profile. Only supports enabling/disabling entries.

client.zeroTrust.dlp.profiles.predefined.delete(, , ):

PredefinedDeleteResponse

| null

delete/accounts/{account_id}/dlp/profiles/predefined/{profile_id}

This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.

Domain types

PredefinedProfile{…}

Zero Trust

Gateway

ZeroTrust.Gateway

Methods

client.zeroTrust.gateway.list(, ):

GatewayListResponse

get/accounts/{account_id}/gateway

Retrieve information about the current Zero Trust account.

client.zeroTrust.gateway.create(, ):

GatewayCreateResponse

post/accounts/{account_id}/gateway

Create a Zero Trust account for an existing Cloudflare account.

Zero Trust Gateway

App Types

ZeroTrust.Gateway.AppTypes

Methods

client.zeroTrust.gateway.appTypes.list(, ):

SinglePage

AppType

get/accounts/{account_id}/gateway/app_types

List all application and application type mappings.

Domain types

AppType =

ZeroTrustGatewayApplication

ZeroTrustGatewayApplicationType

Zero Trust Gateway

Audit SSH Settings

ZeroTrust.Gateway.AuditSSHSettings

Methods

client.zeroTrust.gateway.auditSSHSettings.get(, ):

GatewaySettings

get/accounts/{account_id}/gateway/audit_ssh_settings

Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.

client.zeroTrust.gateway.auditSSHSettings.update(, ):

GatewaySettings

put/accounts/{account_id}/gateway/audit_ssh_settings

Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.

client.zeroTrust.gateway.auditSSHSettings.rotateSeed(, ):

GatewaySettings

post/accounts/{account_id}/gateway/audit_ssh_settings/rotate_seed

Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy.

Domain types

GatewaySettings{…}

Zero Trust Gateway

get/accounts/{account_id}/gateway/certificates

List all Zero Trust certificates for an account.

client.zeroTrust.gateway.certificates.get(, , ):

CertificateGetResponse

get/accounts/{account_id}/gateway/certificates/{certificate_id}

Get a single Zero Trust certificate.

client.zeroTrust.gateway.certificates.create(, ):

CertificateCreateResponse

post/accounts/{account_id}/gateway/certificates

Create a new Zero Trust certificate.

client.zeroTrust.gateway.certificates.delete(, , ):

CertificateDeleteResponse

delete/accounts/{account_id}/gateway/certificates/{certificate_id}

Delete a gateway-managed Zero Trust certificate. You must deactivate the certificate from the edge (inactive) before deleting it.

client.zeroTrust.gateway.certificates.activate(, , ):

CertificateActivateResponse

post/accounts/{account_id}/gateway/certificates/{certificate_id}/activate

Bind a single Zero Trust certificate to the edge.

client.zeroTrust.gateway.certificates.deactivate(, , ):

CertificateDeactivateResponse

post/accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate

Unbind a single Zero Trust certificate from the edge.

Zero Trust Gateway

Configurations

ZeroTrust.Gateway.Configurations

Methods

client.zeroTrust.gateway.configurations.get(, ):

ConfigurationGetResponse

get/accounts/{account_id}/gateway/configuration

Retrieve the current Zero Trust account configuration.

client.zeroTrust.gateway.configurations.update(, ):

ConfigurationUpdateResponse

put/accounts/{account_id}/gateway/configuration

Update the current Zero Trust account configuration.

client.zeroTrust.gateway.configurations.edit(, ):

ConfigurationEditResponse

patch/accounts/{account_id}/gateway/configuration

Update (PATCH) a single subcollection of settings such as antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning, or certificate without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration.

Domain types

ActivityLogSettings{…}

Specify activity log settings.

AntiVirusSettings{…}

Specify anti-virus settings.

BlockPageSettings{…}

Specify block page layout settings.

BodyScanningSettings{…}

Specify the DLP inspection mode.

BrowserIsolationSettings{…}

Specify Clientless Browser Isolation settings.

CustomCertificateSettings{…}

Specify custom certificate settings for BYO-PKI. This field is deprecated; use certificate instead.

ExtendedEmailMatching{…}

Configures user email settings for firewall policies. When you enable this, the system standardizes email addresses in the identity portion of the rule to match extended email variants in firewall policies. When you disable this setting, the system matches email addresses exactly as you provide them. Enable this setting if your email uses . or + modifiers.

FipsSettings{…}

Specify FIPS settings.

GatewayConfigurationSettings{…}

Specify account settings.

NotificationSettings{…}

Configure the message the user's device shows during an antivirus scan.

ProtocolDetection{…}

Specify whether to detect protocols from the initial bytes of client traffic.

TLSSettings{…}

Specify whether to inspect encrypted HTTP traffic.

Zero Trust Gateway Configurations

Custom Certificate

ZeroTrust.Gateway.Configurations.CustomCertificate

Methods

client.zeroTrust.gateway.configurations.customCertificate.get(, ):

CustomCertificateSettings

| null

Deprecated

get/accounts/{account_id}/gateway/configuration/custom_certificate

Retrieve the current Zero Trust certificate configuration.

Zero Trust Gateway

Lists

ZeroTrust.Gateway.Lists

Methods

client.zeroTrust.gateway.lists.list(, ):

SinglePage

GatewayList

get/accounts/{account_id}/gateway/lists

Fetch all Zero Trust lists for an account.

client.zeroTrust.gateway.lists.get(, , ):

GatewayList

get/accounts/{account_id}/gateway/lists/{list_id}

Fetch a single Zero Trust list.

client.zeroTrust.gateway.lists.create(, ):

ListCreateResponse

post/accounts/{account_id}/gateway/lists

Creates a new Zero Trust list.

client.zeroTrust.gateway.lists.update(, , ):

GatewayList

put/accounts/{account_id}/gateway/lists/{list_id}

Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list.

client.zeroTrust.gateway.lists.edit(, , ):

GatewayList

patch/accounts/{account_id}/gateway/lists/{list_id}

Appends or removes an item from a configured Zero Trust list.

client.zeroTrust.gateway.lists.delete(, , ):

ListDeleteResponse

delete/accounts/{account_id}/gateway/lists/{list_id}

Deletes a Zero Trust list.

Domain types

GatewayItem{…}

GatewayList{…}

Zero Trust Gateway Lists

Items

ZeroTrust.Gateway.Lists.Items

Methods

client.zeroTrust.gateway.lists.items.list(, , ):

SinglePage

ItemListResponse

get/accounts/{account_id}/gateway/lists/{list_id}/items

Fetch all items in a single Zero Trust list.

Zero Trust Gateway

Locations

ZeroTrust.Gateway.Locations

Methods

client.zeroTrust.gateway.locations.list(, ):

SinglePage

Location

get/accounts/{account_id}/gateway/locations

List Zero Trust Gateway locations for an account.

client.zeroTrust.gateway.locations.get(, , ):

Location

get/accounts/{account_id}/gateway/locations/{location_id}

Get a single Zero Trust Gateway location.

client.zeroTrust.gateway.locations.create(, ):

Location

post/accounts/{account_id}/gateway/locations

Create a new Zero Trust Gateway location.

client.zeroTrust.gateway.locations.update(, , ):

Location

put/accounts/{account_id}/gateway/locations/{location_id}

Update a configured Zero Trust Gateway location.

client.zeroTrust.gateway.locations.delete(, , ):

LocationDeleteResponse

delete/accounts/{account_id}/gateway/locations/{location_id}

Delete a configured Zero Trust Gateway location.

Domain types

DOHEndpoint{…}

DOTEndpoint{…}

Endpoint{…}

Configure the destination endpoints for this location.

IPNetwork{…}

IPV4Endpoint{…}

IPV6Endpoint{…}

IPV6Network{…}

Location{…}

Zero Trust Gateway

Logging

ZeroTrust.Gateway.Logging

Methods

client.zeroTrust.gateway.logging.get(, ):

LoggingSetting

get/accounts/{account_id}/gateway/logging

Retrieve the current logging settings for the Zero Trust account.

client.zeroTrust.gateway.logging.update(, ):

LoggingSetting

put/accounts/{account_id}/gateway/logging

Update logging settings for the current Zero Trust account.

Domain types

LoggingSetting{…}

Zero Trust Gateway

Proxy Endpoints

ZeroTrust.Gateway.ProxyEndpoints

Methods

client.zeroTrust.gateway.proxyEndpoints.list(, ):

SinglePage

ProxyEndpoint

get/accounts/{account_id}/gateway/proxy_endpoints

List all Zero Trust Gateway proxy endpoints for an account.

client.zeroTrust.gateway.proxyEndpoints.get(, , ):

ProxyEndpoint

get/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Get a single Zero Trust Gateway proxy endpoint.

client.zeroTrust.gateway.proxyEndpoints.create(, ):

ProxyEndpoint

post/accounts/{account_id}/gateway/proxy_endpoints

Create a new Zero Trust Gateway proxy endpoint.

client.zeroTrust.gateway.proxyEndpoints.edit(, , ):

ProxyEndpoint

patch/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Update a configured Zero Trust Gateway proxy endpoint.

client.zeroTrust.gateway.proxyEndpoints.delete(, , ):

ProxyEndpointDeleteResponse

delete/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}

Delete a configured Zero Trust Gateway proxy endpoint.

Domain types

GatewayIPs = string

Specify an IPv4 or IPv6 CIDR. Limit IPv6 to a maximum of /109 and IPv4 to a maximum of /25.

ProxyEndpoint =

ZeroTrustGatewayProxyEndpointIP

ZeroTrustGatewayProxyEndpointIdentity

Zero Trust Gateway

Rules

ZeroTrust.Gateway.Rules

Methods

client.zeroTrust.gateway.rules.list(, ):

SinglePage

GatewayRule

get/accounts/{account_id}/gateway/rules

List Zero Trust Gateway rules for an account.

client.zeroTrust.gateway.rules.get(, , ):

GatewayRule

get/accounts/{account_id}/gateway/rules/{rule_id}

Get a single Zero Trust Gateway rule.

client.zeroTrust.gateway.rules.create(, ):

GatewayRule

post/accounts/{account_id}/gateway/rules

Create a new Zero Trust Gateway rule.

client.zeroTrust.gateway.rules.update(, , ):

GatewayRule

put/accounts/{account_id}/gateway/rules/{rule_id}

Update a configured Zero Trust Gateway rule.

client.zeroTrust.gateway.rules.delete(, , ):

RuleDeleteResponse

delete/accounts/{account_id}/gateway/rules/{rule_id}

Delete a Zero Trust Gateway rule.

client.zeroTrust.gateway.rules.listTenant(, ):

SinglePage

GatewayRule

get/accounts/{account_id}/gateway/rules/tenant

List Zero Trust Gateway rules for the parent account of an account in the MSP configuration.

client.zeroTrust.gateway.rules.resetExpiration(, , ):

GatewayRule

post/accounts/{account_id}/gateway/rules/{rule_id}/reset_expiration

Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and it has a default duration. The Zero Trust Gateway Rule must have values for both expiration.expires_at and expiration.duration.

Domain types

DNSResolverSettingsV4{…}

DNSResolverSettingsV6{…}

GatewayFilter = "http" | "dns" | "l4" | 2 more...

Specify the protocol or layer to use.

GatewayRule{…}

RuleSetting{…}

Defines settings for this rule. Settings apply only to specific rule types and must use compatible selectors. If Terraform detects drift, confirm the setting supports your rule type and check whether the API modifies the value. Use API-returned values in your configuration to prevent drift.

Schedule{…}

Defines the schedule for activating DNS policies. Settable only for dns and dns_resolver rules.

Zero Trust

Identity Providers

ZeroTrust.IdentityProviders

Methods

client.zeroTrust.identityProviders.list(, ):

V4PagePaginationArray

IdentityProviderListResponse

get/{accounts_or_zones}/{account_or_zone_id}/access/identity_providers

Lists all configured identity providers.

client.zeroTrust.identityProviders.get(, , ):

IdentityProvider

get/{accounts_or_zones}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}

Fetches a configured identity provider.

client.zeroTrust.identityProviders.create(, ):

IdentityProvider

post/{accounts_or_zones}/{account_or_zone_id}/access/identity_providers

Adds a new identity provider to Access.

client.zeroTrust.identityProviders.update(, , ):

IdentityProvider

put/{accounts_or_zones}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}

Updates a configured identity provider.

client.zeroTrust.identityProviders.delete(, , ):

IdentityProviderDeleteResponse

delete/{accounts_or_zones}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}

Deletes an identity provider from Access.

Domain types

AzureAD{…}

GenericOAuthConfig{…}

IdentityProvider =

AzureAD

AccessCentrify

AccessFacebook

| 11 more...

IdentityProviderSCIMConfig{…}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

IdentityProviderType = "onetimepin" | "azureAD" | "saml" | 11 more...

The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.

Zero Trust Identity Providers

SCIM

ZeroTrust.IdentityProviders.SCIM

Zero Trust Identity Providers SCIM

Groups

ZeroTrust.IdentityProviders.SCIM.Groups

Methods

client.zeroTrust.identityProviders.scim.groups.list(, , ):

V4PagePaginationArray

ZeroTrustGroup

get/accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups

Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

Zero Trust Identity Providers SCIM

Users

ZeroTrust.IdentityProviders.SCIM.Users

Methods

client.zeroTrust.identityProviders.scim.users.list(, , ):

V4PagePaginationArray

AccessUser

get/accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users

Lists SCIM User resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

Zero Trust

Networks

ZeroTrust.Networks

Zero Trust Networks

Hostname Routes

ZeroTrust.Networks.HostnameRoutes

Methods

client.zeroTrust.networks.hostnameRoutes.list(, ):

V4PagePaginationArray

HostnameRoute

get/accounts/{account_id}/zerotrust/routes/hostname

Lists and filters hostname routes in an account.

client.zeroTrust.networks.hostnameRoutes.get(, , ):

HostnameRoute

get/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Get a hostname route.

client.zeroTrust.networks.hostnameRoutes.create(, ):

HostnameRoute

post/accounts/{account_id}/zerotrust/routes/hostname

Create a hostname route.

client.zeroTrust.networks.hostnameRoutes.edit(, , ):

HostnameRoute

patch/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Updates a hostname route.

client.zeroTrust.networks.hostnameRoutes.delete(, , ):

HostnameRoute

delete/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Delete a hostname route.

Domain types

HostnameRoute{…}

Zero Trust Networks

Routes

ZeroTrust.Networks.Routes

Methods

client.zeroTrust.networks.routes.list(, ):

V4PagePaginationArray

Teamnet

get/accounts/{account_id}/teamnet/routes

Lists and filters private network routes in an account.

client.zeroTrust.networks.routes.get(, , ):

Route

get/accounts/{account_id}/teamnet/routes/{route_id}

Get a private network route in an account.

client.zeroTrust.networks.routes.create(, ):

Route

post/accounts/{account_id}/teamnet/routes

Routes a private network through a Cloudflare Tunnel.

client.zeroTrust.networks.routes.edit(, , ):

Route

patch/accounts/{account_id}/teamnet/routes/{route_id}

Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.

client.zeroTrust.networks.routes.delete(, , ):

Route

delete/accounts/{account_id}/teamnet/routes/{route_id}

Deletes a private network route from an account.

Domain types

NetworkRoute{…}

Route{…}

Teamnet{…}

Zero Trust Networks Routes

IPs

ZeroTrust.Networks.Routes.IPs

Methods

client.zeroTrust.networks.routes.ips.get(, , ):

Teamnet

get/accounts/{account_id}/teamnet/routes/ip/{ip}

Fetches routes that contain the given IP address.

Zero Trust Networks Routes

Networks

ZeroTrust.Networks.Routes.Networks

Methods

client.zeroTrust.networks.routes.networks.create(, , ):

Route

Deprecated

post/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

Deprecated

This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.

Routes a private network through a Cloudflare Tunnel. The CIDR in ip_network_encoded must be written in URL-encoded format.

client.zeroTrust.networks.routes.networks.edit(, , ):

Route

Deprecated

patch/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

Deprecated

This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.

Updates an existing private network route in an account. The CIDR in ip_network_encoded must be written in URL-encoded format.

client.zeroTrust.networks.routes.networks.delete(, , ):

Route

Deprecated

delete/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

Deprecated

This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.

Deletes a private network route from an account. The CIDR in ip_network_encoded must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.

Zero Trust Networks

Subnets

ZeroTrust.Networks.Subnets

Methods

client.zeroTrust.networks.subnets.list(, ):

V4PagePaginationArray

SubnetListResponse

get/accounts/{account_id}/zerotrust/subnets

Lists and filters subnets in an account.

Zero Trust Networks Subnets

Cloudflare Source

ZeroTrust.Networks.Subnets.CloudflareSource

Methods

client.zeroTrust.networks.subnets.cloudflareSource.update(, , ):

CloudflareSourceUpdateResponse

patch/accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}

Updates the Cloudflare Source subnet of the given address family

Zero Trust Networks

Virtual Networks

ZeroTrust.Networks.VirtualNetworks

Methods

client.zeroTrust.networks.virtualNetworks.list(, ):

SinglePage

VirtualNetwork

get/accounts/{account_id}/teamnet/virtual_networks

Lists and filters virtual networks in an account.

client.zeroTrust.networks.virtualNetworks.get(, , ):

VirtualNetwork

get/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

Get a virtual network.

client.zeroTrust.networks.virtualNetworks.create(, ):

VirtualNetwork

post/accounts/{account_id}/teamnet/virtual_networks

Adds a new virtual network to an account.

client.zeroTrust.networks.virtualNetworks.edit(, , ):

VirtualNetwork

patch/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

Updates an existing virtual network.

client.zeroTrust.networks.virtualNetworks.delete(, , ):

VirtualNetwork

delete/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

Deletes an existing virtual network.

Domain types

VirtualNetwork{…}

Zero Trust

Organizations

ZeroTrust.Organizations

Methods

client.zeroTrust.organizations.list(, ):

Organization

get/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Returns the configuration for your Zero Trust organization.

client.zeroTrust.organizations.create(, ):

Organization

post/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Sets up a Zero Trust organization for your account or zone.

client.zeroTrust.organizations.update(, ):

Organization

put/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Updates the configuration for your Zero Trust organization.

client.zeroTrust.organizations.revokeUsers(, ):

OrganizationRevokeUsersResponse

post/{accounts_or_zones}/{account_or_zone_id}/access/organizations/revoke_user

Revokes a user's access across all applications.

Domain types

LoginDesign{…}

Organization{…}

Zero Trust Organizations

DOH

ZeroTrust.Organizations.DOH

Methods

client.zeroTrust.organizations.doh.get(, ):

DOHGetResponse

get/accounts/{account_id}/access/organizations/doh

Returns the DoH settings for your Zero Trust organization.

client.zeroTrust.organizations.doh.update(, ):

DOHUpdateResponse

put/accounts/{account_id}/access/organizations/doh

Updates the DoH settings for your Zero Trust organization.

Zero Trust

Risk Scoring

ZeroTrust.RiskScoring

Methods

client.zeroTrust.riskScoring.get(, , ):

RiskScoringGetResponse

get/accounts/{account_id}/zt_risk_scoring/{user_id}

Get risk event/score information for a specific user

client.zeroTrust.riskScoring.reset(, , ):

RiskScoringResetResponse

| null

post/accounts/{account_id}/zt_risk_scoring/{user_id}/reset

Clear the risk score for a particular user

Zero Trust Risk Scoring

Behaviours

ZeroTrust.RiskScoring.Behaviours

Methods

client.zeroTrust.riskScoring.behaviours.get(, ):

BehaviourGetResponse

get/accounts/{account_id}/zt_risk_scoring/behaviors

Get all behaviors and associated configuration

client.zeroTrust.riskScoring.behaviours.update(, ):

BehaviourUpdateResponse

put/accounts/{account_id}/zt_risk_scoring/behaviors

Update configuration for risk behaviors

Zero Trust Risk Scoring

Integrations

ZeroTrust.RiskScoring.Integrations

Methods

client.zeroTrust.riskScoring.integrations.list(, ):

SinglePage

IntegrationListResponse

get/accounts/{account_id}/zt_risk_scoring/integrations

List all risk score integrations for the account.

client.zeroTrust.riskScoring.integrations.get(, , ):

IntegrationGetResponse

get/accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Get risk score integration by id.

client.zeroTrust.riskScoring.integrations.create(, ):

IntegrationCreateResponse

post/accounts/{account_id}/zt_risk_scoring/integrations

Create new risk score integration.

client.zeroTrust.riskScoring.integrations.update(, , ):

IntegrationUpdateResponse

put/accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Overwrite the reference_id, tenant_url, and active values with the ones provided.

client.zeroTrust.riskScoring.integrations.delete(, , ):

IntegrationDeleteResponse

| null

delete/accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}

Delete a risk score integration.

Zero Trust Risk Scoring Integrations

References

ZeroTrust.RiskScoring.Integrations.References

Methods

client.zeroTrust.riskScoring.integrations.references.get(, , ):

ReferenceGetResponse

get/accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}

Get risk score integration by reference id.

Zero Trust Risk Scoring

Summary

ZeroTrust.RiskScoring.Summary

Methods

client.zeroTrust.riskScoring.summary.get(, ):

SummaryGetResponse

get/accounts/{account_id}/zt_risk_scoring/summary

Get risk score info for all users in the account

Zero Trust

Seats

ZeroTrust.Seats

Methods

client.zeroTrust.seats.edit(, ):

SinglePage

Seat

patch/accounts/{account_id}/access/seats

Removes a user from a Zero Trust seat when both access_seat and gateway_seat are set to false.

Domain types

Seat{…}

Zero Trust

Tunnels

ZeroTrust.Tunnels

Methods

client.zeroTrust.tunnels.list(, ):

V4PagePaginationArray

TunnelListResponse

get/accounts/{account_id}/tunnels

Lists and filters all types of Tunnels in an account.

Domain types

Connection{…}

Zero Trust Tunnels

Cloudflared

ZeroTrust.Tunnels.Cloudflared

Methods

client.zeroTrust.tunnels.cloudflared.list(, ):

V4PagePaginationArray

CloudflareTunnel

get/accounts/{account_id}/cfd_tunnel

Lists and filters Cloudflare Tunnels in an account.

client.zeroTrust.tunnels.cloudflared.get(, , ):

CloudflareTunnel

get/accounts/{account_id}/cfd_tunnel/{tunnel_id}

Fetches a single Cloudflare Tunnel.

client.zeroTrust.tunnels.cloudflared.create(, ):

CloudflareTunnel

post/accounts/{account_id}/cfd_tunnel

Creates a new Cloudflare Tunnel in an account.

client.zeroTrust.tunnels.cloudflared.edit(, , ):

CloudflareTunnel

patch/accounts/{account_id}/cfd_tunnel/{tunnel_id}

Updates an existing Cloudflare Tunnel.

client.zeroTrust.tunnels.cloudflared.delete(, , ):

CloudflareTunnel

delete/accounts/{account_id}/cfd_tunnel/{tunnel_id}

Deletes a Cloudflare Tunnel from an account.

Zero Trust Tunnels Cloudflared

Configurations

ZeroTrust.Tunnels.Cloudflared.Configurations

Methods

client.zeroTrust.tunnels.cloudflared.configurations.get(, , ):

ConfigurationGetResponse

get/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations

Gets the configuration for a remotely-managed tunnel

client.zeroTrust.tunnels.cloudflared.configurations.update(, , ):

ConfigurationUpdateResponse

put/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations

Adds or updates the configuration for a remotely-managed tunnel.

Zero Trust Tunnels Cloudflared

Connections

ZeroTrust.Tunnels.Cloudflared.Connections

Methods

client.zeroTrust.tunnels.cloudflared.connections.get(, , ):

SinglePage

Client

get/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections

Fetches connection details for a Cloudflare Tunnel.

client.zeroTrust.tunnels.cloudflared.connections.delete(, , ):

ConnectionDeleteResponse

| null

delete/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections

Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.

Domain types

Client{…}

A client (typically cloudflared) that maintains connections to a Cloudflare data center.

Zero Trust Tunnels Cloudflared

Connectors

ZeroTrust.Tunnels.Cloudflared.Connectors

Methods

client.zeroTrust.tunnels.cloudflared.connectors.get(, , , ):

Client

get/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}

Fetches connector and connection details for a Cloudflare Tunnel.

Zero Trust Tunnels Cloudflared

Management

ZeroTrust.Tunnels.Cloudflared.Management

Methods

client.zeroTrust.tunnels.cloudflared.management.create(, , ):

ManagementCreateResponse

post/accounts/{account_id}/cfd_tunnel/{tunnel_id}/management

Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.

Zero Trust Tunnels Cloudflared

Token

ZeroTrust.Tunnels.Cloudflared.Token

Methods

client.zeroTrust.tunnels.cloudflared.token.get(, , ):

TokenGetResponse

get/accounts/{account_id}/cfd_tunnel/{tunnel_id}/token

Gets the token used to associate cloudflared with a specific tunnel.

Zero Trust Tunnels

WARP Connector

ZeroTrust.Tunnels.WARPConnector

Methods

client.zeroTrust.tunnels.warpConnector.list(, ):

V4PagePaginationArray

WARPConnectorListResponse

get/accounts/{account_id}/warp_connector

Lists and filters Warp Connector Tunnels in an account.

client.zeroTrust.tunnels.warpConnector.get(, , ):

WARPConnectorGetResponse

get/accounts/{account_id}/warp_connector/{tunnel_id}

Fetches a single Warp Connector Tunnel.

client.zeroTrust.tunnels.warpConnector.create(, ):

WARPConnectorCreateResponse

post/accounts/{account_id}/warp_connector

Creates a new Warp Connector Tunnel in an account.

client.zeroTrust.tunnels.warpConnector.edit(, , ):

WARPConnectorEditResponse

patch/accounts/{account_id}/warp_connector/{tunnel_id}

Updates an existing Warp Connector Tunnel.

client.zeroTrust.tunnels.warpConnector.delete(, , ):

WARPConnectorDeleteResponse

delete/accounts/{account_id}/warp_connector/{tunnel_id}

Deletes a Warp Connector Tunnel from an account.

Zero Trust Tunnels WARP Connector

Token

ZeroTrust.Tunnels.WARPConnector.Token

Methods

client.zeroTrust.tunnels.warpConnector.token.get(, , ):

TokenGetResponse

get/accounts/{account_id}/warp_connector/{tunnel_id}/token

Gets the token used to associate warp device with a specific Warp Connector tunnel.

Zero Trust

Access

AI Controls

Mcp

Portals

Servers

Applications

CAs

Policies

Policy Tests

Users

Settings

User Policy Checks

Bookmarks

Certificates

Settings

Custom Pages

Gateway CA

Groups

Infrastructure

Targets

Keys

Logs

Access Requests

SCIM

Updates

Policies

Service Tokens

Tags

Users

Active Sessions

Failed Logins

Last Seen Identity

Connectivity Settings

Devices

Devices

DEX Tests

Fleet Status

Networks

Override Codes

Policies

Custom

Excludes

Fallback Domains

Includes

Default

Certificates

Excludes

Fallback Domains

Includes

Posture

Integrations

Registrations

Resilience

Global WARP Override

Revoke

Settings

Unrevoke

DEX

Colos

Commands

Devices

Downloads

Quota

Fleet Status

Devices

HTTP Tests

Percentiles

Tests

Unique Devices

Traceroute Test Results

Network Path

Traceroute Tests

WARP Change Events

DLP

Datasets

Upload

Versions

Entries

Email