How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Zero Trust Accounts API

The Zero Trust Accounts API from APIs.io Engineering Platform — 5 operation(s) for zero trust accounts.

This API exposes 11 operations across 5 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://api.cloudflare.com/client/v4.

11 operations 5 paths 36 schemas 5 GET2 PATCH1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.cloudflare.com/client/v4
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Zero Trust Accounts API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 5 GET, 2 PATCH, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Accounts 11
GET
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Get device settings for a Zero Trust account
zero-trust-accounts-get-device-settings-for-zero-trust-account 1 param → 4XX200
PATCH
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Patch device settings for a Zero Trust account
zero-trust-accounts-patch-device-settings-for-the-zero-trust-account 1 param body → 4XX200
PUT
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Update device settings for a Zero Trust account
zero-trust-accounts-update-device-settings-for-the-zero-trust-account 1 param body → 4XX200
GET
/accounts/{account_id}/gateway
APIs.io Engineering Platform Get Zero Trust account information
zero-trust-accounts-get-zero-trust-account-information 1 param → 4XX200
POST
/accounts/{account_id}/gateway
APIs.io Engineering Platform Create Zero Trust account
zero-trust-accounts-create-zero-trust-account 1 param → 4XX200
GET
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Get Zero Trust account configuration
zero-trust-accounts-get-zero-trust-account-configuration 1 param → 4XX200
PATCH
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Patch Zero Trust account configuration
zero-trust-accounts-patch-zero-trust-account-configuration 1 param body → 4XX200
PUT
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Update Zero Trust account configuration
zero-trust-accounts-update-zero-trust-account-configuration 1 param body → 4XX200
GET
/accounts/{account_id}/gateway/configuration/custom_certificate
APIs.io Engineering Platform Get Zero Trust certificate configuration
zero-trust-accounts-get-zero-trust-certificate-configuration 1 param → 4XX200
GET
/accounts/{account_id}/gateway/logging
APIs.io Engineering Platform Get logging settings for the Zero Trust account
zero-trust-accounts-get-logging-settings-for-the-zero-trust-account 1 param → 4XX200
PUT
/accounts/{account_id}/gateway/logging
APIs.io Engineering Platform Update Zero Trust account logging settings
zero-trust-accounts-update-logging-settings-for-the-zero-trust-account 1 param body → 4XX200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_block-page-settings (9 properties), teams-devices_zero-trust-account-device-settings (5 properties), teams-devices_api-response-common (4 properties), teams-devices_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

zero-trust-gateway_gateway-account-logging-settings
object
2 properties
zero-trust-gateway_gateway_account_config
object
zero-trust-gateway_messages
array
zero-trust-gateway_body-scanning-settings
object
DLP body scanning settings.
1 property
teams-devices_zero-trust-account-device-settings
object
5 properties
teams-devices_messages
array
zero-trust-gateway_tls-settings
object
TLS interception settings.
1 property
teams-devices_api-response-single
object
teams-devices_identifier
zero-trust-gateway_cf_account_id
string
Cloudflare account ID.
zero-trust-gateway_extended-email-matching
object
Extended e-mail matching settings.
1 property
zero-trust-gateway_api-response-single
object
zero-trust-gateway_protocol-detection
object
Protocol Detection settings.
1 property
zero-trust-gateway_activity-log-settings
object
Activity log settings.
1 property
zero-trust-gateway_fail_closed
boolean
Block requests for files that cannot be scanned.
zero-trust-gateway_enabled_upload_phase
boolean
Enable anti-virus scanning on uploads.
zero-trust-gateway_gateway-account-logging-settings-response
object
zero-trust-gateway_gateway_account
object
zero-trust-gateway_gateway_tag
string
Gateway internal ID.
zero-trust-gateway_anti-virus-settings
object
Anti-virus settings.
4 properties
zero-trust-gateway_timestamp
string
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
teams-devices_zero-trust-account-device-settings-response
object
zero-trust-gateway_identifier
string
zero-trust-gateway_enabled_download_phase
boolean
Enable anti-virus scanning on downloads.
teams-devices_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_block-page-settings
object
Block page layout settings.
9 properties
zero-trust-gateway_browser-isolation-settings
object
Browser isolation settings.
2 properties
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_fips-settings
object
FIPS settings.
1 property
zero-trust-gateway_provider_name
string
The name of the provider. Usually Cloudflare.
zero-trust-gateway_notification_settings
object
Configure a message to display on the user's device when an antivirus search is performed.
3 properties
zero-trust-gateway_certificate-settings
object
Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
1 property 1 required
zero-trust-gateway_gateway-account-settings
object
account settings.
1 property
teams-devices_api-response-common
object
4 properties 4 required
zero-trust-gateway_custom-certificate-settings
object
Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-accounts-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Zero Trust Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.