Search + K

Command Palette

Search for a command to run...

Sign In

Retrieve discovered operations on a zone rendered as OpenAPI schemas

GET /zones/{zone_id}/api_gateway/discovery
Copy endpoint
https://api.cloudflare.com/client/v4

Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas

Parameters

path Path Parameters

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

Responses

200 application/json

Retrieve discovered operations on a zone, rendered as OpenAPI schemas response

type ApiShieldSchemaResponseDiscovery = 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: { schemas: ApiShieldOpenapi

A OpenAPI 3.0.0 compliant schema.

interface ApiShieldOpenapi {}
[]
;timestamp: ApiShieldSchemasTimestamp
type ApiShieldSchemasTimestamp = ApiShieldTimestamp & string
; }
; }

Client Errors

4XX application/json

Retrieve discovered operations on a zone, rendered as OpenAPI schemas response failure

type ApiShieldSchemaResponseDiscovery = 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: { schemas: ApiShieldOpenapi

A OpenAPI 3.0.0 compliant schema.

interface ApiShieldOpenapi {}
[]
;timestamp: ApiShieldSchemasTimestamp
type ApiShieldSchemasTimestamp = ApiShieldTimestamp & string
; }
; }
& 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;
}