Upload a schema to a zone

Deprecated

POST /zones/{zone_id}/api_gateway/user_schemas

Copy endpoint

https://api.cloudflare.com/client/v4

Parameters

Name	Type
`zone_id` required	type ApiShieldSchemasIdentifier = type ApiShieldIdentifier = string & string

multipart/form-data required

{
file: string;
kind:

ApiShieldKind

Kind of schema

type ApiShieldKind = "openapi_v3"

;
name?: string;
validation_enabled?: "true" | "false";
}

200 application/json

Upload a schema response

interface ApiShieldApiResponseCommon {
errors:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & { result:

ApiShieldSchemaUploadResponse

interface ApiShieldSchemaUploadResponse {
schema: ApiShieldPublicSchema;
upload_details?: ApiShieldSchemaUploadDetailsWarningsOnly;
}

; }

4XX application/json

Upload a schema response failure

type ApiShieldSchemaUploadFailure = interface ApiShieldApiResponseCommonFailure {
errors:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
} & { upload_details?:

ApiShieldSchemaUploadDetailsErrorsCritical

interface ApiShieldSchemaUploadDetailsErrorsCritical {
critical?: ApiShieldSchemaUploadLogEvent[];
errors?: ApiShieldSchemaUploadLogEvent[];
}

; }