--- title: Upload a legacy schema --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [API Gateway](https://developers.cloudflare.com/api/go/resources/api_gateway) [User Schemas](https://developers.cloudflare.com/api/go/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. client.APIGateway.UserSchemas.New(ctx, params) (\*[UserSchemaNewResponse](), error) 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` ##### ParametersExpand Collapse
params UserSchemaNewParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property File param.Field\[Reader] Body param: Schema file bytes Link to this property
Kind param.Field\[UserSchemaNewParamsKind] Body param: Kind of schema const UserSchemaNewParamsKindOpenAPIV3 UserSchemaNewParamsKind = "openapi\_v3" Link to this property
Link to this property Name param.Field\[string]Optional Body param: Name of the schema Link to this property
ValidationEnabled param.Field\[UserSchemaNewParamsValidationEnabled]Optional Body param: Flag whether schema is enabled for validation. const UserSchemaNewParamsValidationEnabledTrue UserSchemaNewParamsValidationEnabled = "true" Link to this property const UserSchemaNewParamsValidationEnabledFalse UserSchemaNewParamsValidationEnabled = "false" 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(params)%20default>) ##### ReturnsExpand Collapse
type UserSchemaNewResponse struct{…}
Schema OldPublicSchema CreatedAt Time formatdate-time Link to this property Kind OldPublicSchemaKind Kind of schema Link to this property Name string Name of the schema Link to this property SchemaID string UUID. maxLength36 minLength36 Link to this property Source stringOptional Source of the schema Link to this property ValidationEnabled boolOptional Flag whether schema is enabled for validation. Link to this property
Link to this property
UploadDetails UserSchemaNewResponseUploadDetailsOptional
Warnings \[]UserSchemaNewResponseUploadDetailsWarningOptional Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema. Code int64 Code that identifies the event that occurred. Link to this property Locations \[]stringOptional 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 stringOptional 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(model)%20UserSchemaNewResponse%20%3E%20(schema)>) ### Upload a legacy schema Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "bytes" "context" "fmt" "io" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/api_gateway" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) userSchema, err := client.APIGateway.UserSchemas.New(context.TODO(), api_gateway.UserSchemaNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), File: cloudflare.F(io.Reader(bytes.NewBuffer([]byte("Example data")))), Kind: cloudflare.F(api_gateway.UserSchemaNewParamsKindOpenAPIV3), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", userSchema.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 } ```