Search + K

Command Palette

Search for a command to run...

Sign In

Patch discovered operation

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

Update the state on a discovered operation

Parameters

path Path Parameters

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

Identifier for the discovered operation

type ApiShieldSchemasUuid = string & type ApiShieldUuid = string

Request Body

application/json required
{ state?: ApiShieldApiDiscoveryStatePatch

Mark state of operation in API Discovery

  • review - Mark operation as for review
  • ignored - Mark operation as ignored
type ApiShieldApiDiscoveryStatePatch = "review" | "ignored"
; }

Responses

200 application/json

Patch discovered operation response

type ApiShieldPatchDiscoveryResponse = 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: { state?: ApiShieldApiDiscoveryState

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
type ApiShieldApiDiscoveryState = "review" | "saved" | "ignored"
; }
; }

Client Errors

4XX application/json

Patch discovered operation 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;
}