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 Applications API

The Zone-Level Access Applications API from APIs.io Engineering Platform — 4 operation(s) for zone-level access applications.

This API exposes 7 operations across 4 paths, and defines 59 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.

7 operations 4 paths 59 schemas 1 DELETE3 GET2 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 Applications 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 7

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

Zone-Level Access Applications 7
GET
/zones/{zone_id}/access/apps
APIs.io Engineering Platform List Access Applications
zone-level-access-applications-list-access-applications 1 param → 4XX200
POST
/zones/{zone_id}/access/apps
APIs.io Engineering Platform Add an Access application
zone-level-access-applications-add-a-bookmark-application 1 param body → 4XX201
DELETE
/zones/{zone_id}/access/apps/{app_id}
APIs.io Engineering Platform Delete an Access application
zone-level-access-applications-delete-an-access-application 2 params → 4XX202
GET
/zones/{zone_id}/access/apps/{app_id}
APIs.io Engineering Platform Get an Access application
zone-level-access-applications-get-an-access-application 2 params → 4XX200
PUT
/zones/{zone_id}/access/apps/{app_id}
APIs.io Engineering Platform Update an Access application
zone-level-access-applications-update-a-bookmark-application 2 params body → 4XX200
POST
/zones/{zone_id}/access/apps/{app_id}/revoke_tokens
APIs.io Engineering Platform Revoke application tokens
zone-level-access-applications-revoke-service-tokens 2 params → 4XX202
GET
/zones/{zone_id}/access/apps/{app_id}/user_policy_checks
APIs.io Engineering Platform Test Access policies
zone-level-access-applications-test-access-policies 2 params → 4XX200

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are access_schemas-self_hosted_props (17 properties), access_schemas-oidc_saas_app (16 properties), access_schemas-saml_saas_app (11 properties), access_schemas-cors_headers (8 properties). Each schema is shown below with its type and property counts.

access_allowed_idps
array
The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.
access_api-response-common-failure
object
4 properties 4 required
access_schemas-cors_headers
object
8 properties
access_api-response-collection
object
access_result_info
object
4 properties
access_allow_all_headers
boolean
Allows all HTTP request headers.
access_logo_url
string
The image URL for the logo shown in the App Launcher dashboard.
access_schemas-bookmark_props
object
5 properties 2 required
access_schemas-vnc_props
access_api-response-single
object
access_uuid
string
UUID
access_schemas-custom_deny_url
string
The custom URL a user is redirected to when they are denied access to the application.
access_schemas-biso_props
access_schemas-policy_check_response
access_custom_deny_message
string
The custom error message shown to a user when they are denied access to the application.
access_schemas-scim_config
object
Configuration for provisioning to this application via SCIM. This is currently in closed beta.
6 properties 2 required
access_app_id
access_timestamp
string
access_schemas-allowed_headers
array
Allowed HTTP request headers.
access_allow_all_methods
boolean
Allows all HTTP request methods.
access_scim_config_authentication_oauth2
object
Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.
6 properties 5 required
access_schemas-feature_app_props
object
6 properties 1 required
access_schemas-saas_props
object
7 properties
access_allowed_methods
array
Allowed HTTP request methods.
access_scim_config_mapping
object
Transformations and filters applied to resources before they are provisioned in the remote SCIM service.
5 properties 1 required
access_options_preflight_bypass
boolean
Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if corsheaders is set.
access_schemas-self_hosted_props
object
17 properties 2 required
access_schemas-warp_props
access_schemas-session_duration
string
The amount of time that tokens issued for this application will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m,…
access_schemas-app_launcher_props
access_apps_components-schemas-name
string
The name of the application.
access_allow_all_origins
boolean
Allows all origins.
access_service_auth_401_redirect
boolean
Returns a 401 status code when the request is blocked by a Service Auth policy.
access_apps
object
access_type
string
The application type.
access_skip_interstitial
boolean
Enables automatic authentication through cloudflared.
access_identifier
string
Identifier
access_schemas-ssh_props
access_scim_config_authentication_oauth_bearer_token
object
Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.
2 properties 2 required
access_schemas-allowed_origins
array
Allowed origins.
access_app_launcher_visible
boolean
Displays the application in the App Launcher.
access_enable_binding_cookie
boolean
Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
access_http_only_cookie_attribute
boolean
Enables the HttpOnly cookie attribute, which increases security against XSS attacks.
access_components-schemas-domain
string
The domain and path that Access will secure.
access_schemas-auto_redirect_to_identity
boolean
When set to true, users skip the identity provider selection step during login. You must specify only one identity provider in allowedidps.
access_allow_credentials
boolean
When set to true, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
access_apps_components-schemas-single_response-2
access_api-response-common
object
3 properties 3 required
access_same_site_cookie_attribute
string
Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
access_schemas-aud
string
Audience tag.
access_messages
array
access_scim_config_authentication_http_basic
object
Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application.
3 properties 3 required
access_max_age
number
The maximum number of seconds the results of a preflight request can be cached.
access_schemas-saml_saas_app
object
11 properties
access_schemas-basic_app_response_props
object
5 properties
access_schemas-empty_response
access_apps_components-schemas-response_collection-2
access_schemas-oidc_saas_app
object
16 properties
access_id_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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