---
title: Export web and API operations as OpenAPI schemas
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[API Gateway](https://developers.cloudflare.com/api/resources/api_gateway)
[Schemas](https://developers.cloudflare.com/api/resources/api_gateway/subresources/schemas)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Export web and API operations as OpenAPI schemas
GET/zones/{zone\_id}/api\_gateway/schemas
Returns tracked web and API operations and their feature configuration rendered as OpenAPI schemas.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Account API Gateway``Account API Gateway Read``Domain API Gateway``Domain API Gateway Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
feature: optional array of "thresholds"or "parameter\_schemas"or "schema\_info"or "confidence\_intervals"
Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
One of the following:
"thresholds"
Link to this property
"parameter\_schemas"
Link to this property
"schema\_info"
Link to this property
"confidence\_intervals"
Link to this property
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20feature%20%3E%20(schema)>)
host: optional array of string
Receive schema only for the given host(s).
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20host%20%3E%20(schema)>)
include\_schema\_kind: optional array of "learned"
Schema kinds to include in exported OpenAPI schemas.
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20include_schema_kind%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {schemas, timestamp }
schemas: optional array of unknown
Link to this property
timestamp: optional string
Link to this property
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Export web and API operations as OpenAPI schemas
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/schemas \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"schemas": [
{
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"openapi": "3.0.0",
"paths": {
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"name": "var1",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "www.example.com"
}
]
}
],
"timestamp": "timestamp"
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"schemas": [
{
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"openapi": "3.0.0",
"paths": {
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"name": "var1",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "www.example.com"
}
]
}
],
"timestamp": "timestamp"
},
"success": true
}
```