Retrieve information about a specific schema on a zone

Deprecated

GET /zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Copy endpoint

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

Parameters

path Path Parameters

Name	Type
`zone_id` required	type ApiShieldSchemasIdentifier = type ApiShieldIdentifier = string & string
`schema_id` required Identifier for the schema-ID	string

query Query Parameters

Name	Type
`omit_source` Omit the source-files of schemas and only retrieve their meta-data.	boolean

Responses

200 application/json

Retrieve information about a specific schema on a zone 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:

ApiShieldPublicSchema

interface ApiShieldPublicSchema {
created_at: ApiShieldSchemasTimestamp;
kind: ApiShieldKind;
name: string;
schema_id: ApiShieldSchemasUuid;
source?: string;
validation_enabled?: ApiShieldValidationEnabled;
}

; }

Client Errors

4XX application/json

Retrieve information about a specific schema zone response failure

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;
}