--- title: Upload a schema --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Schema Validation](https://developers.cloudflare.com/api/go/resources/schema_validation) [Schemas](https://developers.cloudflare.com/api/go/resources/schema_validation/subresources/schemas) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Upload a schema client.SchemaValidation.Schemas.New(ctx, params) (\*[PublicSchema](), error) POST/zones/{zone\_id}/schema\_validation/schemas Uploads an OpenAPI schema that defines expected request formats for API operations. ##### 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 SchemaNewParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property
Kind param.Field\[SchemaNewParamsKind] Body param: The kind of the schema const SchemaNewParamsKindOpenAPIV3 SchemaNewParamsKind = "openapi\_v3" Link to this property
Link to this property Name param.Field\[string] Body param: A human-readable name for the schema Link to this property Source param.Field\[string] Body param: The raw schema, e.g., the OpenAPI schema, either as JSON or YAML Link to this property ValidationEnabled param.Field\[bool] Body param: An indicator if this schema is enabled Link to this property
[Link to this property](<#(resource)%20schema_validation.schemas%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type PublicSchema struct{…} A schema used in schema validation CreatedAt Time formatdate-time Link to this property Kind PublicSchemaKind The kind of the schema Link to this property Name string A human-readable name for the schema Link to this property SchemaID string A unique identifier of this schema maxLength36 minLength36 formatuuid Link to this property Source string The raw schema, e.g., the OpenAPI schema, either as JSON or YAML Link to this property ValidationEnabled boolOptional An indicator if this schema is enabled Link to this property
[Link to this property](<#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) ### Upload a schema Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/schema_validation" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) publicSchema, err := client.SchemaValidation.Schemas.New(context.TODO(), schema_validation.SchemaNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Kind: cloudflare.F(schema_validation.SchemaNewParamsKindOpenAPIV3), Name: cloudflare.F("petstore schema"), Source: cloudflare.F(""), ValidationEnabled: cloudflare.F(true), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", publicSchema.SchemaID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "locations": [ ".paths[\"/user/{username}\"].put" ], "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "locations": [ ".paths[\"/user/{username}\"].put" ], "pointer": "pointer" } } ], "result": { "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 }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "locations": [ ".paths[\"/user/{username}\"].put" ], "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "locations": [ ".paths[\"/user/{username}\"].put" ], "pointer": "pointer" } } ], "result": { "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 }, "success": true } ```