Retrieve discovered operations on a zone

GET /zones/{zone_id}/api_gateway/discovery/operations

Copy endpoint

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

Retrieve the most up to date view of discovered operations

Parameters

path Path Parameters

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

query Query Parameters

Name	Type
`page` Page number of paginated results.	number
`per_page` Maximum number of results per page.	number
`host`	string[]
`method`	string[]
`endpoint`	string
`direction`	"asc" \| "desc"
`order`	"host" \| "method" \| "endpoint" \| "traffic_stats.requests" \| "traffic_stats.last_updated"
`diff`	boolean
`origin` Filter results to only include discovery results sourced from a particular discovery engine `ML` - Discovered operations that were sourced using ML API Discovery `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery	type ApiShieldApiDiscoveryOrigin = "ML" \| "SessionIdentifier" \| "LabelDiscovery"
`state` Filter results to only include discovery results in a particular state. States are as follows `review` - Discovered operations that are not saved into API Shield Endpoint Management `saved` - Discovered operations that are already saved into API Shield Endpoint Management `ignored` - Discovered operations that have been marked as ignored	type ApiShieldApiDiscoveryState = "review" \| "saved" \| "ignored"

Responses

200 application/json

Retrieve discovered operations on a zone response

type ApiShieldApiResponseCollection = never & { result:

ApiShieldDiscoveryOperation

type ApiShieldDiscoveryOperation = {
features?: ApiShieldTrafficStats;
id: ApiShieldSchemasUuid;
last_updated: ApiShieldSchemasTimestamp;
origin: ApiShieldApiDiscoveryOrigin[];
state: ApiShieldApiDiscoveryState;
} & ApiShieldBasicOperation

[]; }

Client Errors

4XX application/json

Retrieve discovered operations on a 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;
}