Discovery

Export discovered API operations as OpenAPI schemas

GET/zones/{zone_id}/api_gateway/discovery

ModelsExpand Collapse

DiscoveryOperation object { id, endpoint, host, 5 more }

id: string

UUID.

maxLength36

minLength36

endpoint: string

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

formaturi-template

maxLength4096

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" or "POST" or "HEAD" or 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

origin: array of "ML" or "SessionIdentifier" or "LabelDiscovery"

API discovery engine(s) that discovered this operation

One of the following:

"ML"

"SessionIdentifier"

"LabelDiscovery"

state: "review" or "saved" or "ignored"

State of operation in API Discovery

review - Operation is not saved into API Shield Endpoint Management
saved - Operation is saved into API Shield Endpoint Management
ignored - Operation is marked as ignored

One of the following:

"review"

"saved"

"ignored"

features: optional object { traffic_stats }

traffic_stats: optional object { last_updated, period_seconds, requests }

last_updated: string

formatdate-time

period_seconds: number

The period in seconds these statistics were computed over

requests: number

The average number of requests seen during this period

formatfloat

DiscoveryGetResponse object { schemas, timestamp }

schemas: array of unknown

timestamp: string

formatdate-time

DiscoveryOperations

List discovered web and API operations

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

Edit discovered web and API operations

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

ModelsExpand Collapse

OperationBulkEditResponse = map[object { state } ]

state: optional "review" or "ignored"

Mark state of operation in API Discovery

review - Mark operation as for review
ignored - Mark operation as ignored

One of the following:

"review"

"ignored"