---
title: Upload a legacy schema
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[API Gateway](https://developers.cloudflare.com/api/resources/api_gateway)
[User Schemas](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Upload a legacy schema
Deprecated: Use \[Schema Validation API](https://developers.cloudflare.com/api/resources/schema\_validation/) instead.
POST/zones/{zone\_id}/api\_gateway/user\_schemas
Uploads an OpenAPI schema that defines expected request formats for API endpoints. Deprecated; use `/zones/{zone_id}/schema_validation/schemas` instead.
##### 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``Domain API Gateway`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Body ParametersForm DataExpand Collapse
file: file
Schema file bytes
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20file%20%3E%20(schema)>)
kind: "openapi\_v3"
Kind of schema
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20kind%20%3E%20(schema)>)
name: optional string
Name of the schema
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20name%20%3E%20(schema)>)
validation\_enabled: optional "true"or "false"
Flag whether schema is enabled for validation.
One of the following:
"true"
Link to this property
"false"
Link to this property
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20validation_enabled%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.user_schemas%20%3E%20(method)%20create%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.user_schemas%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {schema, upload\_details }
schema: OldPublicSchema { created\_at, kind, name, 3 more }
created\_at: string
formatdate-time
Link to this property
kind: "openapi\_v3"
Kind of schema
Link to this property
name: string
Name of the schema
Link to this property
schema\_id: string
UUID.
maxLength36
minLength36
Link to this property
source: optional string
Source of the schema
Link to this property
validation\_enabled: optional boolean
Flag whether schema is enabled for validation.
Link to this property
Link to this property
upload\_details: optional object {warnings }
warnings: optional array of object {code, locations, message }
Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.
code: number
Code that identifies the event that occurred.
Link to this property
locations: optional array of string
JSONPath location(s) in the schema where these events were encountered. See https://goessner.net/articles/JsonPath/ for JSONPath specification.
Link to this property
message: optional string
Diagnostic message that describes the event.
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(method)%20create%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.user_schemas%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Upload a legacy schema
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/user_schemas \
-H 'Content-Type: multipart/form-data' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-F 'file=@/path/to/file' \
-F kind=openapi_v3 \
-F name='petstore schema'
```
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": {
"schema": {
"created_at": "2014-01-01T05:20:00.12345Z",
"kind": "openapi_v3",
"name": "petstore schema",
"schema_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"source": "",
"validation_enabled": true
},
"upload_details": {
"warnings": [
{
"code": 28,
"locations": [
".paths[\"/user/{username}\"].put"
],
"message": "unsupported media type: application/octet-stream"
}
]
}
},
"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": {
"schema": {
"created_at": "2014-01-01T05:20:00.12345Z",
"kind": "openapi_v3",
"name": "petstore schema",
"schema_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"source": "",
"validation_enabled": true
},
"upload_details": {
"warnings": [
{
"code": 28,
"locations": [
".paths[\"/user/{username}\"].put"
],
"message": "unsupported media type: application/octet-stream"
}
]
}
},
"success": true
}
```