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 Zone-Level Access Policies API

The Zone-Level Access Policies API from APIs.io Engineering Platform — 2 operation(s) for zone-level access policies.

This API exposes 5 operations across 2 paths, and defines 45 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.

5 operations 2 paths 45 schemas 1 DELETE2 GET1 POST1 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 Zone-Level Access Policies 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 5

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

Zone-Level Access Policies 5
GET
/zones/{zone_id}/access/apps/{app_id}/policies
APIs.io Engineering Platform List Access policies
zone-level-access-policies-list-access-policies 2 params → 4XX200
POST
/zones/{zone_id}/access/apps/{app_id}/policies
APIs.io Engineering Platform Create an Access policy
zone-level-access-policies-create-an-access-policy 2 params body → 4XX201
DELETE
/zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}
APIs.io Engineering Platform Delete an Access policy
zone-level-access-policies-delete-an-access-policy 3 params → 4XX202
GET
/zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}
APIs.io Engineering Platform Get an Access policy
zone-level-access-policies-get-an-access-policy 3 params → 4XX200
PUT
/zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}
APIs.io Engineering Platform Update an Access policy
zone-level-access-policies-update-an-access-policy 3 params body → 4XX200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are access_policies (14 properties), access_result_info (4 properties), access_api-response-common-failure (4 properties), access_api-response-common (3 properties). Each schema is shown below with its type and property counts.

access_gsuite_group_rule
object
Matches a group in Google Workspace. Requires a Google Workspace identity provider.
1 property 1 required
access_email_rule
object
Matches a specific email.
1 property 1 required
access_email_list_rule
object
Matches an email address from a list.
1 property 1 required
access_external_evaluation_rule
object
Create Allow or Block policies which evaluate the user based on custom criteria.
1 property 1 required
access_policies_components-schemas-response_collection
access_api-response-common-failure
object
4 properties 4 required
access_schemas-require
array
Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
access_schemas-precedence
integer
The order of execution for this policy. Must be unique for each policy.
access_api-response-collection
object
access_result_info
object
4 properties
access_service_token_rule
object
Matches a specific Access Service Token
1 property 1 required
access_github_organization_rule
object
Matches a Github organization. Requires a Github identity provider.
1 property 1 required
access_api-response-single
object
access_schemas-exclude
array
Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
access_ip_rule
object
Matches an IP address block.
1 property 1 required
access_uuid
string
UUID
access_azure_group_rule
object
Matches an Azure group. Requires an Azure identity provider.
1 property 1 required
access_ip_list_rule
object
Matches an IP address from a list.
1 property 1 required
access_policies_components-schemas-name
string
The name of the Access policy.
access_timestamp
string
access_domain_rule
object
Match an entire email domain.
1 property 1 required
access_policies_components-schemas-single_response
access_device_posture_rule
object
Enforces a device posture rule has run successfully
1 property 1 required
access_rule
object
access_everyone_rule
object
Matches everyone.
1 property 1 required
access_purpose_justification_prompt
string
A custom message that will appear on the purpose justification screen.
access_any_valid_service_token_rule
object
Matches any valid Access Service Token
1 property 1 required
access_schemas-approval_group
object
A group of email addresses that can approve a temporary authentication request.
3 properties 1 required
access_schemas-approval_groups
array
Administrators who can approve a temporary authentication request.
access_access_group_rule
object
Matches an Access group.
1 property 1 required
access_okta_group_rule
object
Matches an Okta group. Requires an Okta identity provider.
1 property 1 required
access_schemas-isolation_required
boolean
Require this application to be served in an isolated browser for users matching this policy.
access_certificate_rule
object
Matches any valid client certificate.
1 property 1 required
access_purpose_justification_required
boolean
Require users to enter a justification when they log in to the application.
access_policies
object
14 properties
access_include
array
Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
access_identifier
string
Identifier
access_saml_group_rule
object
Matches a SAML group. Requires a SAML identity provider.
1 property 1 required
access_api-response-common
object
3 properties 3 required
access_decision
string
The action Access will take if a user matches this policy.
access_country_rule
object
Matches a specific country
1 property 1 required
access_id_response
access_messages
array
access_approval_required
boolean
Requires the user to request access from an administrator at the start of each session.
access_authentication_method_rule
object
Enforce different MFA options
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zone-level-access-policies-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Zone-Level Access Policies 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.